Characters are the in-world avatar Instances for players.
Each Player has a Character while they are in the place.
Inherits Instance.
Characters cannot be created with Instance.new, and `Clone` fails on them.
Overview
Properties
- .Player readonly : Player
- .Health : number
- .health deprecated : number
- .Position : Vector3
- .position deprecated : Vector3
- .Yaw readonly : number
- .yaw deprecated : number
- .Velocity : Vector3
- .velocity deprecated : Vector3
- .Animation : int
- .animation deprecated : int
- .Transparency : number
- .transparency deprecated : number
Methods
- :SetPosition(x: number, y: number, z: number)
- :Damage(amount: number)
- :TakeDamage(amount: number) deprecated
- :Kill()
Also inherits Instance methods, except Clone.
Events
Inherits Instance events.
API
Properties
Player
Player readonly : Player
The Player this Character belongs to.
Health
Health : number
Current health from 0 to 100.
Writing 0 kills the Character.
health
health deprecated : number
Identical to Health.
No longer recommended for use.
Position
Position : Vector3
World position of the Character.
Writing this teleports them.
position
position deprecated : Vector3
Identical to Position.
No longer recommended for use.
Yaw
Yaw readonly : number
Facing direction of the Character in degrees.
yaw
yaw deprecated : number
Identical to Yaw.
No longer recommended for use.
Velocity
Velocity : Vector3
Linear velocity of the Character.
In `PlayerMovementModule.MovementMode` "Scripted", write this each frame to move the local player.
velocity
velocity deprecated : Vector3
Identical to Velocity.
No longer recommended for use.
Animation
Animation : int
Current animation state id.
animation
animation deprecated : int
Identical to Animation.
No longer recommended for use.
Transparency
Transparency : number
Avatar fade from 0 (opaque) to 1 (invisible).
transparency
transparency deprecated : number
Identical to Transparency.
No longer recommended for use.
Methods
SetPosition
SetPosition(x: number, y: number, z: number) : void
Teleports the Character to the given world coordinates.
Damage
Damage(amount: number) : void
Subtracts health from the Character.
TakeDamage
TakeDamage(amount: number) : void deprecated
Identical to Damage.
No longer recommended for use.
Kill
Kill() : void
Sets health to 0.
