Player proxy (self.player)¶
Bound on script tables as self.player. Only these members are available; unknown names are rejected.
Source: Utils/Lua/LuaPlayerApi.cs.
Properties¶
| Name | Type / signature | Notes |
|---|---|---|
AlienEnergy |
int AlienEnergy |
|
DoingAerialAttack |
Boolean DoingAerialAttack |
|
FullnessPercent |
float FullnessPercent |
|
HoldRotation |
float HoldRotation |
|
Stamina |
float Stamina |
|
VelX |
float VelX |
Methods¶
| Signature | Notes |
|---|---|
void AddStatusEffect(object statusEffect) |
|
void AdjustAlienEnergy(int adjustAmount) |
|
void AdjustStamina(float staminaAdjustment, Boolean canTriggerExhaust = true, Boolean canTriggerRegenDelay = true, Boolean giveHalfGrace = false) |
|
float DetermineEncumbranceAttackSpeedMultiplier() |
|
float GetGloveDamageReductionFlat() |
Flat damage reduction from equipped gloves, or 0 when none are worn. |
int GetItemQuantity(InventoryItemType itemType) |
|
int GetItemQuantity(String itemUniqueID) |
|
float GetMeleeSpeedMod() |
Current melee speed modifier from status effects (1.0 = normal). |
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-14T18:38:10.4882241Z · b67bc26a · 26 members.