Empeld
Empeld plugin documentation.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events
pluginbase.Objects.Syncable.Entity.IMutableEntity Interface Reference

A mutable entity is an entity that can be initialized and encoded to/from Primarily used as an extra interface for being controlled, but keeping it separate from normal entity functions More...

Inheritance diagram for pluginbase.Objects.Syncable.Entity.IMutableEntity:
pluginbase.Objects.Syncable.Entity.IEntity pluginbase.Objects.Syncable.INetSyncable pluginbase.Objects.Syncable.INetWatcher pluginbase.Objects.Syncable.Entity.EntityBase pluginbase.Objects.Syncable.Entity.IMutableActor essentials.action.Entities.Actor.ActorBase essentials.action.ItemFramework.World.ItemDropEntity essentials.BlockEntities.BlockEntityBase< TBlock > essentials.Systems.Structures.Structure pluginbase.Objects.Syncable.Entity.Static.StaticEntityBase essentials.action.Entities.Actor.ActorBase essentials.action.Entities.Actor.AttachableActorBase essentials.action.Entities.Actor.RailEntityBase essentials.Systems.Structures.Network.NetworkedStructure essentials.action.Entities.Actor.AttachableActorBase essentials.action.Entities.Actor.RailEntityBase essentials.action.Entities.Actor.NewtonianBase essentials.action.Entities.Basic.NpcEntity essentials.Systems.Structures.Network.Resources.ConstructedStructure essentials.action.Entities.Actor.NewtonianBase essentials.action.Entities.Basic.NpcEntity essentials.action.Entities.Actor.PathingEntityBase essentials.action.Entities.Actor.PlayableBase essentials.Systems.Structures.Network.Resources.PoweredStructure essentials.action.Entities.Actor.PathingEntityBase essentials.action.Entities.Actor.PlayableBase essentials.action.Entities.AI.AiEntityBase essentials.action.Entities.Basic.GuyEntity essentials.Systems.Structures.Network.Resources.ContainerStructure< T > essentials.action.Entities.AI.AiEntityBase essentials.action.Entities.Basic.GuyEntity

Public Member Functions

void Initialize (uint objectId, ushort ownerId, bool serverside)
 Initialize the specified objectId, ownerId and rpc. More...
 
void OnServerSpawn ()
 Event that is notified when an entity is spawned, but not during re-loading an already spawned entity More...
 
void OnServerDestroy ()
 Event that notifies when an entity is destroyed More...
 
bool ShouldSyncWith (IPositionableEntity user)
 Should this entity be sent to the entity specified? More...
 
- Public Member Functions inherited from pluginbase.Objects.Syncable.INetSyncable
void ResetWatch ()
 Resets the watch. Overridable to reset all sub-items More...
 
void EncodeTo (BinaryWriter writer, EncodeContext context)
 Encodes to. More...
 
void DecodeFrom (BinaryReader reader, DecodeContext context)
 Decodes from. More...
 
void Persist (IPersistObject obj)
 Persist the network object to a persist object More...
 
void Load (IReadPersistObject obj)
 Load the network object from a persist object More...
 
- Public Member Functions inherited from pluginbase.Objects.Syncable.INetWatcher
void Touch ()
 Touch the class, signalling that a change ocurred More...
 
void TouchRecurse ()
 Touches a class and any sub-classes it may have More...
 

Additional Inherited Members

- Properties inherited from pluginbase.Objects.Syncable.Entity.IEntity
uint ObjectId [get]
 Gets the object identifier. More...
 
ushort OwnerId [get]
 Gets the owner identifier. (Net Ident) More...
 
ushort ObjectTypeId [get]
 Gets the object type identifier, as defined by the attribute More...
 
bool DestroyFlag [get]
 Gets a value indicating whether this pluginbase.Objects.Syncable.Entity.IEntity is destroyable. More...
 
bool Spawned [get]
 Gets a value indicating whether this entity has been spawned More...
 
bool Transient [get]
 Gets a value indicating whether this entity is transient (Won't be saved) More...
 
- Properties inherited from pluginbase.Objects.Syncable.INetSyncable
INetWatcher Watcher [get, set]
 Who is watching (who to inform of a change) More...
 
bool Modified [get]
 Gets a value indicating whether this pluginbase.Objects.Syncable.INetSyncable is modified. More...
 

Detailed Description

A mutable entity is an entity that can be initialized and encoded to/from Primarily used as an extra interface for being controlled, but keeping it separate from normal entity functions

Member Function Documentation

void pluginbase.Objects.Syncable.Entity.IMutableEntity.Initialize ( uint  objectId,
ushort  ownerId,
bool  serverside 
)

Initialize the specified objectId, ownerId and rpc.

Parameters
objectIdObject identifier.
ownerIdOwner identifier.
serversideIs the entity server side
void pluginbase.Objects.Syncable.Entity.IMutableEntity.OnServerDestroy ( )
void pluginbase.Objects.Syncable.Entity.IMutableEntity.OnServerSpawn ( )

Event that is notified when an entity is spawned, but not during re-loading an already spawned entity

Implemented in pluginbase.Objects.Syncable.Entity.EntityBase, and essentials.BlockEntities.BlockEntityBase< TBlock >.

bool pluginbase.Objects.Syncable.Entity.IMutableEntity.ShouldSyncWith ( IPositionableEntity  user)

The documentation for this interface was generated from the following file: