A player in the game. More...

Inheritance diagram for SmashHammer.GearBlocks.Player.Player:

Properties
bool	IsLocked = false `[get]`
	Is the player locked?

CameraMode	CameraMode `[get]`
	The current camera mode.

bool	IsFreeFlightEnabled = false `[get, set]`
	Is free flight enabled?

Properties inherited from SmashHammer.GearBlocks.Player.IPlayer
ushort	ID `[get]`
	The player's scene ID.

bool	IsLocallyControlled `[get]`
	Is the player locally controlled?

ITargeter	Targeter `[get]`
	The player's targeter.

IInventory	Inventory `[get]`
	The player's inventory.

ITransformable	Aim `[get]`
	The player's aim.

IToolbox	Toolbox `[get]`
	The player's toolbox.

bool	IsLocked `[get]`
	Is the player locked?

CameraMode	CameraMode `[get]`
	The current camera mode.

bool	IsFreeFlightEnabled `[get]`
	Is free flight enabled?

Vector3Proxy	Velocity `[get]`
	The current velocity.

Vector3Proxy	Acceleration `[get]`
	The current acceleration.

Properties inherited from SmashHammer.Scripting.ITransformable
Vector3Proxy	Position `[get]`
	The world position.

QuaternionProxy	Orientation `[get]`
	The world orientation.

Vector3Proxy	LocalPosition `[get]`
	The local position.

QuaternionProxy	LocalOrientation `[get]`
	The local orientation.

Vector3Proxy	Right `[get]`
	The right vector.

Vector3Proxy	Up `[get]`
	The up vector.

Vector3Proxy	Forward `[get]`
	The forward vector.

Additional Inherited Members
Vector3Proxy	TransformDirection (Vector3Proxy direction)
	Transforms direction from local space to world space.

Vector3Proxy	TransformVector (Vector3Proxy vector)
	Transforms vector from local space to world space.

Vector3Proxy	TransformPoint (Vector3Proxy point)
	Transforms point from local space to world space.

Vector3Proxy	InverseTransformDirection (Vector3Proxy direction)
	Transforms direction from world space to local space.

Vector3Proxy	InverseTransformVector (Vector3Proxy vector)
	Transforms vector from world space to local space.

Vector3Proxy	InverseTransformPoint (Vector3Proxy point)
	Transforms point from world space to local space.

Detailed Description

A player in the game.

Available in Lua via the "Players" global, for example:

local playerID = 0
local player = Players.GetInstance( playerID )
Do something with the player here.

for player in Players.Instances do
    Do something with the player here.
end

Property Documentation

bool SmashHammer.GearBlocks.Player.Player.IsLocked = false

get

Is the player locked?

true if this player is currently locked (e.g. to a seat part); otherwise, false.

CameraMode SmashHammer.GearBlocks.Player.Player.CameraMode

get

The current camera mode.

This player's camera mode.

bool SmashHammer.GearBlocks.Player.Player.IsFreeFlightEnabled = false

getset

Is free flight enabled?

true if this player is currently in free flight mode; otherwise, false.