Multiplayer API Reference¶

Complete API reference for the Multiplayer & Game Modes module.

IVXGameModeManager¶

Central hub for mode selection, player slot management, teams, readiness, and match lifecycle phases.

Properties¶

Methods¶

SelectMode¶

public void SelectMode(IVXGameMode mode, int maxPlayers = 0)

Applies mode-specific defaults and resets lobby state.

Parameters: - mode - Target game mode - maxPlayers - Maximum player count (0 uses mode default)

Example:

IVXGameModeManager.Instance.SelectMode(IVXGameMode.OnlineVersus, maxPlayers: 2);

SetConfig¶

public void SetConfig(IVXMatchConfig config)

Replaces the current match configuration and resets lobby state.

Parameters: - config - New match configuration

Example:

var cfg = IVXMatchConfig.Local(maxPlayers: 4);
cfg.AllowBots = true;
IVXGameModeManager.Instance.SetConfig(cfg);

AddLocalPlayer¶

public IVXPlayerSlot AddLocalPlayer(string displayName, int inputDeviceIndex = -1)

Adds a same-device player to the roster.

Parameters: - displayName - Player display name - inputDeviceIndex - Input device index (-1 for default)

Returns: IVXPlayerSlot or null if the roster is full

AddRemotePlayer¶

public IVXPlayerSlot AddRemotePlayer(string userId, string displayName)

Adds an online player to the roster.

Parameters: - userId - Remote player user ID - displayName - Player display name

Returns: IVXPlayerSlot or null if full

AddBot¶

public IVXPlayerSlot AddBot(string botName)

Adds a bot player if CurrentConfig.AllowBots is true.

Parameters: - botName - Bot display name

Returns: IVXPlayerSlot or null if bots are disallowed or roster is full

RemovePlayer¶

public void RemovePlayer(int slotIndex)

Removes a player by slot index. Slot 0 (primary local player) is protected and cannot be removed.

Parameters: - slotIndex - Slot index to remove

SetPlayerReady¶

public void SetPlayerReady(int slotIndex, bool ready)

Toggles the ready state for a player slot.

Parameters: - slotIndex - Target slot index - ready - Ready flag

SetPlayerTeam¶

public void SetPlayerTeam(int slotIndex, IVXTeam team)

Assigns a player to a team.

Parameters: - slotIndex - Target slot index - team - Team assignment

StartMatch¶

public void StartMatch()

Begins loading phase. Requires CanStartMatch to be true.

Example:

if (IVXGameModeManager.Instance.CanStartMatch)
    IVXGameModeManager.Instance.StartMatch();

BeginGameplay¶

public void BeginGameplay()

Transitions to the InProgress phase after scene loading completes.

EndMatch¶

public void EndMatch()

Transitions to the Finished phase.

ReturnToLobby¶

public void ReturnToLobby()

Resets readiness and returns to the lobby phase.

Reset¶

public void Reset()

Clears config, all players, and phase state.

SetPhase¶

public void SetPhase(IVXMatchPhase phase)

Forces a specific phase transition.

Parameters: - phase - Target match phase

GetTeamPlayers¶

public List<IVXPlayerSlot> GetTeamPlayers(IVXTeam team)

Returns all players assigned to a team.

GetLocalPlayers / GetRemotePlayers¶

public List<IVXPlayerSlot> GetLocalPlayers()
public List<IVXPlayerSlot> GetRemotePlayers()

Partitions the roster by IsLocal flag.

IsModeAvailable¶

public bool IsModeAvailable(IVXGameMode mode)

Checks network reachability for online modes.

Returns: true if the mode can be used

Events¶

IVXLobbyManager¶

Online room lifecycle: create, join, list, leave, ready state, and host moderation.

Properties¶

Methods¶

RefreshRoomList¶

public void RefreshRoomList(IVXRoomFilter filter = null)

Fetches or updates the cached room listing.

Parameters: - filter - Optional filter criteria

Example:

IVXLobbyManager.Instance.RefreshRoomList(new IVXRoomFilter { Limit = 15, OnlyAvailable = true });

StartAutoRefresh / StopAutoRefresh¶

public void StartAutoRefresh(float intervalSeconds = 5f, IVXRoomFilter filter = null)
public void StopAutoRefresh()

Starts or stops periodic room list refresh.

Parameters: - intervalSeconds - Refresh interval - filter - Optional filter criteria

CreateRoom¶

public void CreateRoom(IVXCreateRoomRequest request)

Creates a new room and enters as host.

Parameters: - request - Room creation request with RoomName, Config, and optional Password

Example:

IVXLobbyManager.Instance.CreateRoom(new IVXCreateRoomRequest
{
    RoomName = "Open Trivia",
    Config = IVXMatchConfig.OnlineVersus(2),
    Password = null
});

JoinRoom¶

public void JoinRoom(IVXJoinRoomRequest request)

Joins a room by ID with optional password.

Parameters: - request - Join request with RoomId and optional Password

LeaveRoom¶

public void LeaveRoom()

Exits the current room and calls IVXGameModeManager.ReturnToLobby().

SetReady¶

public void SetReady(bool ready)

Toggles local ready state and forwards to the game mode manager.

KickPlayer¶

public void KickPlayer(int slotIndex)

Host-only: removes a remote player from the room.

Parameters: - slotIndex - Slot index to kick

Events¶

IVXMatchmakingManager¶

Quick-match and ranked search with progress callbacks and match-found delivery.

Properties¶

Methods¶

StartSearch¶

public void StartSearch(IVXMatchConfig config = null)

Begins a matchmaking search. Sets the config and transitions to the Matchmaking phase.

Parameters: - config - Match configuration (optional, uses current if null)

CancelSearch¶

public void CancelSearch()

Cancels the active search and clears the ticket.

QuickMatch¶

public void QuickMatch()

Shorthand for StartSearch(IVXMatchConfig.OnlineVersus()).

Example:

IVXMatchmakingManager.Instance.QuickMatch();

RankedMatch¶

public void RankedMatch()

Shorthand for StartSearch(IVXMatchConfig.Ranked()).

Events¶

IVXLocalMultiplayerManager¶

Same-device play: hot-seat turns, round counting, timers, and split-screen viewport helpers.

Properties¶

Methods¶

StartSession¶

public void StartSession(bool hotSeat = true, float turnTimeLimitSeconds = 0f)

Starts a local multiplayer session. Requires at least 2 local players.

Parameters: - hotSeat - Enable turn-based rotation (false for simultaneous play) - turnTimeLimitSeconds - Per-turn time limit (0 for no limit)

Example:

IVXLocalMultiplayerManager.Instance.StartSession(hotSeat: true, turnTimeLimitSeconds: 20f);

EndSession¶

public void EndSession()

Finishes the local session and sets phase to Finished.

EndTurn¶

public void EndTurn()

Advances to the next player's turn, or starts a new round if all players have played.

JumpToPlayer¶

public void JumpToPlayer(int slotIndex)

Forces the active player to a specific slot index.

Parameters: - slotIndex - Target slot index

CalculateSplitScreenRects¶

public static Rect[] CalculateSplitScreenRects(int playerCount)

Returns normalized viewport rects for 2, 3, or 4 player split-screen layouts.

Parameters: - playerCount - Number of players (2--4)

Returns: Array of normalized Rect values

ApplySplitScreen¶

public static void ApplySplitScreen(Camera[] cameras)

Applies split-screen rects to an array of cameras.

Parameters: - cameras - Player cameras to configure

Example:

IVXLocalMultiplayerManager.ApplySplitScreen(playerCameras);

Events¶

Data Models¶

IVXGameMode (enum)¶

IVXMatchPhase (enum)¶

IVXMatchConfig¶

Factory Methods¶

public static IVXMatchConfig Solo()
public static IVXMatchConfig Local(int maxPlayers)
public static IVXMatchConfig OnlineVersus(int maxPlayers, IVXNetworkTransport transport = NakamaRealtime)
public static IVXMatchConfig OnlineCoop(int maxPlayers)
public static IVXMatchConfig Ranked()

IVXPlayerSlot¶

IVXRoomInfo¶

IVXMatchFoundResult¶

See Also¶

• Multiplayer Module Guide
• Backend Module
• Discord Module
• Hiro Module