Human
Inherits from Character.
Only character owner can modify fields and call functions unless otherwise specified.
Fields
Weapon
string
true
Human's current weapon ("Blade", "AHSS", "Thunderspear", "APG").
CurrentGas
float
false
Current gas. Cannot be set higher than max gas.
MaxGas
float
false
Max gas.
CurrentBlade
int
false
Current number of blades left. Cannot be set higher than max blades.
MaxBlade
int
false
Max number of blades.
CurrentBladeDurability
float
false
Current blade durability. Cannot be set higher than max durability. Breaks blades when set to 0.
MaxBladeDurability
float
false
Maximum blade durability.
CurrentAmmoRound
int
false
Current ammo in current round.
MaxAmmoRound
int
false
Max ammo per round.
CurrentAmmoLeft
int
false
Current ammo left.
MaxAmmoTotal
int
false
Maximum total ammo.
Acceleration
int
false
Acceleration stat.
Speed
int
false
Run speed stat.
HorseSpeed
float
false
Horse run speed.
IsMounted
bool
true
Is the human mounted to an object (does not count horses)
MountedMapObject
MapObject
true
Returns the current mounted map object.
MountedTransform
Transform
true
Returns the current mounted transform.
CurrentSpecial
string
true
Returns the current special.
AutoRefillGas
bool
true
If the human has the input setting AutoRefillGas enabled. Character owner only.
State
string
true
Animation state of the human. Valid states are: Idle, Attack, GroundDodge, AirDodge, Reload, Refill, Die, Grab, EmoteAction, SpecialAttack, SpecialAction, Slide, Run, Land, MountingHorse, Stun, WallSlide.
CanDodge
bool
false
Disables/Enables dodging.
LeftHookEnabled
bool
false
Disables/Enables the left hook.
RightHookEnabled
bool
false
Disables/Enables the right hook.
IsInvincible
bool
false
Disables/Enables whether human is invincible.
InvincibleTimeLeft
float
false
Amount of time before IsInvincible is set to false.
SpecialCooldown
float
false
Maximum cooldown on special ability.
ShifterLiveTime
float
false
If shifter special is equipped, how much live time for transforming.
SpecialCooldownRatio
float
true
Ratio of CurrentCooldown / SpecialCooldown. 1.0 Means ability is ready.
Functions
Refill()
bool
Causes the human to enter refill animation and refreshes all gas/ammo at the end. Returns true if the human actually needed refill.
RefillImmediate()
null
Immediately refreshes all gas/ammo without animation.
ClearHooks()
null
Causes the human to disable both hooks if any are active.
ClearLeftHook()
null
Causes the human to disable the left hook if it is active.
ClearRightHook()
null
Causes the human to disable the right hook if it is active.
MountMapObject(obj: MapObject, positionOffset: Vector3, rotationOffset: Vector3)
null
Mounts the human to the given MapObject.
MountTransform(obj: Transform, positionOffset: Vector3, rotationOffset: Vector3)
null
Mounts the human to the given Transform.
Unmount()
null
Unmounts the human from an object.
SetSpecial(special: string)
null
ActivateSpecial()
null
Triggers the special to activate.
SetWeapon(weapon: string)
null
Sets the human weapon. (see Game.Loadouts to get allowed loadouts for the current room settings). Valid loadouts are Blades, AHSS, APG, Thunderspears.
DisablePerks()
null
Disables all perks.
Last updated