Skip to main content

405 docs tagged with "player"

View all tags

AddPlayerClassEx

This function is exactly the same as the AddPlayerClass function, with the addition of a team parameter.

AllowPlayerTeleport

Enable/Disable the teleporting ability for a player by right-clicking on the map.

Ban

Ban a player who is currently in the server.

BanEx

Ban a player with a reason.

BeginObjectEditing

Allows a player to edit an object (position and rotation) using their mouse on a GUI (Graphical User Interface).

ClearAnimations

Clears all animations for the given player (it also cancels all current tasks such as jetpacking, parachuting, entering vehicles, driving (removes player out of vehicle), swimming, etc).

DisablePlayerRaceCheckpoint

Disable any initialized race checkpoints for a specific player, since you can only have one at any given time.

EditPlayerObject

Allows players to edit a player-object (position and rotation) with a GUI and their mouse.

GameTextForPlayer

Shows 'game text' (on-screen text) for a certain length of time for a specific player.

GangZoneGetPos

Get the position of a gangzone, represented by minX, minY, maxX, maxY coordinates

GetGameText

Returns all the information on the given game text style.

GetMaxPlayers

Returns the maximum number of players that can join the server, as set by the server variable 'maxplayers' in server.

GetPlayerAmmo

Gets the amount of ammo in a player's current weapon.

GetPlayerArmour

This function stores the armour of a player into a variable.

GetPlayerCameraFrontVector

This function will return the current direction of player's aiming in 3-D space, the coords are relative to the camera position, see GetPlayerCameraPos.

GetPlayerCameraUpVector

This function returns the vector, that points to the upside of the camera's view, or, in other words, to the middle top of your screen.

GetPlayerHealth

The function GetPlayerHealth allows you to retrieve the health of a player.

GetPlayerIp

Get the specified player's IP address and store it in a string.

GetPlayerMenu

Gets the ID of the menu the player is currently viewing (shown by ShowMenuForPlayer).

GetPlayerPos

Get the position of a player, represented by X, Y and Z coordinates.

GetPlayers

Gets an array variable of the IDs of the current players on the server.

GetPlayerScore

This function returns a player's score as it was set using SetPlayerScore.

GetSpawnInfo

Return the current spawn data for a player, where they will spawn next.

HasGameText

Does the player currently have text in the given gametext style displayed?

IsPlayerConnected

Checks if a player is connected (if an ID is taken by a connected player).

IsPlayerInCheckpoint

Check if the player is currently inside a checkpoint, this could be used for properties or teleport points for example.

IsPlayerNPC

Check if a player is an actual player or an NPC.

Kick

Kicks a player from the server. They will have to quit the game and re-connect if they wish to continue playing.

OnPickupStreamIn

This callback is called when a pickup enters the visual range of a player.

OnPickupStreamOut

This callback is called when a pickup leaves the visual range of a player.

OnPlayerClickGangZone

This callback is called when a player clicked a gangzone on the pause menu map (by right-clicking).

OnPlayerClickMap

This callback is called when a player places a target/waypoint on the pause menu map (by right-clicking).

OnPlayerClickPlayer

This callback is called when a player double-clicks on a player on the scoreboard.

OnPlayerClickTextDraw

This callback is called when a player clicks on a textdraw or cancels the select mode with the Escape key.

OnPlayerCommandText

This callback is called when a player enters a command into the client chat window.

OnPlayerConnect

This callback is called when a player connects to the server.

OnPlayerDeath

This callback is called when a player dies, either by suicide or by being killed by another player.

OnPlayerEditObject

This callback is called when a player finishes editing an object (BeginObjectEditing/BeginPlayerObjectEditing).

OnPlayerEnterVehicle

This callback is called when a player starts to enter a vehicle, meaning the player is not in vehicle yet at the time this callback is called.

OnPlayerKeyStateChange

This callback is called when the state of any supported key is changed (pressed/released).

OnPlayerLeaveCheckpoint

This callback is called when a player leaves the checkpoint set for them by SetPlayerCheckpoint.

OnPlayerObjectMoved

This callback is called when a player object is moved after MovePlayerObject (when it stops moving).

OnPlayerPickUpPickup

This callback is called when a player picks up a pickup created with CreatePickup.

OnPlayerRequestClass

This callback is called when a player changes class at class selection (and when class selection first appears).

OnPlayerRequestSpawn

This callback is called when a player attempts to spawn via class selection either by pressing SHIFT or clicking the 'Spawn' button.

OnPlayerSelectObject

This callback is called when a player selects an object after BeginObjectSelecting has been used.

OnPlayerStreamIn

This callback is called when a player is streamed by some other player's client.

OnPlayerStreamOut

This callback is called when a player is streamed out from some other player's client.

OnPlayerText

This callback is called when a player sends a chat message.

OnPlayerUpdate

This callback is called every time a client/player updates the server with their status.

OnScriptLoadPlayer

This callback is called for each connected player when a script is loaded.

PlayCrimeReportForPlayer

This function plays a crime report for a player - just like in single-player when CJ commits a crime.

Player States

A list of all the player states used by GetPlayerState function or OnPlayerStateChange callback.

PlayerGangZoneGetPos

Get the position of a gangzone, represented by minX, minY, maxX, maxY coordinates

PlayerTextDrawTextSize

Change the size of a player-textdraw (box if PlayerTextDrawUseBox is enabled and/or clickable area for use with PlayerTextDrawSetSelectable).

RemovePlayerMapIcon

Removes a map icon that was set earlier for a player using SetPlayerMapIcon.

SetCameraBehindPlayer

Restore the camera to a place behind the player, after using a function like SetPlayerCameraPos.

SetPlayerColor

Set the colour of a player's nametag and marker (radar blip).

SetPlayerDrunkLevel

Sets the drunk level of a player which makes the player's camera sway and vehicles hard to control.

SetPlayerPosFindZ

This sets the players position then adjusts the players z-coordinate to the nearest solid ground under the position.

SetPlayerShopName

Loads or unloads an interior script for a player (for example the ammunation menu).

SetSpawnInfo

This function can be used to change the spawn information of a specific player.

ShowPlayerNameTagForPlayer

This functions allows you to toggle the drawing of player nametags, healthbars and armor bars which display above their head.

Special Actions

A list of all the player special actions used by GetPlayerSpecialAction and SetPlayerSpecialAction functions.

StopPlayerObject

Stop a moving player-object after MovePlayerObject has been used.

StopRecordingPlayerData

Stops all the recordings that had been started with StartRecordingPlayerData for a specific player.

UsePlayerPedAnims

Uses standard player walking animation (animation of the CJ skin) instead of custom animations for every skin (e.g. skating for skater skins).