BasePlayer Class

Initializes a new instance of the BasePlayer class.

Gets or sets the facing angle of this Player.

Gets the index of the animation this Player is playing.

Gets or sets the armor of this Player.

Get the amount of information (in bytes) that the server has sent to the player.

Get the amount of information (in bytes) that the server has received from the player.

Gets the front Vector3 of this Player's camera.

Gets the mode of this Player's camera.

Gets or sets the position of the camera of this Players.

Gets the GtaPlayer the camera of this player is pointing at.

Gets the GlobalObject the camera of this player is pointing at.

Gets the GtaPlayer the camera of this player is pointing at.

Gets the PlayerObject the camera of this player is pointing at.

Gets the GtaVehicle the camera of this player is pointing at.

Gets or sets the Color of this Player.

Gets the amount of time (in milliseconds) that a player has been connected to the server for.

Get a player's connection status.

Gets or sets the default color of a client message.

Gets or sets the drunkenness level of this Player.

Gets or sets the FightStyle of this Player.

Gets this Player's GPCI string.

Gets or sets the health of this Player.

Gets the identifier of this instance.

Gets whether this Player is currently in any vehicle.

Gets whether this Player is in his checkpoint.

Gets whether this Player is in his race-checkpoint.

Gets or sets the interior of this Player.

Gets the IP of this Player.

Gets whether this Player is logged into RCON.

Gets a value indicating whether this Player is alive.

Gets whether this Player is connected to the server.

Gets whether this resource has been disposed.

Gets whether this Player is an actual player or an NPC.

Gets a value indicating whether this player is selecting a textdraw.

Gets a set of KeyHandlers for different key states.

Gets the number of messages the server has received from the player.

Gets the number of messages the player has received in the last second.

Gets the number of messages the server has sent to the player.

Gets or sets the money of this Player.

Gets or sets the name of this Player.

Gets this Player's network stats and saves them into a string.

Gets the packet loss percentage of a player. Packet loss means data the player is sending to the server is being lost (or vice-versa).

Gets the ping of this Player.

Gets the size of the players pool.

Gets or sets the position of this Player.

Gets a collections of Player Variables of this Player.

Gets or sets the rotation of this Player.

Gets or sets the score of this Player.

Gets or sets the skin of this Player.

Gets or sets the SpecialAction of this Player.

Gets the state of this Player.

Gets the GlobalObject that this Player is surfing.

Gets the PlayerObject that this Player is surfing.

Gets the Vehicle that this Player is surfing.

Gets the Actor this Player is aiming at.

Gets the Player this Player is aiming at.

Gets or sets the team this Player is in.

Gets the Vehicle this Player is currently in.

Gets the vehicle seat this Player sits on.

Gets or sets the velocity of this Player.

Gets this Player's game version.

Gets or sets the virtual world of this Player.

Gets or sets the wanted level of this Player.

Gets the Weapon this Player is currently holding.

Gets the ammo of the Weapon this Player is currently holding.

Gets the WeaponState of the Weapon this Player is currently holding.

Apply an animation to this BasePlayer.

Apply an animation to this BasePlayer.

Checks whether this instance has been disposed. If it has, it throws an exception.

Ban this BasePlayer. The ban will be IP-based, and be saved in the samp.ban file in the server's root directory. Ban(String) allows you to ban with a reason, while you can ban and unban IPs using the RCON banip and unbanip commands.

Ban this BasePlayer with a reason.

Cancels object editing mode for this player.

Cancel text draw selection with the mouse for this BasePlayer.

Clears all animations for this BasePlayer.

Clears all animations for this BasePlayer.

Creates an explosion for a BasePlayer. Only the specific player will see explosion and feel its effects. This is useful when you want to isolate explosions from other players or to make them only appear in specific virtual worlds.

Create an explosion at the specified coordinates.

Create an explosion at the specified coordinates.

Create an explosion at the specified coordinates.

Disable any initialized checkpoints for this BasePlayer.

Disable any initialized race checkpoints for this BasePlayer.

Allows you to disable collisions between vehicles for a player.

Performs tasks associated with freeing, releasing, or resetting unmanaged resources.

Removes this instance from the pool.

Enter edition mode for an attached object.

Toggles camera targeting functions for a player.

Toggle stunt bonuses for this BasePlayer.

Determines whether the specified object is equal to the current object.

Finalizes an instance of the Disposable class.

Forces this BasePlayer to go back to class selection.

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

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

Get the animation library/name this BasePlayer is playing.

Calculate the distance between this BasePlayer and a map coordinate.

Serves as the default hash function.

Check which keys this BasePlayer is pressing.

Retrieves the start and end (hit) position of the last bullet a player fired.

Get this BasePlayer's current game time. Set by SetWorldTime(Int32), SetWorldTime(Int32), or by ToggleClock(Boolean).

Gets the Type of the current instance.

Get the Weapon and ammo in this BasePlayer's weapon slot.

Give money to this BasePlayer.

Give this BasePlayer a Weapon with a specified amount of ammo.

An overloadable point for initialization logic which requires the Id to be set.

Interpolate this BasePlayer's camera's 'look at' point between two coordinates with a set speed.

Move this BasePlayer's camera from one position to another, within the set time.

Check if this BasePlayer has an object attached in the specified index (slot).

Check if this BasePlayer is in range of a point.

Checks if this BasePlayer is in a specific BaseVehicle.

Checks if a BasePlayer is streamed in this BasePlayer's client.

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

Creates a shallow copy of the current Object.

Raises the CancelClickTextDraw event.

Raises the Cleanup event.

Raises the ClickMap event.

Raises the ClickPlayer event.

Raises the ClickPlayerTextDraw event.

Raises the ClickTextDraw event.

Raises the CommandText event.

Raises the Connected event.

Raises the Died event.

Raises the DialogResponse event.

Raises the Disconnected event.

Raises the EditAttachedObject event.

Raises the EditGlobalObject event.

Raises the EditPlayerObject event.

Raises the EnterCheckpoint event.

Raises the EnterExitModShop event.

Raises the EnterRaceCheckpoint event.

Raises the EnterVehicle event.

Raises the ExitedMenu event.

Raises the ExitVehicle event.

Raises the GiveDamage event.

Raises the InteriorChanged event.

Raises the KeyStateChanged event.

Raises the LeaveCheckpoint event.

Raises the LeaveRaceCheckpoint event.

Raises the PickUpPickup event.

Raises the RequestClass event.

Raises the RequestSpawn event.

Raises the SelectedMenuRow event.

Raises the SelectGlobalObject event.

Raises the SelectPlayerObject event.

Raises the Spawned event.

Raises the StateChanged event.

Raises the StreamIn event.

Raises the StreamOut event.

Raises the TakeDamage event.

Raises the Text event.

Raises the Update event.

Raises the WeaponShot event.

Play an 'audio stream' for this BasePlayer. Normal audio files also work (e.g. MP3).

Play an 'audio stream' for this BasePlayer. Normal audio files also work (e.g. MP3).

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

Plays the specified sound for this BasePlayer.

Plays the specified sound for this BasePlayer at a specific point.

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

Puts this BasePlayer in a vehicle as driver.

Puts this BasePlayer in a BaseVehicle.

Remove an attached object from this BasePlayer.

Removes/ejects this BasePlayer from his vehicle.

Removes a map icon that was set earlier for this player using SetMapIcon(Int32, Vector3, MapIcon, Color, MapIconType).

Reset this BasePlayer's money to $0.

Removes all weapons from this BasePlayer.

Display the cursor and allow this BasePlayer to select a text draw.

This function sends a message to this BasePlayer in white in the chat. The whole line in the chat box will be in the set color unless color embedding is used.

This function sends a message to this BasePlayer in white in the chat. The whole line in the chat box will be in the set color unless color embedding is used.

This function sends a message to this BasePlayer with a chosen color in the chat. The whole line in the chat box will be in the set color unless colour embedding is used.

This function sends a message to this BasePlayer with a chosen color in the chat. The whole line in the chatbox will be in the set color unless color embedding is used.

Displays a message in white in chat to all players.

Displays a message in white in chat to all players.

Displays a message in chat to all players.

Displays a message in chat to all players.

Adds a death to the kill feed on the right-hand side of the screen of this BasePlayer.

Adds a death to the kill feed on the right-hand side of the screen.

Sends a message in the name of this BasePlayer to all other players on the server. The line will start with the this BasePlayer's name in their color, followed by the message in white.

Sends a message in the name this BasePlayer to another player on the server. The message will appear in the chat box but can only be seen by receiver. The line will start with the this Player's name in his color, followed by the message in white.

Set the ammo of this BasePlayer's weapon.

Sets the armed weapon of this BasePlayer.

Attach an object to a specific bone on this BasePlayer.

Set the direction this BasePlayer's camera looks at. To be used in combination with CameraPosition.

Set the direction this BasePlayer's camera looks at. To be used in combination with CameraPosition.

Creates a chat bubble above this BasePlayer's name tag.

Sets a checkpoint (red circle) for this BasePlayer. Also shows a red blip on the radar.

Place an icon/marker on this player's map. Can be used to mark locations such as banks and hospitals to players.

Change the color of this BasePlayer's name tag and radar blip for another Player.

This sets this BasePlayer's position then adjusts the Player's z-coordinate to the nearest solid ground under the position.

Creates a race checkpoint. When this BasePlayer enters it, the EnterRaceCheckpoint callback is called.

Loads or unloads an interior script for this BasePlayer. (for example the ammunation menu)

Set the skill level of a certain weapon type for this BasePlayer.

This function can be used to change the spawn information of a specific player. It allows you to automatically set someone's spawn weapons, their team, skin and spawn position, normally used in case of mini games or automatic-spawn systems.

Sets the clock of this BasePlayer to a specific value. This also changes the daytime. (night/day etc.)

Set this BasePlayer's weather. If ToggleClock(Boolean) has been used to enable the clock, weather changes will interpolate (gradually change), otherwise will change instantly.

Set the world boundaries for this BasePlayer - players can not go out of the boundaries.

This functions allows you to toggle the drawing of player name tags, health bars and armor bars which display above their head. For use of a similar function like this on a global level, ShowNameTags(Boolean) function.

(Re)Spawns a player.

Makes this BasePlayer spectate (watch) another player.

Makes this BasePlayer spectate (watch) another player.

Sets this BasePlayer to spectate another vehicle, i.e. see what its driver sees.

Sets this BasePlayer to spectate another vehicle, i.e. see what its driver sees.

Starts recording this BasePlayer's movements to a file, which can then be reproduced by an NPC.

Stops the current audio stream for this BasePlayer.

Stops all the recordings that had been started with StartRecordingPlayerData(PlayerRecordingType, String) for this BasePlayer.

Show/Hide the in-game clock (top right corner) for this BasePlayer.

Toggles whether this BasePlayer can control themselves, basically freezes them.

Toggle this BasePlayer's spectate mode.

Returns a string that represents the current object.

Occurs when the OnCancelClickTextDraw(PlayerEventArgs) is being called. This callback is called when a player cancels the textdraw select mode(ESC).

Occurs when the OnCleanup(DisconnectEventArgs) is being called. This callback is called after a player disconnects from the server.

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

Occurs when the OnClickPlayer(ClickPlayerEventArgs) is being called. Called when a player double-clicks on a player on the scoreboard.

Occurs when the OnClickPlayerTextDraw(ClickPlayerTextDrawEventArgs) is being called. This callback is called when a player clicks on a player-textdraw. It is not called when player cancels the select mode (ESC).

Occurs when the OnClickTextDraw(ClickTextDrawEventArgs) is being called. This callback is called when a player clicks on a textdraw. It is not called when player cancels the select mode (ESC)

Occurs when the OnCommandText(CommandTextEventArgs) is being called. This callback is called when a player enters a command into the client chat window, e.g. /help.

Occurs when the OnConnected(EventArgs) is being called. This callback is called when a player connects to the server.

Occurs when the OnDialogResponse(DialogResponseEventArgs) is being called. This callback is called when a player responds to a dialog shown using Dialog by either clicking a button, pressing ENTER/ESC or double-clicking a list item (if using a list style dialog).

Occurs when the OnDeath(DeathEventArgs) is being called. This callback is triggered when the gamemode starts.

Occurs when the OnDisconnected(DisconnectEventArgs) is being called. This callback is called when a player disconnects from the server.

Occurs when this isntance has been disposed.

Occurs when the OnEditAttachedObject(EditAttachedObjectEventArgs) is being called. This callback is called when a player ends attached object edition mode.

Occurs when the OnEditGlobalObject(EditGlobalObjectEventArgs) is being called. This callback is called when a player ends object edition mode.

Occurs when the OnEditPlayerObject(EditPlayerObjectEventArgs) is being called. This callback is called when a player ends object edition mode.

Occurs when the OnEnterCheckpoint(EventArgs) is being called. This callback is called when a player enters the checkpoint set for that player.

Occurs when the OnEnterExitModShop(EnterModShopEventArgs) is being called. This callback is called when a player enters or exits a mod shop.

Occurs when the OnEnterRaceCheckpoint(EventArgs) is being called. This callback is called when a player enters a race checkpoint.

Occurs when the OnEnterVehicle(EnterVehicleEventArgs) is being called. 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.

Occurs when the OnExitedMenu(EventArgs) is being called. Called when a player exits a menu.

Occurs when the OnExitVehicle(PlayerVehicleEventArgs) is being called. This callback is called when a player exits a vehicle.

Occurs when the OnGiveDamage(DamageEventArgs) is being called. This callback is called when a player gives damage to another player.

Occurs when the OnInteriorChanged(InteriorChangedEventArgs) is being called. Called when a player changes interior.

Occurs when the OnKeyStateChanged(KeyStateChangedEventArgs) is being called. This callback is called when the state of any supported key is changed (pressed/released). Directional keys do not trigger this callback.

Occurs when the OnLeaveCheckpoint(EventArgs) is being called. This callback is called when a player leaves the checkpoint set for that player.

Occurs when the OnLeaveRaceCheckpoint(EventArgs) is being called. This callback is called when a player leaves the race checkpoint.

Occurs when the OnPickUpPickup(PickUpPickupEventArgs) is being called. This callback is called when a player picks up a pickup.

Occurs when the OnRequestClass(RequestClassEventArgs) is being called. Called when a player changes class at class selection (and when class selection first appears).

Occurs when the OnRequestSpawn(RequestSpawnEventArgs) is being called. Called when a player attempts to spawn via class selection.

Occurs when the OnSelectedMenuRow(MenuRowEventArgs) is being called. This callback is called when a player selects an item from a menu.

Occurs when the OnSelectGlobalObject(SelectGlobalObjectEventArgs) is being called. This callback is called when a player selects an object after Select(BasePlayer) has been used.

Occurs when the OnSelectPlayerObject(SelectPlayerObjectEventArgs) is being called. This callback is called when a player selects an object after Select(BasePlayer) has been used.

Occurs when the OnSpawned(SpawnEventArgs) is being called. This callback is called when a player spawns.

Occurs when the OnStateChanged(StateEventArgs) is being called. This callback is called when a player exits a vehicle.

Occurs when the OnStreamIn(PlayerEventArgs) is being called. This callback is called when a player is streamed by some other player's client.

Occurs when the OnStreamOut(PlayerEventArgs) is being called. This callback is called when a player is streamed out from some other player's client.

Occurs when the OnTakeDamage(DamageEventArgs) is being called. This callback is called when a player takes damage.

Occurs when the OnText(TextEventArgs) is being called. Called when a player sends a chat message.

Occurs when the OnUpdate(PlayerUpdateEventArgs) is being called. This callback is called everytime a client/player updates the server with their status.

Occurs when the OnWeaponShot(WeaponShotEventArgs) is being called. This callback is called when a player fires a shot from a weapon.

Identifier indicating the handle is invalid.

Maximum number of players which can exist.

Maximum number of attached objects attached to a player.

Maximum length of the text in a chat bubble.

Maximum length of a player's name.

Identifier indicating a player is not a member of any team.