AsclepiusCharacter
A character object in Ratchet represents an online player.
INFO
Keep in mind that the Character object currently does not inherit from Actor.
This is due to compatibility reasons and might be resolved in future versions.
Members
Characters have only one variable member, which is ID - this is the same number as Character Unique ID in the DevKit (see the image below) and also as the database ID.
It is also used in Tot scripts as a backend variable to represent players. Therefore you can freely convert this number to a player and a player to this ID in Tot scripts.
And in Ratchet plugins you can also use getPlayerFromID to create a character object from this ID, which is the only way to construct a character object without retrieving it from events or from functions like getPlayersInRadius.
getPlayerFromID function
Create a character object from the player's database ID.
Syntax:
lua
Character|nil getPlayerFromID( int id )Example:
lua
local player = getPlayerFromID(301)
print(type(player))getPlayerFromName function
Find a player by their character's real name (this will ignore /act names and similar).
Syntax:
lua
Character|nil getPlayerFromName( string name )Example:
lua
local player = getPlayerFromName("Bob")
print(type(player))getPlayersInRadius function
Returns a table with all players in radius of specified number of tiles from a vector position.
Syntax:
lua
table<Character> getPlayersInRadius( Vector position, float radius )Example:
lua
-- all players in radius of 10 tiles from the caster
local players = getPlayersInRadius(caster:GetPosition(), 10)getAllPlayers function
Returns a table of all players online on the server.
Syntax:
lua
table<Character> getAllPlayers()getPlayerCount function
Returns a number of online players on the server.
Syntax:
lua
int getPlayerCount()IsValid function
Checks whether the character reference is still valid and the player is online.
Syntax:
lua
bool Character:IsValid()GetName function
Returns a display name of a character. This will use /act name if applicable.
Syntax:
lua
string Character:GetName()Example:
lua
local name = player:GetName()
print(name)GetRealName function
Returns the actual character name as it exists in the database (ignoring /act and similar).
Syntax:
lua
string Character:GetRealName()Example:
lua
local name = player:GetRealName()
print(name)GetSteamID function
Returns SteamID64 (decimal), it is just a long number, but it is saved as a string.
Syntax:
lua
string Character:GetSteamID()Example:
lua
local steamId = player:GetSteamID()
print(steamId)GetGuildID function
Returns the database ID of a clan the player is a member of.
Syntax:
lua
int Character:GetGuildID()Example:
lua
local guildId = player:GetGuildID()
print(guildId)GetGuild function
Syntax:
lua
Guild Character:GetGuild()GetPosition function
Returns a vector of the current coordinates of player's position in the game world.
Syntax:
lua
Vector Character:GetPosition()GetFeetPosition function
Syntax:
lua
Vector Character:GetFeetPosition()Example:
lua
local position = player:GetPosition()
print(position.x, position.y, position.z)GetRotation function
Syntax:
lua
Rotator Character:GetRotation()GetHeight function
Syntax:
lua
float Character:GetHeight()GetHalfHeight function
Syntax:
lua
float Character:GetHalfHeight()GiveItem function
Syntax:
lua
bool Character:GiveItem( int itemId [, int quantity = 1 ] )Notify function
Shows a HUD notification to a player.
Syntax:
lua
void Character:Notify( string icon, string text [, Color iconColor ] )Available icons:
Asclepius
Axe
Bird
Book
Books
Calendar
Campfire
Chat
Check
Clock
Coins
Confetti
Crown
Door
Dress
Drink
Drop
Envelope
Error
Fire
Fist
Flag
Flask
Footprints
Hammer
Handshake
Happy
Heal
Heart
Hourglass
House
Info
Key
Lightbulb
Moon
Neutral
Package
Person
Plant
Puzzle
Question
Sad
Scales
Shield
Skull
Sparkle
Star
Student
Sun
Sword
Tag
Tower
Trophy
Wand
WarningThese beautiful icons come from Phosphor Icons, permitted under MIT License.
ExecuteConsoleCommand function
Syntax:
lua
void Character:ExecuteConsoleCommand( string command )CallComponentFunction function
Syntax:
lua
void Character:CallComponentFunction( string componentName, string functionName )IsStanding function
Syntax:
lua
bool Character:IsStanding()IsWalking function
Syntax:
lua
bool Character:IsWalking()IsRiding function
Syntax:
lua
bool Character:IsRiding()IsArmed function
Syntax:
lua
bool Character:IsArmed()Freeze function
Freeze or unfreeze a player (restricting their movement).
Syntax:
lua
void Character:Freeze( bool enable )PlayVoice function
Play a sound from the VoiceTable (such as voc_pain or voc_jump).
Syntax:
lua
void Character:PlayVoice( string sound )PlayAnimation function
Play animation montage by path, such as:/Game/Characters/humans/animations/emotes/AM_emote_greet_salute.AM_emote_greet_salute
Syntax:
lua
void Character:PlayAnimation( string path [, string startSection = "None", float playRate = 1.0 ] )StopAnimation function
Stop animation montage by path, or all animations if no path is specified
Syntax:
lua
void Character:StopAnimation( [ string path = "" ] )