Empeld
Empeld plugin documentation.
essentials.action.Entities.Basic.NpcEntity Class Reference
Inheritance diagram for essentials.action.Entities.Basic.NpcEntity:
essentials.action.Entities.Actor.RailEntityBase essentials.action.Entities.Actor.ActorBase pluginbase.Objects.Syncable.Entity.EntityBase pluginbase.Objects.Syncable.Entity.IMutableActor pluginbase.Objects.Syncable.Entity.Controllers.IComponentizedEntity pluginbase.Objects.Syncable.SyncableObject pluginbase.Objects.Syncable.Entity.IMutableEntity pluginbase.Objects.Syncable.Entity.Controllers.IRpcEntity pluginbase.Objects.Syncable.Entity.IActor pluginbase.Objects.Syncable.Entity.IMutableEntity pluginbase.Objects.Syncable.Entity.Controllers.ITaskedEntity pluginbase.Objects.Syncable.Entity.Controllers.IHookedEntity pluginbase.Objects.Syncable.Entity.Controllers.IEntityController pluginbase.Objects.Syncable.Entity.Controllers.IEntityController pluginbase.Objects.Syncable.INetSyncable pluginbase.Objects.Syncable.Entity.IEntity pluginbase.Objects.Syncable.Entity.Controllers.IModelEntity pluginbase.Objects.Syncable.Entity.Controllers.IEntityController pluginbase.Objects.Syncable.Entity.IEntity pluginbase.Objects.Syncable.INetSyncable pluginbase.Objects.Syncable.Entity.IEntity pluginbase.Objects.Syncable.SyncableBase< SyncableObject >

Public Member Functions

 NpcEntity ()
 
void Move (Vector3i pt)
 
- Public Member Functions inherited from essentials.action.Entities.Actor.RailEntityBase
 RailEntityBase ()
 
- Public Member Functions inherited from essentials.action.Entities.Actor.ActorBase
virtual void SetPosition (double x, double y, double z)
 Sets the position. More...
 
virtual void SetName (string name)
 
- Public Member Functions inherited from pluginbase.Objects.Syncable.Entity.EntityBase
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

override IModelInstance CreateModel ()
 
- Protected Member Functions inherited from essentials.action.Entities.Actor.RailEntityBase
void MoveTo (Vector3i pos)
 
void AbortPath ()
 
virtual void OnPathNotFound ()
 Raises the path failed event. More...
 
virtual void OnPathStart ()
 Invoked when we start following the path More...
 
virtual void OnPathFailed ()
 Invoked if the rail fails to finish (i.e. can't move anymore) More...
 
virtual void OnPathFinished ()
 Invoked when a rail has completed More...
 
void SetAnimationOnClients (ModelAnimation animation)
 
- Protected Member Functions inherited from essentials.action.Entities.Actor.ActorBase
sealed override bool ShouldSyncWith (IPositionableEntity user)
 Gets whether or not the entity shuold sync with another entity More...
 
- Protected Member Functions inherited from pluginbase.Objects.Syncable.Entity.EntityBase
void SetTransient (bool isTransient=true)
 Sets whether or not the entity will be persisted Transient entities will not be persisted 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...
 

Additional Inherited Members

- Properties inherited from essentials.action.Entities.Actor.RailEntityBase
bool FollowingPath [get]
 
virtual double Speed [get]
 
- Properties inherited from essentials.action.Entities.Actor.ActorBase
virtual Vector3d Position [get, protected set]
 
bool PositionFinishedInterpolating [get]
 
virtual Rotation2d Rotation [get, protected set]
 
bool IsPlayer [get]
 
bool IsMe [get]
 
string Name [get, protected set]
 
virtual string NamePlate [get]
 
virtual double NamePlateViewDistance [get]
 
virtual Vector3d NamePlateOffset [get]
 
virtual double SyncDistance [get]
 
virtual Vector3d UpVector [get]
 
IModelInstance Model [get]
 
virtual bool Visible [get]
 
virtual bool CastShadow [get]
 
- Properties inherited from pluginbase.Objects.Syncable.Entity.EntityBase
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...
 
- Properties inherited from pluginbase.Objects.Syncable.Entity.IMutableActor
bool IsPlayer [set]
 
bool IsMe [set]
 
- Properties inherited from pluginbase.Objects.Syncable.Entity.IActor
string Name [get]
 
- Properties inherited from pluginbase.Objects.Syncable.Entity.Controllers.IModelEntity
IModelInstance Model [get]
 The instance of the model used for the entity More...
 
string NamePlate [get]
 The name plate displayed for the entity, if any More...
 
double NamePlateViewDistance [get]
 The distance the name plate can be viewed from More...
 
Vector3d NamePlateOffset [get]
 The offset of the nameplate from the position of the entity More...
 
bool Visible [get]
 Gets a value indicating whether the entity is visible More...
 
bool CastShadow [get]
 Gets a value indiciating whether the entity casts a shadow More...
 
- Properties inherited from pluginbase.Objects.Syncable.Entity.IPositionableEntity
Vector3d Position [get]
 Gets the position. More...
 
Vector3d UpVector [get]
 Gets up vector. More...
 
Rotation2d Rotation [get]
 Gets the rotation. More...
 
- 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

Attribute: Entity("BasicNpc")

Constructor & Destructor Documentation

◆ NpcEntity()

essentials.action.Entities.Basic.NpcEntity.NpcEntity ( )
20  {
21  this.InjectDependencies();
22  }

Member Function Documentation

◆ CreateModel()

override IModelInstance essentials.action.Entities.Basic.NpcEntity.CreateModel ( )
protectedvirtual

Implements essentials.action.Entities.Actor.ActorBase.

25  {
26  return this._modelFactory.CreateModelInstance( this._essentialsActionResourceResolver.Resolve("essentials", "models/peasant1.xml") );
27  }
IModelInstance CreateModelInstance(string resource)
Loads a model, and creates an unpositioned instance of that model
string Resolve(string resource)
Resolves the data.

◆ Move()

void essentials.action.Entities.Basic.NpcEntity.Move ( Vector3i  pt)
30  {
31  this.MoveTo(pt);
32  }
void MoveTo(Vector3i pos)
Definition: RailEntityBase.cs:29

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