Skip to content

Player proxy (self.player)

Bound on script tables as self.player. Only these public members are reachable; unknown names fail closed.

Source: Signs of Life/Utils/Lua/LuaPlayerApi.cs.

Properties

Name Type / signature Notes
AlienEnergy int AlienEnergy
DoingAerialAttack Boolean DoingAerialAttack
HoldRotation float HoldRotation
Stamina float Stamina
VelX float VelX

Methods

Signature Notes
void AdjustAlienEnergy(int adjustAmount)
void AdjustStamina(float staminaAdjustment, Boolean canTriggerExhaust = true, Boolean canTriggerRegenDelay = true, Boolean giveHalfGrace = false)
float DetermineEncumbranceAttackSpeedMultiplier()
float GetGloveDamageReductionFlat() Replaces the self.player.Equipment.Gloves.DamageReductionFlat object-graph read (see the vanilla Fists script) with a single allowlisted call. Returns 0 when no gloves are equipped instead of requiring the script to null-check the graph.
int GetItemQuantity(InventoryItemType itemType)
int GetItemQuantity(String itemUniqueID)
float GetMeleeSpeedMod() Replaces the self.player.LivingEntityStatusEffects.MeleeSpeedMod object-graph read (see the vanilla ComboMeleeWeapon script) with a single allowlisted call.
Vector2 GetPointDirectionVector()
Boolean HasItemQuantity(InventoryItemType itemType, int quantity)
Boolean HasItemQuantity(String itemUniqueID, int quantity)
Boolean IsExhausted()
Boolean IsOnGround()
Boolean IsRunning()
Boolean IsStartingJump()
void LimitAimAngle(float limitedAimAngle, float limitedAimAngleTime)
void OverrideAnimation(String animationName, int lengthMS, float transitionTime = .25f, Boolean lockHead = false, Boolean disrupt = false, float playSpeedMultiplier = 1f)
void RemoveItemQuantity(InventoryItemType itemType, int quantity)
void RemoveItemQuantity(String itemUniqueID, int quantity)
void Stun(int stunTimeMS, String stunAnimation = "stun", float transitionTime = .25f, float playSpeedMultiplier = 1f)

Generated 2026-08-02T05:22:21.4279488Z · a7346a83 · 24 members.