Character

Inherits from: CharacterBase

Functions

Function Name	Return Type	Description	Tags
GetUser()	User	Get the User entity which controls this Character	None
GetLookAtPos()	Vector	Get the point the player is looking at, for an action camera this is the same as User:GetCameraLookAtPos but for orbit style cameras it will be in front of the player	Server Only, Local Only
GetLookAtPosition()	Vector	Get the point the player is looking at, for an action camera this is the same as User:GetCameraLookAtPosition but for orbit style cameras it will be in front of the player	Server Only, Local Only
GetLookAt()	Vector, Vector	Return two values, the position of the player's virtual "eye" and the position the player is looking at. For an action camera this is the same as User:GetCameraLookAt but for an orbit style camera it will be the player's head position and what is in front of the player	Server Only, Local Only
SetInputLocked(boolean inputLocked)	None	Lock player control	Server Only, Local Only
GetInteraction()	Entity, HitResult	Get whichever Entity you would interact with if you pressed interact	Server Only, Local Only
PlayVibrationEffect(VibrationEffectAsset effect)	None	Plays the given vibration effect on the player's controller	None
PlayManualVibration(number intensity, number duration, boolean affectSmallMotors, boolean affectLargeMotors)	Manually vibrate the player's controller	None

Properties

Property Name	Return Type	Description	Tags
canRoll	boolean	Turn on or off ability to roll	Read-Write
canJump	boolean	Turn on or off ability to jump	Read-Write
canCrouch	boolean	Turn on or off ability to crouch or go prone	Read-Write
displayDefaultNameTag	boolean	Turn on or off the default name tag	Read-Write
displayDefaultQuickChat	boolean	Turn on or off the default overhead quick chat	Read-Write
interactionRange	number	Interaction range (from camera in cm)	Read-Write
cameraType	number	Set the character camera type. 1 = Action, 2 = Orbit	Read-Write
forcedCameraPerspective	number	Set restrictions on the action player camera perspective. 1 = No Restrictions, 2 = 1st Person Only, 3 = 3rd Person Only. (Default is 1)	Read-Write
canIronSight	boolean	Will the action camera iron-sight on secondary press	Read-Write
thirdPersonFOV	number	FOV of the third person action camera	Read-Write
thirdPersonIronSightFOV	number	FOV of the third person action camera in Iron Sight mode	Read-Write
firstPersonFOV	number	FOV of the third person action camera	Read-Write
firstPersonIronSightFOV	number	FOV of the third person action camera in Iron Sight mode	Read-Write
ironSightLookSpeedMultiplier	number	Speed multiplier of the look controls in Iron Sight mode	Read-Write
cameraDistance	number	Set the orbit camera max distance from the character	Read-Write
cameraPitch	number	Set the orbit camera's pitch	Read-Write
cameraYaw	number	Set the orbit camera's yaw	Read-Write
cameraLock	boolean	Lock/Unlock the orbit camera	Read-Write
cameraSecondaryAction	number	Set what the secondary action does in the orbit camera	Read-Write
cameraCollisionEnabled	boolean	Enable/Disable the camera's collision	Read-Write