player
Client-side
Server-side
Shared
Element category: Entity
The player class represents pedestrians controlled by clients. A player element is created when a client connects to the server and destroyed when that client quits. Players cannot be created or destroyed otherwise.
OOP Methods and Variables
- player:getAccount(...) Variable: .account
- player:logIn(...)
- player:logOut(...)
- player:ban(...)
- player:kick(...)
- player:getName(...) Variable: .name
- player:playSoundFrontEnd(...)
See Also
Player Functions
- countPlayersInTeam
- forcePlayerMap
- getControlState
- getPlayerBlurLevel
- getPlayerFromName
- getPlayerMoney
- getPlayerName
- getPlayerNametagColor
- getPlayerPing
- getPlayerNametagText
- getPlayerScriptDebugLevel
- getPlayerSerial
- getPlayerTeam
- getPlayerWantedLevel
- getPlayersInTeam
- givePlayerMoney
- isPlayerMapForced
- isPlayerNametagShowing
- isVoiceEnabled
- setControlState
- setPlayerBlurLevel
- setPlayerHudComponentVisible
- setPlayerMoney
- setPlayerNametagColor
- setPlayerNametagShowing
- setPlayerNametagText
- takePlayerMoney
- getLocalPlayer
- getPlayerMapBoundingBox
- getPlayerHudComponentProperty
- getPlayerMapOpacity
- isPlayerCrosshairVisible
- isPlayerHudComponentVisible
- isPlayerMapVisible
- resetBlurLevel
- resetPlayerHudComponentProperty
- setPlayerHudComponentProperty
- getAlivePlayers
- getDeadPlayers
- getPlayerACInfo
- getPlayerAnnounceValue
- getPlayerCount
- getPlayerIP
- getPlayerIdleTime
- getPlayerVersion
- getRandomPlayer
- isPlayerMuted
- redirectPlayer
- resendPlayerACInfo
- resendPlayerModInfo
- setPlayerAnnounceValue
- setPlayerName
- setPlayerMuted
- setPlayerScriptDebugLevel
- setPlayerTeam
- setPlayerVoiceBroadcastTo
- setPlayerVoiceIgnoreFrom
- spawnPlayer
- setPlayerWantedLevel
- takePlayerScreenShot
Player Events
- onClientPlayerDamage
- onClientPlayerChoke
- onClientPlayerChangeNick
- onClientPlayerHitByWaterCannon
- onClientPlayerHeliKilled
- onClientPlayerJoin
- onClientPlayerPickupHit
- onClientPlayerPickupLeave
- onClientPlayerRadioSwitch
- onClientPlayerSpawn
- onClientPlayerQuit
- onClientPlayerStealthKill
- onClientPlayerStuntFinish
- onClientPlayerStuntStart
- onClientPlayerTarget
- onClientPlayerVehicleEnter
- onClientPlayerVehicleExit
- onClientPlayerVoicePause
- onClientPlayerVoiceResumed
- onClientPlayerVoiceStart
- onClientPlayerVoiceStop
- onClientPlayerWeaponSwitch
- onClientPlayerWeaponFire
- onClientPlayerWasted
- onPlayerACInfo
- onPlayerBan
- onPlayerChangeNick
- onPlayerChangesProtectedData
- onPlayerChangesWorldSpecialProperty
- onPlayerClick
- onPlayerCommand
- onPlayerChat
- onPlayerConnect
- onPlayerContact
- onPlayerDamage
- onPlayerDiscordJoin
- onPlayerDetonateSatchels
- onPlayerJoin
- onPlayerLogin
- onPlayerLogout
- onPlayerMarkerHit
- onPlayerMarkerLeave
- onPlayerModInfo
- onPlayerMute
- onPlayerNetworkStatus
- onPlayerPickupHit
- onPlayerPickupLeave
- onPlayerPickupUse
- onPlayerProjectileCreation
- onPlayerScreenShot
- onPlayerQuit
- onPlayerStealthKill
- onPlayerTarget
- onPlayerSpawn
- onPlayerTeamChange
- onPlayerPrivateMessage
- onPlayerTeleport
- onPlayerTriggerEventThreshold
- onPlayerTriggerInvalidEvent
- onPlayerUnmute
- onPlayerVehicleEnter
- onPlayerVehicleExit
- onPlayerVoiceStop
- onPlayerWasted
- onPlayerWeaponReload
- onPlayerWeaponFire
- onPlayerVoiceStart
- onPlayerWeaponSwitch
Entity Elements
Element Functions
- attachElements
- createElement
- destroyElement
- detachElements
- getAttachedElements
- getAllElementData
- getElementAlpha
- getElementAngularVelocity
- getElementAttachedOffsets
- getElementAttachedTo
- getElementByID
- getElementByIndex
- getElementChildren
- getElementChild
- getElementChildrenCount
- getElementCollisionsEnabled
- getElementData
- getElementDimension
- getElementHealth
- getElementID
- getElementMatrix
- getElementInterior
- getElementModel
- getElementParent
- getElementPosition
- getElementRotation
- getElementType
- getElementVelocity
- getElementsByType
- getElementsWithinRange
- getLowLODElement
- getResourceDynamicElementRoot
- getPedContactElement
- getRootElement
- getResourceRootElement
- hasElementData
- isElement
- isElementAttached
- isElementCallPropagationEnabled
- isElementDoubleSided
- isElementFrozen
- isElementInWater
- isElementLowLOD
- isElementOnFire
- isElementWithinMarker
- setElementAlpha
- setElementAngularVelocity
- setElementAttachedOffsets
- setElementCallPropagationEnabled
- setElementCollisionsEnabled
- setElementData
- setElementDimension
- setElementDoubleSided
- setElementFrozen
- setElementHealth
- setElementID
- setElementInterior
- setElementModel
- setElementOnFire
- setElementParent
- setElementPosition
- setElementRotation
- setElementVelocity
- setLowLODElement
- getElementBoneMatrix
- getElementBonePosition
- getElementBoneQuaternion
- getElementBoneRotation
- getElementBoundingBox
- getElementDistanceFromCentreOfMassToBaseOfModel
- getElementLighting
- getElementRadius
- isElementCollidableWith
- isElementLocal
- isElementOnScreen
- isElementStreamable
- isElementStreamedIn
- isElementSyncer
- isElementWaitingForGroundToLoad
- setElementBoneMatrix
- setElementBoneQuaternion
- setElementBoneRotation
- setElementCollidableWith
- setElementBonePosition
- setElementLighting
- setElementStreamable
- updateElementRpHAnim
- addElementDataSubscriber
- clearElementVisibleTo
- cloneElement
- getElementSyncer
- getElementZoneName
- hasElementDataSubscriber
- isElementVisibleTo
- removeElementDataSubscriber
- removeElementData
- setElementSyncer
- setElementVisibleTo
Element Events
- onClientElementColShapeHit
- onClientElementColShapeLeave
- onClientElementDataChange
- onClientElementDestroy
- onClientElementInteriorChange
- onClientElementStreamOut
- onClientElementModelChange
- onClientElementDimensionChange
- onClientElementStreamIn
- onElementClicked
- onElementColShapeHit
- onElementColShapeLeave
- onElementDataChange
- onElementDestroy
- onElementStartSync
- onElementModelChange
- onElementStopSync
- onElementInteriorChange
- onElementDimensionChange