Exports - Server Side

Groups

Read Groups for more info.

CreateGroup

@param name string
@param attributes table
@return groupTable table
CreateGroup(name, attributes)

This is used to create a group after the initial start of the script.

DoesGroupExist

@param name string
@return exists boolean
DoesGroupExist(name)

Checks if the group exists.

AddPlayerToGroup

@param playerId int
@param name string
@return success boolean
AddPlayerToGroup(playerId, name)

Adds a player to the specified group.

RemovePlayerFromGroup

@param playerId int
@param name string
@return success boolean
RemovePlayerFromGroup(playerId, name)

Removes the player from the group.

GetPlayerGroup

@param playerId int
@return groupName string
GetPlayerGroup(playerId)

Gets the group the specified player is in.

IsPlayerInGroup

@param playerId int
@param group string
@return inGroup boolean
IsPlayerInGroup(playerId, group)

Check if the player is in the group.

SetGroupAttribute

@param name string
@param attributes table
@param value any
SetGroupAttribute(name, attribute, value)

A setter for group attributes, you can also use this to remove any attributes by passing nil as a value.

GetGroupAttribute

@param name string
@param attributes table
@return retval any
GetGroupAttribute(name, attribute)

A getter for group attributes.

Lobbies

See Lobbies for more info.

CreateLobby

@param name string
@param attributes table
@return lobbyTable table
CreateLobby(name, attributes)
GetGroupAttribute(name, attribute)

This is used to create a lobby after the initial start of the script.

DeleteLobby

@param name string
@return success boolean
DeleteLobby(name)

This is used to delete a lobby after the initial start of the script.

DoesLobbyExist

@param name string
@return exists boolean
DoesLobbyExist(name)

Checks if the specified lobby exists.

AddPlayerToLobby

@param playerId int
@param name string
@return success boolean
AddPlayerToLobby(playerId, name)

Adds a player to the specified lobby.

RemovePlayerFromLobby

@param playerId int
@param name string
@return success boolean
RemovePlayerFromLobby(playerId, name)

Removes the player from the lobby.

GetPlayerLobby

@param playerId int
@return groupName string
GetPlayerLobby(playerId, name)

Gets the lobby the specified player is in.

SetLobbyAttribute

@param name string
@param attributes table
@param value any
SetLobbyAttribute(name, attribute, value)

A setter for lobby attributes, you can also use this to remove any attributes by passing nil as a value.

GetLobbyAttribute

@param name string
@param attributes table
@return retval any
GetLobbyAttribute(name, attribute)

A getter for lobby attributes.

AddGroupToLobby

@param lobby string
@param group string
@return success boolean
AddGroupToLobby(lobby, group)

Adds every member of a group to a lobby.

RemoveGroupFromLobby

@param lobby string
@param group string
@return success boolean
RemoveGroupFromLobby(lobby, group) 

Removes every member of a group from a lobby.