Class EntityPlayer
- Namespace
- Vintagestory.API.Common
- Assembly
- VintagestoryAPI.dll
public class EntityPlayer : EntityHumanoid, IPettable- Inheritance
-
EntityPlayer
- Implements
- Inherited Members
- Extension Methods
Constructors
EntityPlayer()
public EntityPlayer()Fields
BlockSelection
The block or blocks currently selected by the player
public BlockSelection BlockSelectionField Value
BodyYawLimits
public AngleConstraint BodyYawLimitsField Value
CameraPos
The camera position of the player's view. Set only by the game client.
public Vec3d CameraPosField Value
CameraPosOffset
An offset which can be applied to the camera position to achieve certain special effects or special features, for example Timeswitch feature. Set only by the game client.
public Vec3d CameraPosOffsetField Value
DeathReason
The reason the player died (if the player did die). Set only by the game server.
public DamageSource DeathReasonField Value
EntitySelection
The entity or entities selected by the player
public EntitySelection EntitySelectionField Value
HeadYawLimits
public AngleConstraint HeadYawLimitsField Value
OnCanSpawnNearby
Called whenever the game wants to spawn new creatures around the player. Called only by the game server.
public CanSpawnNearbyDelegate OnCanSpawnNearbyField Value
PrevFrameCanStandUp
public bool PrevFrameCanStandUpField Value
PreviousBlockSelection
The block position previously selected by the player
public BlockPos PreviousBlockSelectionField Value
WalkPitch
The pitch the player currently wants to move to. Only relevant while swimming. Value set by the PlayerPhysics system. Set by the game client and server.
public float WalkPitchField Value
WalkYaw
The yaw the player currently wants to walk towards to. Value set by the PlayerPhysics system. Set by the game client and server.
public float WalkYawField Value
entityListForPartitioning
Used to assist if this EntityPlayer needs to be repartitioned
public List<Entity> entityListForPartitioningField Value
selfClimateCond
public ClimateCondition selfClimateCondField Value
selfNowShadowPass
public bool selfNowShadowPassField Value
talkTypeByAnimation
protected static Dictionary<string, EnumTalkType> talkTypeByAnimationField Value
talkUtil
public EntityTalkUtil talkUtilField Value
walkSpeed
This is not walkspeed per se, it is the walkspeed modifier as a result of armor and other gear. It corresponds to Stats.GetBlended("walkspeed") and gets updated every tick
public float walkSpeedField Value
Properties
AlwaysActive
Whether this entity should always stay in Active model, regardless on how far away other player are
public override bool AlwaysActive { get; }Property Value
AnimManager
Server simulated animations. Only takes care of stopping animations once they're done Set and Called by the Entities ServerSystem
public override IAnimationManager AnimManager { get; set; }Property Value
BodyYaw
The yaw of the agents body
public override float BodyYaw { get; set; }Property Value
HeadBobbingAmplitude
public float HeadBobbingAmplitude { get; set; }Property Value
IsInteractable
Should return true when this entity should be interactable by a player or other entities
public override bool IsInteractable { get; }Property Value
LadderFixDelta
A small offset used to prevent players from clipping through the blocks above ladders: relevant if the entity's collision box is sometimes adjusted by the game code
public override double LadderFixDelta { get; }Property Value
LastReviveTotalHours
public double LastReviveTotalHours { get; set; }Property Value
LeftHandItemSlot
The playres left hand contents. Available on the client and the server.
public override ItemSlot LeftHandItemSlot { get; }Property Value
LightHsv
If set, the entity will emit dynamic light
public override byte[] LightHsv { get; }Property Value
- byte[]
OtherAnimManager
public IAnimationManager OtherAnimManager { get; }Property Value
Player
The base player attached to this EntityPlayer.
public IPlayer Player { get; }Property Value
PlayerUID
The player's internal Universal ID. Available on the client and the server.
public string PlayerUID { get; }Property Value
RightHandItemSlot
The players right hand contents. Available on the client and the server.
public override ItemSlot RightHandItemSlot { get; }Property Value
ShouldDespawn
Whether or not the entity should despawn.
public override bool ShouldDespawn { get; }Property Value
StoreWithChunk
Players and whatever the player rides on will be stored seperatly
public override bool StoreWithChunk { get; }Property Value
TpAnimManager
public IAnimationManager TpAnimManager { get; }Property Value
Methods
CanPet(Entity)
public bool CanPet(Entity byEntity)Parameters
byEntityEntity
Returns
CanSpawnNearby(EntityProperties, Vec3d, RuntimeSpawnConditions)
public virtual bool CanSpawnNearby(EntityProperties type, Vec3d spawnPosition, RuntimeSpawnConditions sc)Parameters
typeEntityPropertiesspawnPositionVec3dscRuntimeSpawnConditions
Returns
ChangeDimension(int)
public void ChangeDimension(int dim)Parameters
dimint
Die(EnumDespawnReason, DamageSource)
Makes the entity despawn. Entities only drop something on EnumDespawnReason.Death
public override void Die(EnumDespawnReason reason = EnumDespawnReason.Death, DamageSource damageSourceForDeath = null)Parameters
reasonEnumDespawnReasondamageSourceForDeathDamageSource
FromBytes(BinaryReader, bool)
Loads the entity from a stored byte array from the SaveGame
public override void FromBytes(BinaryReader reader, bool forClient)Parameters
readerBinaryReaderforClientbool
GetInfoText()
gets the info text for the entity.
public override string GetInfoText()Returns
GetInsideLegsBlockSoundSource(BlockPos)
public virtual Block GetInsideLegsBlockSoundSource(BlockPos tmpPos)Parameters
tmpPosBlockPos
Returns
GetInsideTorsoBlockSoundSource(BlockPos)
public virtual Block GetInsideTorsoBlockSoundSource(BlockPos tmpPos)Parameters
tmpPosBlockPos
Returns
GetName()
Gets the name for this entity
public override string GetName()Returns
GetNearestBlockSoundSource(BlockPos, double, int, bool)
Returns null if there is no nearby sound source
public Block GetNearestBlockSoundSource(BlockPos tmpPos, double yOffset, int blockLayer, bool usecollisionboxes)Parameters
tmpPosBlockPosMight get intentionally modified if the nearest sound source the player is intersecting with is in an adjacent block
yOffsetdoubleblockLayerintusecollisionboxesbool
Returns
GetWalkSpeedMultiplier(double)
Gets the walk speed multiplier.
public override double GetWalkSpeedMultiplier(double groundDragFactor = 0.3)Parameters
groundDragFactordoubleThe amount of drag provided by the current ground. (Default: 0.3)
Returns
HandleSeraphHandAnimations(float)
public void HandleSeraphHandAnimations(float dt)Parameters
dtfloat
Ignite()
public override void Ignite()Initialize(EntityProperties, ICoreAPI, long)
Called when this entity got created or loaded
public override void Initialize(EntityProperties properties, ICoreAPI api, long chunkindex3d)Parameters
propertiesEntityPropertiesapiICoreAPIchunkindex3dlong
OnAsyncParticleTick(float, IAsyncParticleManager)
public override void OnAsyncParticleTick(float dt, IAsyncParticleManager manager)Parameters
dtfloatmanagerIAsyncParticleManager
OnCollideWithLiquid()
Called when the entity got in touch with a liquid
public override void OnCollideWithLiquid()OnFallToGround(double)
Called when the entity collided vertically
public override void OnFallToGround(double motionY)Parameters
motionYdouble
OnGameTick(float)
Called every 1/75 second
public override void OnGameTick(float dt)Parameters
dtfloat
OnHurt(DamageSource, float)
Called when the entity got hurt. On the client side, dmgSource is null
public override void OnHurt(DamageSource damageSource, float damage)Parameters
damageSourceDamageSourcedamagefloat
OnReceivedClientPacket(IServerPlayer, int, byte[])
Called when on the client side something called capi.Network.SendEntityPacket()
public override void OnReceivedClientPacket(IServerPlayer player, int packetid, byte[] data)Parameters
playerIServerPlayerpacketidintdatabyte[]
OnReceivedServerPacket(int, byte[])
Called when on the server side something called sapi.Network.SendEntityPacket() Packetid = 1 is used for teleporting Packetid = 2 is used for BehaviorHarvestable
public override void OnReceivedServerPacket(int packetid, byte[] data)Parameters
OnSelfBeforeRender(float)
public void OnSelfBeforeRender(float dt)Parameters
dtfloat
OnTesselated()
public override void OnTesselated()OnTesselation(ref Shape, string)
Called by EntityShapeRenderer.cs before tesselating the entity shape
public override void OnTesselation(ref Shape entityShape, string shapePathForLogging)Parameters
PlayEntitySound(string, IPlayer, bool, float)
Assumes that it is only called on the server
public override void PlayEntitySound(string type, IPlayer dualCallByPlayer = null, bool randomizePitch = true, float range = 24)Parameters
PlayInsideSound(IPlayer)
public virtual bool PlayInsideSound(IPlayer player)Parameters
playerIPlayer
Returns
PlayStepSound(IPlayer, bool)
public virtual void PlayStepSound(IPlayer player, bool playingInsideSound)Parameters
Revive()
Revives the entity and heals for 9999.
public override void Revive()SetCurrentlyControlledPlayer()
Sets the current player.
public void SetCurrentlyControlledPlayer()ShouldReceiveDamage(DamageSource, float)
Should return true if the entity can get damaged by given damageSource. Is called by ReceiveDamage.
public override bool ShouldReceiveDamage(DamageSource damageSource, float damage)Parameters
damageSourceDamageSourcedamagefloat
Returns
TeleportToDouble(double, double, double, Action)
Teleports the entity to given position. Actual teleport is delayed until target chunk is loaded.
public override void TeleportToDouble(double x, double y, double z, Action onTeleported = null)Parameters
TryGiveItemStack(ItemStack)
Called when something tries to given an itemstack to this entity
public override bool TryGiveItemStack(ItemStack itemstack)Parameters
itemstackItemStack
Returns
TryMount(IMountableSeat)
Attempts to mount this entity on a target.
public override bool TryMount(IMountableSeat onmount)Parameters
onmountIMountableSeatThe mount to mount
Returns
- bool
Whether it was mounted or not.
TryStopHandAction(bool, EnumItemUseCancelReason)
Attempts to stop the hand action.
public override bool TryStopHandAction(bool forceStop, EnumItemUseCancelReason cancelReason = EnumItemUseCancelReason.ReleasedMouse)Parameters
forceStopboolcancelReasonEnumItemUseCancelReasonThe reason for stopping the action.
Returns
- bool
Whether the stop was cancelled or not.
UpdateDebugAttributes()
Updates the DebugAttributes tree
public override void UpdateDebugAttributes()UpdatePartitioning()
public void UpdatePartitioning()WalkInventory(OnInventorySlot)
This walks the inventory for the entity agent.
public override void WalkInventory(OnInventorySlot handler)Parameters
handlerOnInventorySlotthe event to fire while walking the inventory.
canPlayEdgeSitAnim()
protected bool canPlayEdgeSitAnim()Returns
getSoundSourceBlockAt(Cuboidd, BlockSelection, int, bool)
protected Block getSoundSourceBlockAt(Cuboidd entityBox, BlockSelection blockSel, int blockLayer, bool usecollisionboxes)Parameters
entityBoxCuboiddblockSelBlockSelectionblockLayerintusecollisionboxesbool
Returns
onAnimControls(AnimationMetaData, bool, bool)
protected override bool onAnimControls(AnimationMetaData anim, bool wasActive, bool nowActive)Parameters
animAnimationMetaDatawasActiveboolnowActivebool
Returns
protectEyesFromWind(float)
protected void protectEyesFromWind(float dt)Parameters
dtfloat
Events
OnFootStep
Set this to hook into the foot step sound creator thingy. Currently used by the armor system to create armor step sounds. Called by the game client and server.
public event Action OnFootStepEvent Type
OnImpact
Called when the player falls onto the ground. Called by the game client and server.
public event Action<double> OnImpact