A base class representing entities More...

Inheritance diagram for pluginbase.Objects.Syncable.Entity.EntityBase:

Public Member Functions
void	Destroy ()
	Marks the entity for destruction More...

override string	ToString ()
	Gets a human-readable string representing an entity 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...

Protected Member Functions
void	SetTransient (bool isTransient=true)
	Sets whether or not the entity will be persisted Transient entities will not be persisted More...

virtual bool	ShouldSyncWith (IPositionableEntity user)
	Gets whether or not the entity shuold sync with another entity More...

virtual void	OnServerSpawn ()
	Raises the server spawn event. Will only be called once, even across reloads More...

virtual void	OnServerDestroy ()
	Raises the server destroy event. More...

void	InvokeRemotely (string methodName, RpcTarget target, params object[] args)
	Invoke a remote method on a target More...

void	InvokeRemotely< T > (string methodName, RpcTarget target, Action< RpcNetworkContext, T > returnCallback, params object[] args)
	Invoke a remote method on a target More...

void	InvokeRemotely< T > (string methodName, RpcTarget target, Action< T > returnCallback, params object[] args)
	Invoke a remote method on a target More...

void	InvokeRemotely (RpcTarget target, Expression< Action > thisExpression)
	Invokes a remote target with an expression More...

void	InvokeDirect (string methodName, params object[] args)
	Invoke a remote method on the opposite-owner eg. if this is the server, than on the client owner, otherwise on the server More...

void	InvokeDirect< T > (string methodName, Action< RpcNetworkContext, T > returnCallback, params object[] args)
	Invoke a remote method on the opposite-owner eg. if this is the server, than on the client owner, otherwise on the server More...

void	InvokeDirect< T > (string methodName, Action< T > returnCallback, params object[] args)
	Invoke a remote method on the opposite-owner eg. if this is the server, than on the client owner, otherwise on the server More...

void	InvokeDirect (Expression< Action > thisExpression)
	Invokes a method on the opposite-owner. Action must act upon `this` More...

void	InvokeDirect< TRet > (Expression< Func< TRet >> thisExpression, Action< TRet > returnCallback)
	Invokes a method on the opposite-owner. Action must act upon `this` More...

Protected Member Functions inherited from pluginbase.Objects.Syncable.SyncableObject
	SyncableObject ()
	Initializes a new instance of the pluginbase.Objects.Syncable.SyncableObject class. More...

sealed override void	ResetWatch ()
	Reset variables watched status More...

sealed override void	TouchRecurse ()
	Touch self, including all children of this syncable object More...

sealed override void	EncodeTo (BinaryWriter writer, EncodeContext context)
	Encode changes to binary data More...

sealed override void	DecodeFrom (BinaryReader reader, DecodeContext context)
	Decode changes from binary data More...

sealed override void	Persist (IPersistObject obj)
	Build up a persistant object for this syncable, including all sync children and persist objects More...

sealed override void	Load (IReadPersistObject obj)
	Load a given persistent object back into this instance More...

Protected Member Functions inherited from pluginbase.Objects.Syncable.SyncableBase< SyncableObject >
void	Touch ()
	Touch the instance, notifying something has changed More...

virtual void	OnChanged ()
	Raises the changed event. More...

abstract void	Persist (IPersistObject obj)
	Persist the instance to a persist object More...

abstract void	Load (IReadPersistObject obj)
	Load the instance from a persist object More...

Properties
bool	Spawned `[get]`
	Gets a value indicating whether this entity has been spawned More...

uint	ObjectId `[get]`
	Gets or sets the object identifier. (aka entity id) More...

ushort	OwnerId `[get]`
	The ident of the owner of the obejct More...

sealed override ushort	NetOwnerId `[get]`
	Who owns me?! (Net ID) This is how we pass information down to SyncableObject More...

bool	IsServer `[get]`
	Is the current object instantiated on the server More...

ushort	ObjectTypeId `[get]`
	The type ID of the object, as defined by the entity attribute More...

Properties inherited from pluginbase.Objects.Syncable.SyncableObject
virtual ushort	NetOwnerId `[get]`
	Gets the network owner of this object (user id) More...

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...

Additional Inherited Members
Events inherited from pluginbase.Objects.Syncable.SyncableBase< SyncableObject >
Action< T >	Changed
	Event triggered when any change occurs on this object, either locally or over the network More...

Action< T >	NetUpdate
	Event triggered when a change occurs resulting from a change over the network More...

Action< T >	Touched
	Event occurs only when an object is first touched. Usually the first instance of a local-change More...

Detailed Description

A base class representing entities

Member Function Documentation

◆ Destroy()

void pluginbase.Objects.Syncable.Entity.EntityBase.Destroy ( )

Marks the entity for destruction

         {
             if (!this.IsServer)
                 throw new Exception("Destroy only allowed by server");
             _destroyFlag = true;
         }

◆ InvokeDirect() [1/2]

void pluginbase.Objects.Syncable.Entity.EntityBase.InvokeDirect	(	string	methodName,
		params object []	args
	)

protected

Invoke a remote method on the opposite-owner eg. if this is the server, than on the client owner, otherwise on the server

Parameters

methodName	Method name.
args	Arguments.

         {
             this._rpc.Invoke(methodName, this.GetDirectTarget(), args);
         }

◆ InvokeDirect() [2/2]

void pluginbase.Objects.Syncable.Entity.EntityBase.InvokeDirect ( Expression< Action > thisExpression )

protected

Invokes a method on the opposite-owner. Action must act upon this

Parameters

thisExpression This expression.

         {
             var method = thisExpression.ReduceMethodCall();
             if (!method.TargetType.IsAssignableFrom(this.GetType()))
             {
                 throw new Exception("RPC Expression must act upon self");
             }
             InvokeDirect(method.Method.Name, method.ArgumentValues);
         }

◆ InvokeDirect< T >() [1/2]

void pluginbase.Objects.Syncable.Entity.EntityBase.InvokeDirect< T >	(	string	methodName,
		Action< RpcNetworkContext, T >	returnCallback,
		params object []	args
	)

protected

Invoke a remote method on the opposite-owner eg. if this is the server, than on the client owner, otherwise on the server

Parameters

methodName	Method name.
returnCallback	Return callback.
args	Arguments.

Template Parameters

T	The 1st type parameter.

         {
             this._rpc.Invoke(methodName, this.GetDirectTarget(), returnCallback, args);
         }

◆ InvokeDirect< T >() [2/2]

void pluginbase.Objects.Syncable.Entity.EntityBase.InvokeDirect< T >	(	string	methodName,
		Action< T >	returnCallback,
		params object []	args
	)

protected

Invoke a remote method on the opposite-owner eg. if this is the server, than on the client owner, otherwise on the server

Parameters

methodName	Method name.
returnCallback	Return callback.
args	Arguments.

Template Parameters

T	The 1st type parameter.

         {
             this._rpc.Invoke(methodName, this.GetDirectTarget(), returnCallback, args);
         }

◆ InvokeDirect< TRet >()

void pluginbase.Objects.Syncable.Entity.EntityBase.InvokeDirect< TRet >	(	Expression< Func< TRet >>	thisExpression,
		Action< TRet >	returnCallback
	)

protected

Invokes a method on the opposite-owner. Action must act upon this

Parameters

thisExpression	This expression.
returnCallback	Return callback.

Template Parameters

TRet	The 1st type parameter.

         {
             var method = thisExpression.ReduceMethodCall();
             if (!method.TargetType.IsAssignableFrom(this.GetType()))
             {
                 throw new Exception("RPC Expression must act upon self");
             }
             InvokeDirect(method.Method.Name, returnCallback, method.ArgumentValues);
         }

◆ InvokeRemotely() [1/2]

void pluginbase.Objects.Syncable.Entity.EntityBase.InvokeRemotely	(	string	methodName,
		RpcTarget	target,
		params object []	args
	)

protected

Invoke a remote method on a target

Parameters

methodName	Method name.
target	Target.
args	Arguments.

         {
             this._rpc.Invoke(methodName, target, args);
         }

◆ InvokeRemotely() [2/2]

void pluginbase.Objects.Syncable.Entity.EntityBase.InvokeRemotely	(	RpcTarget	target,
		Expression< Action >	thisExpression
	)

protected

Invokes a remote target with an expression

Parameters

target	Target.
thisExpression	This expression.

         {
             var method = thisExpression.ReduceMethodCall();
             if (!method.TargetType.IsAssignableFrom(this.GetType()))
             {
                 throw new Exception("RPC Expression must act upon self");
             }
             this.InvokeRemotely(method.Method.Name, target, method.ArgumentValues);
         }

◆ InvokeRemotely< T >() [1/2]

void pluginbase.Objects.Syncable.Entity.EntityBase.InvokeRemotely< T >	(	string	methodName,
		RpcTarget	target,
		Action< RpcNetworkContext, T >	returnCallback,
		params object []	args
	)

protected

Invoke a remote method on a target

Parameters

methodName	Method name.
target	Target.
returnCallback	Return callback.
args	Arguments.

Template Parameters

T	The 1st type parameter.

         {
             this._rpc.Invoke(methodName, target, returnCallback, args);
         }

◆ InvokeRemotely< T >() [2/2]

void pluginbase.Objects.Syncable.Entity.EntityBase.InvokeRemotely< T >	(	string	methodName,
		RpcTarget	target,
		Action< T >	returnCallback,
		params object []	args
	)

protected

Invoke a remote method on a target

Parameters

methodName	Method name.
target	Target.
returnCallback	Return callback.
args	Arguments.

Template Parameters

T	The 1st type parameter.

         {
             this._rpc.Invoke(methodName, target, returnCallback, args);
         }

◆ OnServerDestroy()

virtual void pluginbase.Objects.Syncable.Entity.EntityBase.OnServerDestroy ( )

protectedvirtual

Raises the server destroy event.

Implements pluginbase.Objects.Syncable.Entity.IMutableEntity.

Reimplemented in essentials.BlockEntities.BlockEntityBase< TBlock >, and essentials.Systems.Structures.Structure.

221 {}

◆ OnServerSpawn()

virtual void pluginbase.Objects.Syncable.Entity.EntityBase.OnServerSpawn ( )

protectedvirtual

Raises the server spawn event. Will only be called once, even across reloads

Implements pluginbase.Objects.Syncable.Entity.IMutableEntity.

Reimplemented in essentials.BlockEntities.BlockEntityBase< TBlock >.

216 {}

◆ SetTransient()

void pluginbase.Objects.Syncable.Entity.EntityBase.SetTransient ( bool isTransient = true )

protected

Sets whether or not the entity will be persisted Transient entities will not be persisted

Parameters

isTransient If set to true is transient.

         {
             if (!this.IsServer)
                 throw new Exception("Only server may set transient");
             _transient = isTransient;
         }

◆ ShouldSyncWith()

virtual bool pluginbase.Objects.Syncable.Entity.EntityBase.ShouldSyncWith ( IPositionableEntity user )

protectedvirtual

Gets whether or not the entity shuold sync with another entity

Returns: true, if sync with was shoulded, false otherwise.

Parameters

user User.

Implements pluginbase.Objects.Syncable.Entity.IMutableEntity.

Reimplemented in essentials.action.ItemFramework.World.ItemDropEntity, essentials.action.Entities.Actor.ActorBase, essentials.BlockEntities.BlockEntityBase< TBlock >, and essentials.Systems.Structures.Structure.

         {
             //We don't have any concept of a position, so of course, let's send
             return true;
         }

◆ ToString()

override string pluginbase.Objects.Syncable.Entity.EntityBase.ToString ( )

Gets a human-readable string representing an entity

Returns: A System.String that represents the current pluginbase.Objects.Syncable.Entity.EntityBase.

         {
             _typeName = _typeName ?? this.GetType().Name;
             return string.Format("[Entity: OID={0}, Owner={1}, TypeId={2}({3})]", ObjectId, OwnerId, ObjectTypeId, _typeName);
         }

Property Documentation

◆ IsServer

bool pluginbase.Objects.Syncable.Entity.EntityBase.IsServer

getprotected

Is the current object instantiated on the server

true if this instance is server; otherwise, false.

◆ NetOwnerId

sealed override ushort pluginbase.Objects.Syncable.Entity.EntityBase.NetOwnerId

getprotected

Who owns me?! (Net ID) This is how we pass information down to SyncableObject

The owner identifier.

◆ ObjectId

uint pluginbase.Objects.Syncable.Entity.EntityBase.ObjectId

get

Gets or sets the object identifier. (aka entity id)

The object identifier.

◆ ObjectTypeId

ushort pluginbase.Objects.Syncable.Entity.EntityBase.ObjectTypeId

get

The type ID of the object, as defined by the entity attribute

The object type identifier.

◆ OwnerId

ushort pluginbase.Objects.Syncable.Entity.EntityBase.OwnerId

get

The ident of the owner of the obejct

The owner identifier.

◆ Spawned

bool pluginbase.Objects.Syncable.Entity.EntityBase.Spawned

get

Gets a value indicating whether this entity has been spawned

true

false

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

pluginbase/Objects/Syncable/Entity/EntityBase.cs

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Destroy()

◆ InvokeDirect() [1/2]

◆ InvokeDirect() [2/2]

◆ InvokeDirect< T >() [1/2]

◆ InvokeDirect< T >() [2/2]

◆ InvokeDirect< TRet >()

◆ InvokeRemotely() [1/2]

◆ InvokeRemotely() [2/2]

◆ InvokeRemotely< T >() [1/2]

◆ InvokeRemotely< T >() [2/2]

◆ OnServerDestroy()

◆ OnServerSpawn()

◆ SetTransient()

◆ ShouldSyncWith()

◆ ToString()

Property Documentation

◆ IsServer

◆ NetOwnerId

◆ ObjectId

◆ ObjectTypeId

◆ OwnerId

◆ Spawned