GBX.lua.Team (Object)

Up one category: Class reference

The Team class is used to represent a faction in a team game. The only valid location for a Team object is under the Teams service. This mirrors the structure of the Player and Players classes.

WARNING - The Team class is considered highly experimental at this stage of development. Scripts written against the Team class may break in any new release.

Functions

The Team class only incorporates the global functions.

Properties

• AutoAssignable - A boolean value that specifies whether the Teams service can automatically assign a new player to this Team. If no Team object has this flag set, new players will not get assigned a Team automatically. If more than 1 Team has this property set, the new player will be assigned to the team with the least players. In case of a tie, he will be assigned to a random team. If this is not the behavior you want, you can set AutoAssignable to false for all Teams and handle all Team joins in scripting.

• AutoColorCharacters

• Name - The string that will be displayed in the Team leaderboard.

• Score - This is a currently unused field that you can use to save an integer team score.

• TeamColor - The color the team Name will be drawn in on the Team leaderboard and in the floating text above each players head. This property is of type BrickColor (as opposed to BrickColorValue).

Events

The Team class only incorporates the global events.