gameinstancemanager - TogetherGames/Public-Corona-Lua GitHub Wiki

The GameInstanceManager is used for fetching and finding matches that exist for the current game.

Stores all the GameInstances contained in the Manager.

Adds a GameInstance to the manager internally without persistence.

Note
This method is deprecated

GameInstanceManager:Add( gameInstance )

TogetherGameInstance gameInstance

Instance of a GameInstance to add internally

Finds the GameInstance with the specified GameInstanceID if it exists, otherwise returns nil.

GameInstanceManager:FindByGameInstanceID( gameInstanceID )

number gameInstanceID

The ID of the GameInstance to find

Gets the number of GameInstances currently managed internally.

GameInstanceManager:GetCount(  )

Gets the GameInstance at the specified index if it exists, otherwise return nil.

GameInstanceManager:Get( index )

number index

The index of the GameInstance to find

Returns the index of the specified GameInstance if it exists, otherwise returns nil.

GameInstanceManager:IndexOf( gameInstance )

TogetherGameInstance gameInstance

Instance of the GameInstance to find the index of

Returns the index of the GameInstance with the specified GameInstanceID if it exists, otherwise returns -1.

GameInstanceManager:IndexOfByGameInstanceID( gameInstanceID )

number gameInstanceID

The ID of the GameInstance to find the index of

Removes a GameInstance from the internally managed list. This does not delete the GameInstance from the Game persistently.

Note
This method is deprecated

GameInstanceManager:Remove( index )

number index

The index of the GameInstance to be removed internally

Creates a new GameInstance. Upon success, this will automatically update the internal list.

GameInstanceManager:Create( gameInstanceType, gameInstanceSubType, roomID, maxUsers, passTurn, gameInstanceProperties, gameInstanceUserProperties, callbackFunc )

string gameInstanceType

The type of GameInstance to create. Potentially, a Game could have several types of GameInstance types within it. Type is limited to 16 characters.

The subtype of the GameInstance that will be created. Potentially, a Game could have several sub types within it. SubType is limited to 16 characters.

The ID of the room the rematch GameInstance is created in. Pass 0 to bypass room creation.

The max number of users the GameInstance supports. Pass in 2 for a two player game.

A boolean indicating whether the turn should be passed immediately onto the next User. When true, the TurnUserID will actually be set to nil. When the next User joins the GameInstance, the TurnUserID will be set to them.

The properties to assign to the GameInstance. Pass nil to assign no properties to the GameInstance.

The properties to assign to your GameInstanceUser. Pass nil to assign no properties to the GameInstanceUser.

The function to call upon completion.

Creates a rematch of a GameInstance. Upon success, this will automatically update the internal list. If the GameInstance is not already finished, it will be finished and a leaderboard will be generated.

GameInstanceManager:CreateRematch( originalGameInstanceID, gameInstanceType, gameInstanceSubType, roomID, maxUsers, winningUserID, turnUserID, includeLeftGameUsers, rematchMessage, originalGameProps, origianlGameWinningUserProps, rematchGameProps, callbackFunc )

number originalGameInstanceID

The ID of the original GameInstance we're creating a rematch from.

The type of GameInstance to create. Potentially, a Game could have several types of GameInstance types within it. Type is limited to 16 characters.

The subtype of the GameInstance that will be created. Potentially, a Game could have several subtypes within it. SubType is limited to 16 characters.

The ID of the room the rematch GameInstance is created in. Pass in 0 for no room.

The max number of users the GameInstance supports. Pass in 2 for a two player game.

The ID of the User that has won the GameInstance.

The ID of the User whose initial turn it is.

A boolean dictating whether users that have left the original game should be included in the rematched GameInstance.

The notification message to send to all other users that are a member of the rematched GameInstance. Pass "" to have no notification message sent.

The final properties of the original GameInstance.

The properties of the winning User of the original GameInstance.

The properties of the rematch GameInstance. Pass in nil to assign no properties to the rematched GameInstance.

The function to call upon completion.

Deletes a GameInstance. Upon success, this will automatically update the internal list.

GameInstanceManager:Delete( gameInstanceID, callbackFunc )

number gameInstanceID

The ID of the GameInstance to delete.

The function to call upon completion.

Gets all GameInstances. Upon success, this will automatically update the internal list.

GameInstanceManager:GetAll( userID, stateMask, maxCount, getGameInstanceProperties, friendsOnly, gameInstanceType, gameInstanceSubtype, callbackFunc )

number userID

The ID of the User who must be a member of a GameInstance retrieved. Pass 0 to fetch all games regardless of membership within them.

A table containing the GameInstance States to retrieve. The following stateMask table members are examined:

-- To get all GameInstances that are playable.
local stateMasks = { waitingForPlayers=true, inProgress=true };
-- To get all GameInstances regardless of State.
local stateMasks = { waitingForPlayers=true, inProgress=true, finished=true, possibleRematch=true, forfeit=true };

The maximum number of GameInstance to retrieve.

Set TRUE to retrieve the property collections of each game instance, FALSE to retrieve the instances without properties.

Set TRUE to retrieve only gamesin which you and your friends are joined in

Set to retrieve only games with this type, pass nil to ignore.

Set to retrieve only games with this subtype, pass nil to ignore.

The function to call upon completion.

Gets all the GameInstances in a duel. Upon success, this will automatically update the internal list.

GameInstanceManager:GetAllInDuel( gameInstanceDuelID, callbackFunc )

number gameInstanceDuelID

The ID of the duel to retrieve all GameInstances for.

The function to call upon completion.

Joins an existing GameInstance. Upon success, this will automatically update the internal list.

GameInstanceManager:Join( gameInstanceID, gameInstanceUserProperties, callbackFunc )

number gameInstanceID

The ID of the specific GameInstance to join.

The properties to assign the User joining the GameInstance.

The function to call upon completion.

Joins a random existing GameInstance. Upon success, this will automatically update the internal list.

GameInstanceManager:JoinRandom( gameInstanceType, gameInstanceSubType, gameInstanceUserProperties, callbackFunc )

string gameInstanceType

The type of GameInstance to join.

The sub-type (if any) of GameInstance to join.

The properties to assign the User joining the GameInstance.

The function to call upon completion.