Empeld
Empeld plugin documentation.
|
Public Member Functions | |
NewtonianBase () | |
![]() | |
virtual void | SetPosition (double x, double y, double z) |
Sets the position. More... | |
virtual void | SetName (string name) |
![]() | |
void | Destroy () |
Marks the entity for destruction More... | |
override string | ToString () |
Gets a human-readable string representing an entity More... | |
![]() | |
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... | |
![]() | |
void | Touch () |
Touch the class, signalling that a change ocurred More... | |
void | TouchRecurse () |
Touches a class and any sub-classes it may have More... | |
Public Attributes | |
Vector3d | UserVelocity => this._userVelocity |
non-physical velocity (eg. not gravity/pushing/etc) More... | |
Vector3d | Acceleration => this._acceleration |
Real acceleration of the entity More... | |
Protected Member Functions | |
virtual void | SimulateClientPhysics (IFrameTimeState frameTime) |
virtual void | SimulateAudio (IFrameTimeState frameTime) |
virtual bool | ShouldOverrideAnimation (ModelAnimation animation) |
virtual ModelAnimation | GetAnimation () |
void | SetAnimation (ModelAnimation animation, ModelAnimationFlag flag=ModelAnimationFlag.InterruptRepeat) |
void | SetAnimation (string slug, ModelAnimationFlag flag=ModelAnimationFlag.Default) |
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) |
![]() | |
AttachableActorBase () | |
IActor | GetAttachedActor () |
void | AttachTo (uint actorId) |
void | AttachTo (IActor actor) |
void | Detach () |
![]() | |
sealed override bool | ShouldSyncWith (IPositionableEntity user) |
Gets whether or not the entity shuold sync with another entity More... | |
abstract IModelInstance | CreateModel () |
![]() | |
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... | |
![]() | |
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... | |
![]() | |
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... | |
Protected Attributes | |
readonly IWorld | World |
readonly IResourceResolver | EssentialsActionResources |
readonly IBlockLookup | BlockLookup |
virtual bool | TreatAllBlocksSloped => false |
If we treat all blocks as sloped, that will allow the driver to walk up even flat-faced blocks (eg structural) Primarily to allow AI path navigation without "jumping" More... | |
Vector3d | RequestedVelocity |
The requested velocity to be traveling Will apply if physically makes sense More... | |
Vector3d | RequestedAcceleration |
Requested acceleration More... | |
Properties | |
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 (not sync'd) More... | |
![]() | |
sealed override Vector3d | Position [get, protected set] |
Vector3d | RelativePosition [get, protected set] |
sealed override Rotation2d | Rotation [get, protected set] |
bool | IsAttached [get] |
![]() | |
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] |
![]() | |
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... | |
![]() | |
virtual ushort | NetOwnerId [get] |
Gets the network owner of this object (user id) More... | |
![]() | |
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... | |
![]() | |
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... | |
![]() | |
bool | IsPlayer [set] |
bool | IsMe [set] |
![]() | |
string | Name [get] |
![]() | |
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... | |
![]() | |
Vector3d | Position [get] |
Gets the position. More... | |
Vector3d | UpVector [get] |
Gets up vector. More... | |
Rotation2d | Rotation [get] |
Gets the rotation. More... | |
![]() | |
bool | IsAttached [get] |
Is attached to another entity More... | |
![]() | |
Vector3d | Velocity [get] |
Vector3d | Acceleration [get] |
double | EntityHeight [get] |
double | EntityRadius [get] |
![]() | |
double | EntityRepulsionStrength [get] |
Linear strength at which this entity is repulsed by another More... | |
Additional Inherited Members | |
![]() | |
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... | |
essentials.action.Entities.Actor.NewtonianBase.NewtonianBase | ( | ) |
|
protected |
|
protected |
Detects whether or not the entity will collide with a block at a given point
true
, if collide was doesed, false
otherwise.pos | Position. |
heightOffset | Offset of lower height |
Attribute: testPos
;
|
protectedvirtual |
|
protectedvirtual |
|
protected |
Attribute: Remote
|
protected |
Attribute: Remote("SetAnimationSlug")
|
protectedvirtual |
|
protectedvirtual |
Attribute: EntityHook(EntityHook.Simulate, EntityScope.Client)
Attribute: _onBlock
.Walk.Play(this.Position);
Attribute: _onBlock
.Fall.Play(this.Position);
|
protectedvirtual |
Attribute: EntityHook(EntityHook.Simulate, EntityScope.Client)
|
protectedvirtual |
Vector3d essentials.action.Entities.Actor.NewtonianBase.Acceleration => this._acceleration |
Real acceleration of the entity
The acceleration.
|
protected |
Attribute: Dependency
|
protected |
Attribute: Dependency(Optional = true)
|
protected |
Requested acceleration
|
protected |
The requested velocity to be traveling Will apply if physically makes sense
|
protected |
If we treat all blocks as sloped, that will allow the driver to walk up even flat-faced blocks (eg structural) Primarily to allow AI path navigation without "jumping"
true
if treat all blocks sloped; otherwise, false
.
Vector3d essentials.action.Entities.Actor.NewtonianBase.UserVelocity => this._userVelocity |
non-physical velocity (eg. not gravity/pushing/etc)
The user velocity.
|
protected |
Attribute: Dependency
|
getprotected |
Attribute: Dependency(Optional = true)
|
getprotected |
Attribute: Dependency(Optional = true)
|
getprotected |
|
get |
|
get |
Gets the height of the entity.
The height of the entity.
|
get |
Gets the entity radius. Used in collision
The entity radius.
|
get |
Strength at which another entity is repulsed by this one
The entity repulsion.
|
getprotected |
The multiplicative modifier of which a repulsive entities' strength is multiplied
The entity repulsive modifier.
|
getprotected |
|
getprotected |
|
get |
|
getprotected |
Gets a value indicating whether this instance has gravity. Defaults always true
true
if this instance has gravity; otherwise, false
.
|
getprotected |
|
getprotected |
|
getprotected |
|
getprotected |
|
getprotected |
|
getprotected |
Gets a value indicating whether this user on ground.
|
getprotected |
How much does the requested acceleration affect the game physics
The user acceleration multiplier.
|
getprotected |
How fast can the user velocity change
The user velocity acceleration.
|
getprotected |
How much does the user velocity affect the physical engine. Defaults to full on ground, none in air
The user velocity multiplier.
|
get |
Calculated velocity (not sync'd)
The velocity.