Public API Player This page describes the player API
Get players
playerList()
Retrieves all online player IDs.
Details Example
Arguments
Returns
Player IDs collection.
Spawn
playerSpawn(player)
Spawns the player.
Details Example
Subsequent calls will re-spawn the player.
Make sure you set health to a valid value, since Spawn method doesn't take care of that.
Arguments
Returns
0 if successful, -1 if failed
Copy oak .event ( 'playerConnect' , async pid => {
console .log ( '[info] player connected' , pid)
oak .playerPositionSet (pid , [ - 1774.59301758 , - 4.88487052917 , - 2.40491962433 ])
oak .playerHealthSet (pid , 200 )
oak .playerSpawn (pid)
}) Despawn
playerDespawn(player)
Removes the player from the map.
Details Example
Useful when you want to create a spectator mode in your game.
Arguments
Returns
0 if successful, -1 if failed
Copy oak .cmd ( 'spectator' , async pid => {
oak .playerDespawn (pid)
}) Invalid
playerInvalid(player)
Checks whether the player ID is invalid.
Details Example
None.
Arguments
Returns
0 if invalid
Copy oak .cmd ( 'respawn' , async pid => {
if ( await oak .playerInvalid (pid)) {
oak .log ( 'Not happy ;1' )
return
}
oak .playerDespawn (pid)
}) Kick
playerKick(player, string)
Kicks the player from the game.
Details Example
Useful when you want to create a spectator mode in your game.
Arguments
Returns
0 if successful, -1 if failed
Copy oak .cmd ( 'kickme' , async pid => {
oak .playerKick (pid , 'You were a bad boy!' )
}) Kill
playerKill(player)
Force kills the player.
Details Example
Kills the player naturally.
Arguments
Returns
0 if successful, -1 if failed
Copy oak .cmd ( 'suicide' , async pid => {
oak .playerKill (pid)
}) Play anim
playerDespawn(player, string)
Removes the player from the map.
Details Example
There is no animation list provided, search game folder for possible animation names.
Arguments
Returns
0 if successful, -1 if failed
Set model
playerModelSet(player, string)
Changes the player model.
Details Example
You can use models from the following listing.
Arguments
Returns
0 if successful, -1 if failed
Copy oak .cmd ( 'tommy' , async pid => {
oak .playerModelSet (pid , 'Tommy' )
}) Set health
playerHealthSet(player, float)
Sets the player health.
Details Example
At the moment, this method expects a raw value the game uses to specify health. Maximum health is based off of the mission data, so some maps use value 200, while others can be over 600.
We will make sure health is uniform on the server-side, but right now, you need to set health to 200 if you want full health on freeride map.
Arguments
Returns
0 if successful, -1 if failed
Copy oak .cmd ( 'healme' , async pid => {
oak .playerHealthSet (pid , 200 )
}) Set position
playerPositionSet(player, vec3)
Sets the player position.
Details Example
None.
Arguments
Returns
0 if successful, -1 if failed
Copy oak .cmd ( 'setpos' , async (pid , _x , _y , _z) => {
const x = parseFloat (_x)
const y = parseFloat (_y)
const z = parseFloat (_z)
oak .playerPositionSet (pid , [x , y , z])
}) Set direction
playerDirectionSet(player, vec3)
Sets the player's forward direction vector.
Details Example
None.
Arguments
Returns
0 if successful, -1 if failed
Copy oak .cmd ( 'setdir' , async (pid , _x , _y , _z) => {
const x = parseFloat (_x)
const y = parseFloat (_y)
const z = parseFloat (_z)
oak .playerDirectionSet (pid , [x , y , z])
}) Set heading
playerHeadingSet(player, float)
Sets the player heading angle.
Details Example
Uses a ±180 degree format.
Arguments
Returns
0 if successful, -1 if failed
Copy oak .cmd ( 'rotateto' , async (pid , angle) => {
oak .playerHeadingSet (pid , parseFloat (angle))
}) Get name
playerNameGet(player)
Retrieves the player name.
Details Example
None.
Arguments
Returns
string player name
Copy oak .cmd ( 'alert' , async pid => {
const name = await oak .playerNameGet (pid)
oak .chatBroadcast ( 'Guess who is back: ' + name)
}) Get model
playerModelGet(player)
Retrieves the player's model.
Details Example
None.
Arguments
Returns
string player model name
Get health
playerHealthGet(player)
Retrieves the current player's health.
Details Example
At the moment, this method returns a raw value the game uses to specify health. Maximum health is based off of the mission data, so some maps use value 200, while others can be over 600.
We will make sure health is uniform on the server-side, but right now, you need to be aware that full health differs per mission and freeride uses value of 200.
Arguments
Returns
float player health
Copy oak .cmd ( 'printhp' , async pid => {
const hp = parseFloat ( await oak .playerHealthGet (pid))
oak .chatSend ( 'Current HP: ' + hp)
}) Get heading
playerHeadingGet(player)
Retrieves the player's heading angle.
Details Example
Uses a ±180 degree format.
Arguments
Returns
float heading angle
Get position
playerPositionGet(player)
Retrieves the player position.
Details Example
None.
Arguments
Returns
vec3 array of 3 float values
Copy oak .cmd ( 'getpos' , async pid => {
const pos = await oak .playerPositionGet (pid)
oak .chatSend (pid , 'My position: ' + pos)
}) Get direction
playerDirectionGet(player)
Retrieves the player direction.
Details Example
Retrieves the player's forward vector direction.
Arguments
Returns
vec3 array of 3 float values
Visibility
There are several visibility options you can set for the player:
Player nameplate visibility
Player's blip visibility on the map
Get visibility
playerVisibilityGet(player, visibility_type)
Retrieves the current player's visibility.
Details Example
None.
Arguments
Returns
int player visibility option value
Set visibility
playerVisibilitySet(player, visibility_type, int)
Sets the current player's visibility setting.
Details Example
None.
Arguments
Returns
0 if successful
