Index | Collapse All Expand All

GetInstance Method
LocalPlayer Class Members See Also

Beta Documentation - Subject to change.
Gets the instance of the Local Player.

# Syntax

Lua
    function LocalPlayer.GetInstance();

#### Returns

Type: LocalPlayer
The instance of the Local Player.

# Remarks

Gets the instance of the Local Player. There is only ever one instance of the local player class that is accessed using this static method. Plugins should be aware that all plugins share the same instance. Proper precautions should be used when using the events on the instance.

# See Also

- LocalPlayer
- Turbine.Gameplay