Empeld
Empeld plugin documentation.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events
essentials.action.Entities.Actor.PathingEntityBase Class Reference
Inheritance diagram for essentials.action.Entities.Actor.PathingEntityBase:
essentials.action.Entities.Actor.NewtonianBase essentials.action.Entities.Actor.AttachableActorBase essentials.action.Entities.Actor.INewtonianEntity essentials.action.Entities.Actor.IRepulsiveEntity essentials.action.Entities.Actor.ActorBase essentials.action.Entities.Actor.IAttachableActor pluginbase.Objects.Syncable.Entity.IActor pluginbase.Objects.Syncable.Entity.IPositionableEntity pluginbase.Objects.Syncable.Entity.EntityBase pluginbase.Objects.Syncable.Entity.IMutableActor pluginbase.Objects.Syncable.Entity.Controllers.IComponentizedEntity pluginbase.Objects.Syncable.Entity.IActor pluginbase.Objects.Syncable.Entity.Controllers.IModelEntity pluginbase.Objects.Syncable.Entity.IEntity pluginbase.Objects.Syncable.Entity.Controllers.IEntityController pluginbase.Objects.Syncable.Entity.IPositionableEntity pluginbase.Objects.Syncable.Entity.Controllers.IModelEntity pluginbase.Objects.Syncable.Entity.Controllers.IHookedEntity pluginbase.Objects.Syncable.Entity.Controllers.ITaskedEntity pluginbase.Objects.Syncable.Entity.IMutableEntity pluginbase.Objects.Syncable.Entity.IActor pluginbase.Objects.Syncable.Entity.Controllers.IRpcEntity pluginbase.Objects.Syncable.Entity.IMutableEntity pluginbase.Objects.Syncable.SyncableObject essentials.action.Entities.AI.AiEntityBase

Public Member Functions

 PathingEntityBase ()
 
- Public Member Functions inherited from essentials.action.Entities.Actor.NewtonianBase
 NewtonianBase ()
 
- 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.SyncableObject
 SyncableObject ()
 Initializes a new instance of the pluginbase.Objects.Syncable.SyncableObject class. More...
 

Protected Member Functions

virtual void OnPathStart (Path path)
 
virtual void OnPathNotFound ()
 
virtual void OnPathFinished ()
 
virtual void OnPathFailed ()
 
void MoveTo (Vector3i pos)
 
void StopPath ()
 
- Protected Member Functions inherited from essentials.action.Entities.Actor.NewtonianBase
virtual void SimulateClientPhysics (IFrameTimeState frameTime)
 
virtual void SimulateAudio (IFrameTimeState frameTime)
 
virtual bool ShouldOverrideAnimation (ModelAnimation animation)
 
virtual ModelAnimation GetAnimation ()
 
void SetAnimation (ModelAnimation animation)
 
void SetAnimation (string slug)
 
bool DoesCollide (Vector3d pos, double heightOffset=0.5)
 Detects whether or not the entity will collide with a block at a given point More...
 
void AddPhysicalVelocity (Vector3d vel)
 
virtual void OnCollided (Vector3d velDiff)
 
virtual void SimulateServerPhysics (IFrameTimeState timeState)
 
- Protected Member Functions inherited from essentials.action.Entities.Actor.AttachableActorBase
 AttachableActorBase ()
 
IActor GetAttachedActor ()
 
void AttachTo (uint actorId)
 
void AttachTo (IActor actor)
 
void Detach ()
 
- 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...
 
abstract IModelInstance CreateModel ()
 
- 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 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
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< T >
void Touch ()
 Touch the instance, notifying something has changed More...
 
virtual void OnChanged ()
 Raises the changed event. More...
 

Properties

bool IsFollowingPath [get]
 
virtual double Speed [get]
 
- Properties inherited from essentials.action.Entities.Actor.NewtonianBase
IBlockAudioManager AudioBlocks [get]
 
IAudioManager AudioManager [get]
 
virtual SoundDescriptor FallingWindSound [get]
 
virtual double FallingWindVelocity [get]
 
virtual bool HasGravity [get]
 Gets a value indicating whether this instance has gravity. Defaults always true More...
 
IBlock HeadBlock [get]
 
IBlock OnBlock [get]
 
virtual bool OnGround [get]
 Gets a value indicating whether this user on ground. More...
 
virtual bool InLiquid [get]
 
virtual bool IsUnderwater [get]
 
virtual bool InClimbable [get]
 
virtual double EntityHeight [get]
 Gets the height of the entity. More...
 
virtual double EntityRepulsionStrength [get]
 Strength at which another entity is repulsed by this one More...
 
virtual double EntityRepulsiveModifier [get]
 The multiplicative modifier of which a repulsive entities' strength is multiplied More...
 
virtual double EntityRadius [get]
 Gets the entity radius. Used in collision More...
 
virtual double UserVelocityAcceleration [get]
 How fast can the user velocity change More...
 
virtual double UserVelocityMultiplier [get]
 How much does the user velocity affect the physical engine. Defaults to full on ground, none in air More...
 
virtual double UserAccelerationMultiplier [get]
 How much does the requested acceleration affect the game physics More...
 
virtual double ClientMovementUpdateTolerance [get]
 
Vector3d GravityVector [get]
 
virtual double Density [get]
 
Vector3d Velocity [get]
 Calculated velocity More...
 
- Properties inherited from essentials.action.Entities.Actor.AttachableActorBase
sealed override Vector3d Position [get, protected set]
 
Vector3d RelativePosition [get, protected set]
 
sealed override Rotation2d Rotation [get, protected set]
 
bool IsAttached [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. 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.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.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.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...
 
- Properties inherited from essentials.action.Entities.Actor.IAttachableActor
bool IsAttached [get]
 Is attached to another entity More...
 
- Properties inherited from essentials.action.Entities.Actor.INewtonianEntity
Vector3d Velocity [get]
 
Vector3d Acceleration [get]
 
double EntityHeight [get]
 
double EntityRadius [get]
 
- Properties inherited from essentials.action.Entities.Actor.IRepulsiveEntity
double EntityRepulsionStrength [get]
 Linear strength at which this entity is repulsed by another More...
 

Additional Inherited Members

- Protected Attributes inherited from essentials.action.Entities.Actor.NewtonianBase
readonly IWorld World
 
readonly IResourceResolver EssentialsActionResources
 
readonly IBlockLookup BlockLookup
 
readonly Sync< Vector3d > UserVelocity
 
readonly Sync< Vector3d > Acceleration
 
Vector3d RequestedVelocity
 The requested velocity to be traveling Will apply if physically makes sense More...
 
Vector3d RequestedAcceleration
 Requested acceleration More...
 
- Events inherited from pluginbase.Objects.Syncable.SyncableBase< T >
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...
 

Constructor & Destructor Documentation

essentials.action.Entities.Actor.PathingEntityBase.PathingEntityBase ( )
19  {
20 
21  }

Member Function Documentation

void essentials.action.Entities.Actor.PathingEntityBase.MoveTo ( Vector3i  pos)
protected
58  {
59  if (_pather == null)
60  {
61  throw new Exception("Move instruction must be created on the server");
62  }
63 
64  if (_job != null)
65  {
66  _job.Abort();
67  }
68 
69  _job = _pather.CreatePathingJob((Vector3i)this.Position, pos);
70  _job.OnComplete += HandleOnComplete;
71  }
Action< Path > OnComplete
Definition: PathingJob.cs:15
void Abort()
Definition: PathingJob.cs:26
PathingJob CreatePathingJob(Vector3i start, Vector3i end)
Definition: WorldPathing.cs:38
sealed override Vector3d Position
Definition: AttachableActorBase.cs:23
A class representing a 3D coordinate of integers
Definition: Vector3i.cs:13
virtual void essentials.action.Entities.Actor.PathingEntityBase.OnPathFailed ( )
protectedvirtual
41  {
42 
43  }
virtual void essentials.action.Entities.Actor.PathingEntityBase.OnPathFinished ( )
protectedvirtual
36  {
37 
38  }
virtual void essentials.action.Entities.Actor.PathingEntityBase.OnPathNotFound ( )
protectedvirtual
31  {
32 
33  }
virtual void essentials.action.Entities.Actor.PathingEntityBase.OnPathStart ( Path  path)
protectedvirtual
26  {
27 
28  }
void essentials.action.Entities.Actor.PathingEntityBase.StopPath ( )
protected
74  {
75  if (_job != null)
76  {
77  _job.Abort();
78  _job = null;
79  }
80  _rail = null;
81  }
void Abort()
Definition: PathingJob.cs:26

Property Documentation

bool essentials.action.Entities.Actor.PathingEntityBase.IsFollowingPath
getprotected
virtual double essentials.action.Entities.Actor.PathingEntityBase.Speed
getprotected

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