Jazz2::Multiplayer namespace

Classes

struct AllPeersT

All connected peers tag type.

class BattleMode

Battle game mode (free-for-all).

class CaptureTheFlagMode

Capture The Flag game mode.

struct ConnectionResult

Describes a connection result of INetworkHandler::OnPeerConnected().

class CooperationMode

Cooperation game mode.

struct GameEndResult

Result of IGameMode::CheckGameEnds.

class IGameMode

Rules of a single multiplayer game mode.

class IGameModeContext

Services a game mode needs from its host level handler.

class IGameModeHUD

Drawing surface a game mode uses to render its own part of the HUD.

class INetworkHandler

Interface to handle incomming network requests.

class IServerObserver

Interface to observe publicly-listed running servers.

class IServerStatusProvider

Interface to provide current status of the server.

struct LocalPeerT

Local peer tag type.

class MpLevelHandler

Level handler of a multiplayer game session (online or local splitscreen).

struct MpPlayerState

Network-agnostic per-player game-mode state for a single round.

class NetworkManager

Manages game-specific network connections.

class NetworkManagerBase

Allows to create generic network clients and servers.

struct Peer

Remote peer as opaque handle.

struct PeerDescriptor

Peer descriptor.

struct PlaylistEntry

Playlist entry in ServerConfiguration.

class RaceMode

Race game mode.

struct RespawnDecision

Result of IGameMode::DecideRespawn.

struct ServerConfiguration

Server configuration.

struct ServerDescription

Server description.

class ServerDiscovery

Allows to monitor publicly-listed running servers for server listing.

struct ServerInitialization

Server initialization parameters.

class TeamBattleMode

Team Battle game mode.

class TeamRaceMode

Team Race game mode.

class TeamTreasureHuntMode

Team Treasure Hunt game mode.

class TreasureHuntMode

Treasure Hunt game mode.

Enums

enum class LevelExitAction { Ignore, ChangeToNextLevel, EndGameForInitiator, WarpToStartIncrementLap }

What should happen when a player reaches the level exit, as decided by the game mode.

enum class GameModeFontType { Small, Medium }

Selects which HUD font a game mode draws text with.

enum class GameModeHudIcon { Food, GemRed, GemGreen }

A semantic HUD icon a game mode can draw; the HUD maps it to a concrete sprite.

enum class MpGameMode { Unknown = 0, Battle, TeamBattle, Race, TeamRace, TreasureHunt, TeamTreasureHunt, CaptureTheFlag, Cooperation }

Multiplayer game mode.

enum class NetworkChannel : std::uint8_t { Main, UnreliableUpdates, Count }

Network packet channel.

enum class NetworkState { None, Listening, Connecting, Connected, Local }

State of network connection.

enum class BroadcastPacketType { Null, DiscoveryRequest, DiscoveryResponse }

Packet type broadcasted on the local network.

enum class ClientPacketType { Null, Ping, Reserved, Rpc, Auth = 10, LevelReady, ChatMessage, ValidateAssetsResponse, ForceResyncActors = 20, PlayerReady = 30, PlayerUpdate, PlayerKeyPress, PlayerChangeWeaponRequest, PlayerSpectateRequest, PlayerAckWarped, PlayerChangeCharacter, PlayerChangeTeamRequest }

Packet type going from client to server.

enum class ServerPacketType { Null, Pong, Reserved, Rpc, AuthResponse = 70, PeerSetProperty, ValidateAssets, StreamAsset, LoadLevel = 80, LevelSetProperty, LevelResetProperties, ShowInGameLobby, FadeOut, PlaySfx, PlayCommonSfx, ShowAlert, ChatMessage, SyncTileMap, SetTrigger, AdvanceTileAnimation, RevertTileAnimation, CreateDebris, CreateControllablePlayer = 110, CreateRemoteActor, CreateMirroredActor, DestroyRemoteActor, UpdateAllActors, ChangeRemoteActorMetadata, MarkRemoteActorAsPlayer, UpdatePositionsInRound, SyncRaceCheckpoints, SyncTeamScores, SyncScoreboard, PlayerSetProperty = 130, PlayerResetProperties, PlayerRespawn, PlayerMoveInstantly, PlayerAckWarped, PlayerActivateForce, PlayerEmitWeaponFlare, PlayerChangeWeapon, PlayerTakeDamage, PlayerPush, PlayerActivateSpring, PlayerWarpIn }

Packet type going from server to client.

enum class PeerPropertyType { Unknown, Connected, Disconnected, Roasted, Count }

Peer property type from ServerPacketType::PeerSetProperty.

enum class LevelPropertyType { Unknown, State = 1, GameMode, LevelText = 10, Music, Count }

Level property type from ServerPacketType::LevelSetProperty.

enum class PlayerPropertyType { Unknown, PlayerType = 1, Lives, Health, Controllable, Invulnerable, Modifier, Dizzy, Freeze, Shield, LimitCameraView, OverrideCameraView, ShakeCameraView, Spectate, Team, BeingStoodOn, WeaponAmmo = 30, WeaponUpgrades, Coins = 60, Gems, Score, Points = 90, PositionInRound, Deaths, Kills, Laps, TreasureCollected, Count }

Player property type from ServerPacketType::PlayerSetProperty.

enum class PeerLevelState { Unknown, ValidatingAssets, StreamingMissingAssets, LevelLoaded, LevelSynchronized, Spectating, PlayerReady, PlayerSpawned }

Peer state in a level.

enum class SpectateMode : std::uint8_t { None, Forced, Requested, FreeCamera = 0x10, Mask = 0x0F }

Spectate mode flags.

enum class Reason : std::uint32_t { Unknown, Disconnected, InvalidParameter, IncompatibleVersion, ProtocolViolation, SecurityPolicyViolation, AuthFailed, InvalidPassword, InvalidPlayerName, NotInWhitelist, Requires3rdPartyAuthProvider, ServerIsFull, ServerNotReady, ServerStopped, ServerStoppedForMaintenance, ServerStoppedForReconfiguration, ServerStoppedForUpdate, ConnectionLost, ConnectionTimedOut, Kicked, Banned, CheatingDetected, AssetStreamingNotAllowed, Idle }

Client disconnect reason.

Functions

auto CreateGameMode(MpGameMode mode) -> std::unique_ptr<IGameMode>

Creates the IGameMode implementation for the specified game mode.

auto IsTeamGameMode(MpGameMode mode) -> bool

Returns true if the specified game mode splits players into teams.

auto GetTeamColor(std::uint8_t team) -> nCine::Colorf

Returns the display color of the specified team (Blue, Red, Green, Yellow).

auto GetTeamName(std::uint8_t team) -> Death::Containers::StringView

Returns the display name of the specified team.

auto ApplyTeamFurColor(std::uint32_t furColor, std::uint8_t team) -> std::uint32_t

Recolors a packed fur color so the primary character color section matches the team color.

Variables

AllPeersT AllPeers constexpr

All connected peers tag.

LocalPeerT LocalPeer constexpr

Local peer tag.

static std::uint8_t MaxTeamCount constexpr

Maximum number of teams supported.

static std::uint8_t NoPreferredTeam constexpr

Sentinel team value meaning "no preference, let the server decide".

Enum documentation

Function documentation

Variable documentation