Players::local

Client-Side

Function

JavaScript

Returns the local player object of the given client-side environment.

JavaScript Syntax

Syntax

mp.players.local

Example

Client-Side

  const localPlayer = mp.players.local;
  localPlayer.freezePosition(true);

See also

• Functions:
  • Player.addArmourTo
  • Player.addVehicleSubtaskAttackCoord
  • Player.addVehicleSubtaskAttack
  • Player.applyBloodByZone
  • Player.applyBloodDamageByZone
  • Player.applyBloodSpecific
  • Player.applyBlood
  • Player.applyDamageDecal
  • Player.applyDamagePack
  • Player.applyDamageTo
  • Player.call
  • Player.canInCombatSeeTarget
  • Player.canKnockOffVehicle
  • Player.canRagdoll
  • Player.clearAllProps
  • Player.clearAlternateMovementAnim
  • Player.clearBloodDamageByZone
  • Player.clearBloodDamage
  • Player.clearDamageDecalByZone
  • Player.clearDecorations
  • Player.clearDriveByClipsetOverride
  • Player.clearDrivebyTaskUnderneathDrivingTask
  • Player.clearFacialDecorations
  • Player.clearFacialIdleAnimOverride
  • Player.clearLastDamageBone
  • Player.clearProp
  • Player.clearSecondaryTask
  • Player.clearTasksImmediately
  • Player.clearTasks
  • Player.clearWetness
  • Player.cloneToTarget
  • Player.clone
  • Player.controlMountedWeapon
  • Player.explodeHead
  • Player.forceMotionState
  • Player.forceToOpenParachute
  • Player.getAccuracy
  • Player.getAlertness
  • Player.getAmmoInClip
  • Player.getArmour
  • Player.getBoneCoords
  • Player.getBoneIndex
  • Player.getCauseOfDeath
  • Player.getCombatFloat
  • Player.getCombatMovement
  • Player.getCombatRange
  • Player.getConfigFlag
  • Player.getCurrentScenarioId
  • Player.getCurrentScriptedAnim
  • Player.getDeadPickupCoords
  • Player.getDecorationsState
  • Player.getDefensiveAreaPosition
  • Player.getDesiredMoveBlendRatio
  • Player.getDrawableVariation
  • Player.getEnveffScale
  • Player.getExtractedDisplacement
  • Player.getFloodInvincibility
  • Player.getGroupIndex
  • Player.getHeadBlendData
  • Player.getHeadOverlayValue
  • Player.getIsTaskActive
  • Player.getJackTarget
  • Player.getLastDamageBone
  • Player.getMaxHealth
  • Player.getMeleeTargetFor
  • Player.getMoney
  • Player.getMount
  • Player.getNavmeshRouteDistanceRemaining
  • Player.getNearbyPeds
  • Player.getNearbyVehicles
  • Player.getNumberOfDrawableVariations
  • Player.getNumberOfPropDrawableVariations
  • Player.getNumberOfPropTextureVariations
  • Player.getNumberOfTextureVariations
  • Player.getPaletteVariation
  • Player.getParachuteLandingType
  • Player.getParachuteState
  • Player.getParachuteTintIndex
  • Player.getPhoneGestureAnimCurrentTime
  • Player.getPhoneGestureAnimTotalTime
  • Player.getPlayerIsFollowing
  • Player.getPropIndex
  • Player.getPropTextureIndex
  • Player.getRagdollBoneIndex
  • Player.getRelationshipBetweens
  • Player.getRelationshipGroupDefaultHash
  • Player.getRelationshipGroupHash
  • Player.getResetFlag
  • Player.getScriptTaskStatus
  • Player.getSeatIsTryingToEnter
  • Player.getSequenceProgress
  • Player.getSourceOfDeath
  • Player.getStealthMovement
  • Player.getTextureVariation
  • Player.getTimeOfDeath
  • Player.getType
  • Player.getVehicleIsIn
  • Player.getVehicleIsTryingToEnter
  • Player.getVehicleIsUsing
  • Player.getsJacker
  • Player.giveHelmet
  • Player.giveNmMessage
  • Player.hasHeadBlendFinished
  • Player.hasUseScenarioTask
  • Player.hideBloodDamageByZone
  • Player.isAPlayer
  • Player.isActiveInScenario
  • Player.isAimingFromCover
  • Player.isBeingArrested
  • Player.isBeingJacked
  • Player.isBeingStealthKilled
  • Player.isBeingStunned
  • Player.isClimbing
  • Player.isComponentVariationValid
  • Player.isConversationDead
  • Player.isCuffed
  • Player.isDeadOrDying
  • Player.isDiving
  • Player.isDoingDriveby
  • Player.isDrivebyTaskUnderneathDrivingTask
  • Player.isDucking
  • Player.isEvasiveDiving
  • Player.isFacingPed
  • Player.isFalling
  • Player.isFatallyInjured
  • Player.isFleeing
  • Player.isGettingIntoAVehicle
  • Player.isGettingUp
  • Player.isGoingIntoCover
  • Player.isGroupMember
  • Player.isHangingOnToVehicle
  • Player.isHeadtrackingPed
  • Player.isHeadtracking
  • Player.isHuman
  • Player.isHurt
  • Player.isInAnyBoat
  • Player.isInAnyHeli
  • Player.isInAnyPlane
  • Player.isInAnyPoliceVehicle
  • Player.isInAnySub
  • Player.isInAnyTaxi
  • Player.isInAnyTrain
  • Player.isInAnyVehicle
  • Player.isInCombat
  • Player.isInCoverFacingLeft
  • Player.isInCover
  • Player.isInFlyingVehicle
  • Player.isInGroup
  • Player.isInMeleeCombat
  • Player.isInModel
  • Player.isInParachuteFreeFall
  • Player.isInVehicle
  • Player.isInWrithe
  • Player.isInjured
  • Player.isJacking
  • Player.isJumpingOutOfVehicle
  • Player.isJumping
  • Player.isMale
  • Player.isModel
  • Player.isMountedWeaponTaskUnderneathDrivingTask
  • Player.isMoveBlendRatioRunning
  • Player.isMoveBlendRatioSprinting
  • Player.isMoveBlendRatioStill
  • Player.isMoveBlendRatioWalking
  • Player.isOnAnyBike
  • Player.isOnFoot
  • Player.isOnMount
  • Player.isOnSpecificVehicle
  • Player.isOnVehicle
  • Player.isPerformingStealthKill
  • Player.isPlantingBomb
  • Player.isPlayingPhoneGestureAnim
  • Player.isProne
  • Player.isPropValid
  • Player.isRagdoll
  • Player.isReloading
  • Player.isRunningArrestTask
  • Player.isRunningMobilePhoneTask
  • Player.isRunningRagdollTask
  • Player.isRunning
  • Player.isScriptedScenarioUsingConditionalAnim
  • Player.isShootingInArea
  • Player.isShooting
  • Player.isSittingInAnyVehicle
  • Player.isSittingInVehicle
  • Player.isSprinting
  • Player.isStill
  • Player.isStopped
  • Player.isStrafing
  • Player.isSwimmingUnderWater
  • Player.isSwimming
  • Player.isTrackedVisible
  • Player.isTracked
  • Player.isTryingToEnterALockedVehicle
  • Player.isUsingActionMode
  • Player.isUsingAnyScenario
  • Player.isUsingScenario
  • Player.isVaulting
  • Player.isWalking
  • Player.isWearingHelmet
  • Player.knockOffProp
  • Player.knockOffVehicle
  • Player.playAnimOnRunningScenario
  • Player.playFacialAnim
  • Player.registerHatedTargetsAround
  • Player.registerTarget
  • Player.registerheadshot
  • Player.removeDefensiveArea
  • Player.removeFromGroup
  • Player.removeHelmet
  • Player.removePreferredCoverSet
  • Player.removeVoiceFx
  • Player.resetInVehicleContext
  • Player.resetLastVehicle
  • Player.resetMovementClipset
  • Player.resetRagdollTimer
  • Player.resetStrafeClipset
  • Player.resetVisibleDamage
  • Player.resetVoiceFx
  • Player.resetWeaponMovementClipset
  • Player.resurrect
  • Player.reviveInjured
  • Player.setAccuracy
  • Player.setAlertness
  • Player.setAllowVehiclesOverride
  • Player.setAllowedToDuck
  • Player.setAlternateMovementAnim
  • Player.setAmmoInClip
  • Player.setAngledDefensiveArea
  • Player.setArmour
  • Player.setAsCop
  • Player.setAsEnemy
  • Player.setAsGroupLeader
  • Player.setAsGroupMember
  • Player.setBlendFromParents
  • Player.setBlockingOfNonTemporaryEvents
  • Player.setBoundsOrientation
  • Player.setCanArmIk
  • Player.setCanAttackFriendly
  • Player.setCanBeDraggedOut
  • Player.setCanBeKnockedOffVehicle
  • Player.setCanBeShotInVehicle
  • Player.setCanBeTargetedWhenInjured
  • Player.setCanBeTargetedWithoutLos
  • Player.setCanBeTargettedByPlayer
  • Player.setCanBeTargettedByTeam
  • Player.setCanBeTargetted
  • Player.setCanCowerInCover
  • Player.setCanEvasiveDive
  • Player.setCanHeadIk
  • Player.setCanLegIk
  • Player.setCanPeekInCover
  • Player.setCanPlayAmbientAnims
  • Player.setCanPlayAmbientBaseAnims
  • Player.setCanPlayGestureAnims
  • Player.setCanPlayVisemeAnims
  • Player.setCanRagdollFromPlayerImpact
  • Player.setCanRagdoll
  • Player.setCanSmashGlass
  • Player.setCanSwitchWeapon
  • Player.setCanTeleportToGroupLeader
  • Player.setCanTorsoIk
  • Player.setCanUseAutoConversationLookat
  • Player.setCapsule
  • Player.setCombatAbility
  • Player.setCombatAttributes
  • Player.setCombatFloat
  • Player.setCombatMovement
  • Player.setCombatRange
  • Player.setComponentVariation
  • Player.setConfigFlag
  • Player.setCoordsKeepVehicle
  • Player.setCoordsNoGang
  • Player.setCowerHash
  • Player.setDecoration
  • Player.setDefaultComponentVariation
  • Player.setDefensiveAreaAttachedToPed
  • Player.setDefensiveAreaDirection
  • Player.setDefensiveSphereAttachedToPed
  • Player.setDesiredHeading
  • Player.setDesiredMoveBlendRatio
  • Player.setDiesInSinkingVehicle
  • Player.setDiesInVehicle
  • Player.setDiesInWater
  • Player.setDiesInstantlyInWater
  • Player.setDiesWhenInjured
  • Player.setDriveByClipsetOverride
  • Player.setDriveTaskCruiseSpeed
  • Player.setDriveTaskDrivingStyle
  • Player.setDriverAbility
  • Player.setDriverAggressiveness
  • Player.setDucking
  • Player.setEnableBoundAnkles
  • Player.setEnableEnveffScale
  • Player.setEnableHandcuffs
  • Player.setEnableScuba
  • Player.setEnableWeaponBlocking
  • Player.setEnveffScale
  • Player.setExclusivePhoneRelationships
  • Player.setEyeColor
  • Player.setFaceFeature
  • Player.setFacialDecoration
  • Player.setFacialIdleAnimOverride
  • Player.setFiringPattern
  • Player.setFleeAttributes
  • Player.setGeneratesDeadBodyEvents
  • Player.setGestureGroup
  • Player.setGetOutUpsideDownVehicle
  • Player.setGravity
  • Player.setGroupMemberPassengerIndex
  • Player.setHairColor
  • Player.setHeadBlendData
  • Player.setHeadOverlayColor
  • Player.setHeadOverlay
  • Player.setHearingRange
  • Player.setHelmetFlag
  • Player.setHelmetPropIndex
  • Player.setHelmetTextureIndex
  • Player.setHelmet
  • Player.setHighFallTask
  • Player.setIdRange
  • Player.setIkTarget
  • Player.setInVehicleContext
  • Player.setIntoVehicle
  • Player.setKeepTask
  • Player.setLegIkMode
  • Player.setLodMultiplier
  • Player.setMaxHealth
  • Player.setMaxMoveBlendRatio
  • Player.setMaxTimeInWater
  • Player.setMaxTimeUnderwater
  • Player.setMinGroundTimeForStungun
  • Player.setMinMoveBlendRatio
  • Player.setModelIsSuppressed
  • Player.setMoney
  • Player.setMotionBlur
  • Player.setMountedWeaponTarget
  • Player.setMoveAnimsBlendOut
  • Player.setMoveRateOverride
  • Player.setMovementClipset
  • Player.setNameDebug
  • Player.setNeverLeavesGroup
  • Player.setParachuteTaskTarget
  • Player.setParachuteTaskThrust
  • Player.setParachuteTintIndex
  • Player.setPathAvoidFire
  • Player.setPathCanDropFromHeight
  • Player.setPathCanUseClimbovers
  • Player.setPathCanUseLadders
  • Player.setPathPreferToAvoidWater
  • Player.setPathsWidthPlant
  • Player.setPinnedDown
  • Player.setPlaysHeadOnHornAnimWhenDiesInVehicle
  • Player.setPreferredCoverSet
  • Player.setPrimaryLookat
  • Player.setPropIndex
  • Player.setRagdollFlag
  • Player.setRagdollForceFall
  • Player.setRagdollOnCollision
  • Player.setRandomComponentVariation
  • Player.setRandomProps
  • Player.setRelationshipGroupDefaultHash
  • Player.setRelationshipGroupHash
  • Player.setResetFlag
  • Player.setResetRagdollFlag
  • Player.setScriptedAnimSeatOffset
  • Player.setSeeingRange
  • Player.setShootRate
  • Player.setShootsAtCoord
  • Player.setSphereDefensiveArea
  • Player.setStayInVehicleWhenJacked
  • Player.setStealthMovement
  • Player.setSteersAroundObjects
  • Player.setSteersAroundPeds
  • Player.setSteersAroundVehicles
  • Player.setStrafeClipset
  • Player.setSuffersCriticalHits
  • Player.setSweat
  • Player.setTargetLossResponse
  • Player.setTaskVehicleChaseBehaviorFlag
  • Player.setTaskVehicleChaseIdealPursuitDistance
  • Player.setToInformRespectedFriends
  • Player.setToLoadCover
  • Player.setToRagdoll
  • Player.setUsingActionMode
  • Player.setVisualFieldCenterAngle
  • Player.setVisualFieldMaxAngle
  • Player.setVisualFieldMaxElevationAngle
  • Player.setVisualFieldMinAngle
  • Player.setVisualFieldMinElevationAngle
  • Player.setVisualFieldPeripheralRange
  • Player.setVoiceFx
  • Player.setVoiceFxBQF
  • Player.setVoiceFxChorus
  • Player.setVoiceFxCompressor
  • Player.setVoiceFxDistortion
  • Player.setVoiceFxEcho
  • Player.setVoiceFxFlanger
  • Player.setVoiceFxGargle
  • Player.setVoiceFxI3DL2Reverb
  • Player.setVoiceFxParamEq
  • Player.setVoiceFxPeakEq
  • Player.setVoiceFxReverb
  • Player.setVoiceFxVolume
  • Player.setWeaponMovementClipset
  • Player.setWetnessEnabledThisFrame
  • Player.setWetnessHeight
  • Player.stopAnimPlayback
  • Player.stopAnimTask
  • Player.stopWeaponFiringWhenDropped
  • Player.taskAchieveHeading
  • Player.taskAimGunAtCoord
  • Player.taskAimGunAt
  • Player.taskAimGunScripted
  • Player.taskArrest
  • Player.taskBoatMission
  • Player.taskChatTo
  • Player.taskClearLookAt
  • Player.taskClimbLadder
  • Player.taskClimb
  • Player.taskCombatHatedTargetsAround
  • Player.taskCombatHatedTargetsInArea
  • Player.taskCombat
  • Player.taskCower
  • Player.taskDriveBy
  • Player.taskEnterVehicle
  • Player.taskFollowNavMeshToCoordAdvanced
  • Player.taskFollowNavMeshToCoord
  • Player.taskFollowPointRoute
  • Player.taskFollowToOffsetOf
  • Player.taskForceMotionState
  • Player.taskGetOffBoat
  • Player.taskGoStraightToCoord
  • Player.taskGoToCoordAndAimAtHatedEntitiesNearCoord
  • Player.taskGoToCoordAnyMeansExtraParamsWithCruiseSpeed
  • Player.taskGoToCoordAnyMeansExtraParams
  • Player.taskGoToCoordAnyMeans
  • Player.taskGoToCoordWhileAimingAtCoord
  • Player.taskGoToWhileAimingAt
  • Player.taskGotoAiming
  • Player.taskGotoOffset
  • Player.taskGuardCurrentPosition
  • Player.taskGuardSphereDefensiveArea
  • Player.taskHandsUp
  • Player.taskHeliChase
  • Player.taskHeliMission
  • Player.taskJump
  • Player.taskLeaveAnyVehicle
  • Player.taskLeaveVehicle
  • Player.taskLookAt
  • Player.taskMoveNetworkAdvanced
  • Player.taskMoveNetwork
  • Player.taskOpenVehicleDoor
  • Player.taskParachuteToTarget
  • Player.taskParachute
  • Player.taskPatrol
  • Player.taskPause
  • Player.taskPerformSequence
  • Player.taskPlaneChase
  • Player.taskPlaneLand
  • Player.taskPlaneMission
  • Player.taskPlantBomb
  • Player.taskPlayAnimAdvanced
  • Player.taskPlayAnim
  • Player.taskPlayPhoneGestureAnimation
  • Player.taskPutDirectlyIntoCover
  • Player.taskPutDirectlyIntoMelee
  • Player.taskRappelFromHeli
  • Player.taskReactAndFlee
  • Player.taskReloadWeapon
  • Player.taskScriptedAnim
  • Player.taskScriptedAnimation
  • Player.taskSeekCoverFrom
  • Player.taskSeekCoverToCoords
  • Player.taskSetBlockingOfNonTemporaryEvents
  • Player.taskSetDecisionMaker
  • Player.taskShockingEventReact
  • Player.taskShootAtCoord
  • Player.taskShuffleToNextVehicleSeat
  • Player.taskSkyDive
  • Player.taskSlideToCoordHdgRate
  • Player.taskSlideToCoord
  • Player.taskSmartFleeCoord
  • Player.taskSmartFlee
  • Player.taskStandGuard
  • Player.taskStandStill
  • Player.taskStartScenarioAtPosition
  • Player.taskStartScenarioInPlace
  • Player.taskStayInCover
  • Player.taskStealthKill
  • Player.taskStopPhoneGestureAnimation
  • Player.taskSwapWeapon
  • Player.taskSweepAim
  • Player.taskSynchronizedScene
  • Player.taskTurnToFaceCoord
  • Player.taskTurnToFace
  • Player.taskUseMobilePhoneTimed
  • Player.taskUseMobilePhone
  • Player.taskUseNearestScenarioToCoordWarp
  • Player.taskVehicleAimAt
  • Player.taskVehicleChase
  • Player.taskVehicleDriveToCoordLongrange
  • Player.taskVehicleDriveToCoord
  • Player.taskVehicleDriveWander
  • Player.taskVehicleEscort
  • Player.taskVehicleFollowWaypointRecording
  • Player.taskVehicleFollow
  • Player.taskVehicleGotoNavmesh
  • Player.taskVehicleHeliProtect
  • Player.taskVehicleMissionCoorsTarget
  • Player.taskVehicleMissionTarget
  • Player.taskVehiclePark
  • Player.taskVehicleShootAt
  • Player.taskVehicleTempAction
  • Player.taskWanderInArea
  • Player.taskWanderStandard
  • Player.taskWarpIntoVehicle
  • Player.taskWrithe
  • Player.uncuff
  • Player.unregisterheadshot
  • Player.updateHeadBlendData
  • Player.updateTaskAimGunScriptedTarget
  • Player.updateTaskHandsUpDuration
  • Player.updateTaskSweepAim
  • Player.wasKilledByStealth
  • Player.wasKilledByTakedown
  • Player.wasSkeletonUpdated
  • Player.taskCrawl
  • Player.taskCrawlToCoords
  • Player.taskRevive
  • Player.taskBleedingDeath
• Properties:
  • Players::isTypingInTextChat
  • Players::local
  • Player::name
  • Player::vehicle
  • Entity::handle
  • Entity::id
  • Entity::model
  • Entity::position
  • Entity::isPositionFrozen
  • Player::voiceVolume
  • Player::voiceAutoVolume
  • Player::voice3d
  • Player::isPlayerTalking
  • Player::p2pEnabled
  • Player::p2pConnected