StartGameArgs Struct Reference

Fusion Start Arguments, used to configure the simulation mode and other settings. More...

Public Member Functions
override string	ToString ()
	StartGameArgs ToString()

Public Attributes
NetAddress?	Address
	Peer Binding Address.
AuthenticationValues	AuthValues
	Custom Authentication Data.
NetworkProjectConfig	Config
	Custom NetworkProjectConfig used to start the simulation.
byte[]	ConnectionToken
	Connection token sent by client to server. Not used in shared mode.
Type[]	CustomCallbackInterfaces
	User defined callback interfaces we will provide O(1) constant time lookup for.
string	CustomLobbyName
	Session Custom Lobby to be published in.
FusionAppSettings	CustomPhotonAppSettings
	Custom Photon Application Settings.
NetAddress?	CustomPublicAddress
	Custom Public Reflexive Address.
string	CustomSTUNServer
	Specify a Custom STUN Server used to Resolve the peer Reflexive Addresses.
bool	DisableNATPunchthrough
	Flag to disable the NAT Punchthrough implementation and connect only via Relay.
bool?	EnableClientSessionCreation
	Enables the Session creation when starting a Client with an specific Session Name.
GameMode	GameMode
	Fusion.GameMode in which this peer will start
Action< NetworkRunner >	HostMigrationResume
	Callback invoked when the new Host is migrating from the old Host state.
HostMigrationToken	HostMigrationToken
	Host Migration Token used when restarting the Fusion Simulation.
bool?	IsOpen
	Session should be created Open or Closed to accept joins.
bool?	IsVisible
	Session should be Visible or not in the Session Lobby list.
MatchmakingMode?	MatchmakingMode
	Session Join Matchmaking Mode when joining a Session. For more information, check Fusion.Photon.Realtime.MatchmakingMode
INetworkObjectInitializer	ObjectInitializer
	See INetworkRunnerUpdater
INetworkObjectProvider	ObjectProvider
	Object pool to use.
Action< NetworkRunner >	OnGameStarted
	Callback that is invoked when the Fusion has fully started.
int?	PlayerCount
	Number of players allowed to connect to this peer, when running in Server/Host Mode.
NetworkSceneInfo?	Scene
	Scene that will be set as the starting Scene when running in Server/Host Mode.
INetworkSceneManager	SceneManager
	See INetworkSceneManager.
string	SessionName
	Photon Cloud Session Name used either to Create or Join a Session.
Func< string >	SessionNameGenerator
	Used to generate a new Session Name when creating a Session.
Dictionary< string, SessionProperty >	SessionProperties
	Custom Session Properties. This dictionary can be used to either setup the initial Session Properties when creating a Session but also to set the matchmaking filters when joining a Random Session.
CancellationToken	StartGameCancellationToken
	Optional CancellationToken used to cancel the NetworkRunner start up process and shutdown.
INetworkRunnerUpdater	Updater
	See INetworkRunnerUpdater
bool	UseCachedRegions
	Enables the usage of the previous cached regions pings. This speeds up the region ping process and the runner startup process.
bool?	UseDefaultPhotonCloudPorts
	Signal if the internal Realtime Client should use the Default Photon ports to connect to the Photon Cloud. By default, Fusion uses ports: 27000, 27001 and 27002. Set this to True to use ports: 5058, 5055 and 5056.

Detailed Description

Fusion Start Arguments, used to configure the simulation mode and other settings.

More about matchmaking: https://doc.photonengine.com/en-us/fusion/current/manual/matchmaking

Member Data Documentation

Address

NetAddress? Address

Peer Binding Address.

Default: NetAddress.Any(ushort)

AuthValues

AuthenticationValues AuthValues

Custom Authentication Data.

Default: null (default authentication values)

Config

NetworkProjectConfig Config

Custom NetworkProjectConfig used to start the simulation.

Default: Global NetworkProjectConfig

More about NetworkProjectConfig: https://doc.photonengine.com/en-us/fusion/current/manual/network-project-config

ConnectionToken

byte [] ConnectionToken

Connection token sent by client to server. Not used in shared mode.

Default: null (empty connection token)

CustomCallbackInterfaces

Type [] CustomCallbackInterfaces

User defined callback interfaces we will provide O(1) constant time lookup for.

Default: null

CustomLobbyName

string CustomLobbyName

Session Custom Lobby to be published in.

Default: null (default Lobby for each Session Type, LobbyClientServer or LobbyShared)

CustomPhotonAppSettings

FusionAppSettings CustomPhotonAppSettings

Custom Photon Application Settings.

Default: null (Global PhotonAppSettings)

CustomPublicAddress

NetAddress? CustomPublicAddress

Custom Public Reflexive Address.

Default: null

CustomSTUNServer

string CustomSTUNServer

Specify a Custom STUN Server used to Resolve the peer Reflexive Addresses.

Default: null (no custom STUN Server)

DisableNATPunchthrough

bool DisableNATPunchthrough

Flag to disable the NAT Punchthrough implementation and connect only via Relay.

Default: false

EnableClientSessionCreation

bool? EnableClientSessionCreation

Enables the Session creation when starting a Client with an specific Session Name.

Default: false (clients can not create new Sessions)

HostMigrationResume

Action<NetworkRunner> HostMigrationResume

Callback invoked when the new Host is migrating from the old Host state.

Default: null

HostMigrationToken

HostMigrationToken HostMigrationToken

Host Migration Token used when restarting the Fusion Simulation.

Default: null

IsOpen

bool? IsOpen

Session should be created Open or Closed to accept joins.

Default: true

IsVisible

bool? IsVisible

Session should be Visible or not in the Session Lobby list.

Default: true

MatchmakingMode

MatchmakingMode? MatchmakingMode

Session Join Matchmaking Mode when joining a Session. For more information, check Fusion.Photon.Realtime.MatchmakingMode

Default: MatchmakingMode.FillRoom

ObjectProvider

INetworkObjectProvider ObjectProvider

Object pool to use.

Default: null

OnGameStarted

Action<NetworkRunner> OnGameStarted

Callback that is invoked when the Fusion has fully started.

Default: null

PlayerCount

int? PlayerCount

Number of players allowed to connect to this peer, when running in Server/Host Mode.

Default: DefaultPlayers from the Global NetworkProjectConfig

Scene

NetworkSceneInfo? Scene

Scene that will be set as the starting Scene when running in Server/Host Mode.

Default: null (no scene set)

SceneManager

INetworkSceneManager SceneManager

See INetworkSceneManager.

Default: null

More about Scene Loading: https://doc.photonengine.com/en-us/fusion/current/manual/scene-loading

SessionName

string SessionName

Photon Cloud Session Name used either to Create or Join a Session.

Default: null (random session matching)

SessionNameGenerator

Func<string> SessionNameGenerator

Used to generate a new Session Name when creating a Session.

Default: null (a random session name is generated based on a GUID)

SessionProperties

Dictionary<string, SessionProperty> SessionProperties

Custom Session Properties. This dictionary can be used to either setup the initial Session Properties when creating a Session but also to set the matchmaking filters when joining a Random Session.

Default: null (empty custom properties)

StartGameCancellationToken

CancellationToken StartGameCancellationToken

Optional CancellationToken used to cancel the NetworkRunner start up process and shutdown.

Defaults: null

UseCachedRegions

bool UseCachedRegions

Enables the usage of the previous cached regions pings. This speeds up the region ping process and the runner startup process.

Defaults: false

UseDefaultPhotonCloudPorts

bool? UseDefaultPhotonCloudPorts

Signal if the internal Realtime Client should use the Default Photon ports to connect to the Photon Cloud. By default, Fusion uses ports: 27000, 27001 and 27002. Set this to True to use ports: 5058, 5055 and 5056.

Default: false (uses ports 27000, 27001 and 27002)