Skip to main content

Players

The Players class gets all information about current Players connected to a GameInstance, or about a Player using an Avatar (if the Player is in a GameInstance).

To get the Players class, you must get its handler.

let Players = instance.GetHandler("Players")

You can then use the Players property to access the Players class.

Methods

Method NameReturn TypeParametersDescription
GetPlayerFromUserIdPlayer?stringReturns a Player from their UserId

Properties

Property NameTypeDescription
LocalPlayerPlayerThe Local Player, or the Avatar Player
ChildrenPlayer[]All Players currently present in an instance