sm.player
A player is a user playing the game. Every player controls a Character in the world.
Functions
getAllPlayers
sm.player.getAllPlayers( getInactive )
Returns a table of all players that are currently in the game.
Parameters:
| Name | Type | Description |
|---|---|---|
getInactive (optional) |
boolean | Include getting inactive players. Defaults to false. (Optional) |
Returns:
| Type | Description |
|---|---|
| table | Table of all players in the game. {Player, ..} |
getHostPlayer
sm.player.getHostPlayer( )
Returns the player of the game host.
Returns:
| Type | Description |
|---|---|
| Player | The host player. |