| GetUsername |
Text user:GetUsername() |
Get the display name of the User. |
|
| GetPlayerCardIcon |
string user:GetPlayerCardIcon() |
|
|
| SpawnPlayer |
Character user:SpawnPlayer(Template playerTemplate) |
Spawn a player Entity for this User using the supplied template asset. |
Server Only |
| SpawnPlayer |
Character user:SpawnPlayer(Template playerTemplate, Locator locatorEntity) |
Spawn a player Entity for this User using the supplied template asset, at the position and rotation of the locatorEntity. |
Server Only |
| SpawnPlayer |
Character user:SpawnPlayer(Template playerTemplate, Vector position, Rotation rotation) |
Spawn a player Entity for this User using the supplied template asset, at the given position and rotation. |
Server Only |
| SpawnPlayerWithEffect |
Character user:SpawnPlayerWithEffect(Template playerTemplate, callback onEffectEnded) |
Spawn a player Entity for this User using the supplied template asset and trigger the spawn effect with callback |
Server Only |
| SpawnPlayerWithEffect |
Character user:SpawnPlayerWithEffect(Template playerTemplate, Locator locatorEntity, callback onEffectEnded) |
Spawn a player Entity for this User using the supplied template asset, at the position of the spawnPoint (which can be any Entity with a 'playerstart' component) and trigger the spawn effect with callback |
Server Only |
| SpawnPlayerWithEffect |
Character user:SpawnPlayerWithEffect(Template playerTemplate, Vector position, Rotation rotation, callback onEffectEnded) |
Spawn a player Entity for this User using the supplied template asset, at the given position and trigger the spawn effect |
Server Only |
| SpawnPlayerWithEffect |
Character user:SpawnPlayerWithEffect(Template playerTemplate) |
Spawn a player Entity for this User using the supplied template asset and trigger the spawn effect with callback |
Server Only |
| SpawnPlayerWithEffect |
Character user:SpawnPlayerWithEffect(Template playerTemplate, Locator locatorEntity) |
Spawn a player Entity for this User using the supplied template asset, at the position of the spawnPoint (which can be any Entity with a 'playerstart' component) and trigger the spawn effect. |
Server Only |
| SpawnPlayerWithEffect |
Character user:SpawnPlayerWithEffect(Template playerTemplate, Vector position, Rotation rotation) |
Spawn a player Entity for this User using the supplied template asset, at the given position and trigger the spawn effect |
Server Only |
| DespawnPlayer |
user:DespawnPlayer() |
Despawn a player |
Server Only |
| DespawnPlayerWithEffect |
user:DespawnPlayerWithEffect(callback onEffectEnded) |
Despawn a player and trigger the despawn effect with callback when it finishes |
Server Only |
| DespawnPlayerWithEffect |
user:DespawnPlayerWithEffect() |
Despawn a player and trigger the despawn effect |
Server Only |
| GetPlayer |
Entity user:GetPlayer() |
Get the Entity (if there is one) that has been spawned for the User. For now this is always a Character entity. |
|
| SetCamera |
user:SetCamera(Entity cameraEntity) |
Set camera view of this User to the given cameraEntity (which can be either a Camera entity or a Character entity). |
Server Only |
| SetCamera |
user:SetCamera(Entity cameraEntity, number transitionTime) |
Set camera view of this User to the given cameraEntity (which can be either a Camera entity or a Character entity). Transitions the camera over a given time from the previous one. |
Server Only |
| GetCamera |
Camera user:GetCamera() |
|
|
| GetCameraLookAtPos |
Vector user:GetCameraLookAtPos() |
Get the point the camera is looking at |
|
| GetCameraLookAt |
Vector,Vector user:GetCameraLookAt() |
Return two values, the position of the camera and a point the camera is facing at (where it collides with the scene). |
|
| LeaveGame |
user:LeaveGame() |
|
Server Only, Local Only |
| LeaveGame |
user:LeaveGame(callback travelFailedCallback) |
|
Server Only |
| GoToGame |
user:GoToGame(string gameId) |
|
Server Only, Local Only |
| GoToGame |
user:GoToGame(string gameId, callback travelFailedCallback) |
|
Server Only |
| GoToWorld |
user:GoToWorld(WorldAsset worldAsset) |
|
Server Only, Local Only |
| GoToWorld |
user:GoToWorld(WorldAsset worldAsset, callback travelFailedCallback) |
|
Server Only |
| ShowCursor |
user:ShowCursor(bool showCursor) |
Turn the cursor on or off |
Deprecated |
| ProjectPositionToScreen |
Vector2D user:ProjectPositionToScreen(Vector worldLocation) |
Converts a position in world space to a screen space co-ordinate Returned values are in the range 0 to 1 Usage example: function MyPlayerScript:LocalOnTick(deltaTime) local user = self:GetEntity():GetUser() local screenPos = user:ProjectPositionToScreen(Vector.New(0,0,0)) Printf("Screen pos: {1}", screenPos) end |
|
| PlayVibrationEffect |
user:PlayVibrationEffect(VibrationEffectAsset vibrationEffect) |
|
|
| PlayManualVibration |
user:PlayManualVibration(number intensity, number duration, bool affectSmallMotors, bool affectLargeMotors) |
|
|
| SetMoveOverride |
user:SetMoveOverride(Vector2D scale, Vector2D add) |
Set a scale on the user's actual move input and an addition 2D vector to add to it. Used for example to auto-walk a player forward but scaling the real input down to zero and adding an additional value. |
|
| SetLookOverride |
user:SetLookOverride(Vector2D scale, Vector2D add) |
Set a scale on the user's actual look input and an addition 2D vector to add to it. Used for example to auto-look a player at a particular point by scaling the real input down to zero and adding an additional value. |
|
| SetLeaderboardValue |
user:SetLeaderboardValue(string leaderboardId, number value, callback callback) |
|
|
| SetLeaderboardValue |
user:SetLeaderboardValue(string leaderboardId, number value) |
|
|
| GetLeaderboardValue |
user:GetLeaderboardValue(string leaderboardId, callback callback) |
Gets the highest ranking value on the specified leaderboard for this user. Results are returned as parameters to the callback function. Callback function parameters are Score & Rank |
|
| AddToLeaderboardValue |
user:AddToLeaderboardValue(string leaderboardId, number increment, callback callback) |
Add a number to the leaderboard value on the specified leaderboard for this user. Results are returned as parameters to the callback function. Callback function parameter is the new score |
Server Only |
| AddToLeaderboardValue |
user:AddToLeaderboardValue(string leaderboardId, number increment) |
Add a number to the leaderboard value on the specified leaderboard for this user. |
Server Only |
| GetChallengeProgress |
number user:GetChallengeProgress(string challengeId) |
Gets the current progress on an active challenge |
|
| SendChallengeEvent |
user:SendChallengeEvent(string eventName, table eventParametersTable) |
Sends a Challenge event for this user. Takes a lua table of parameter to value pairs that are conditionally checked against the Challenge definition. Usage example: function MyUserScript:OnSomeAction(someValue1, someValue2) self:GetUser():SendChallengeEvent("SomeEvent", {someParameter1 = someValue1, someParameter2 = someValue2}) end |
Server Only |
| SendChallengeEvent |
user:SendChallengeEvent(string eventName) |
Sends a Challenge event for this user. |
Server Only |