Photon Fusion
2.0.6
Fusion Start Arguments, used to configure the simulation mode and other settings More...
Public Member Functions | |
| override string | ToString () |
| StartGameArgs ToString() More... | |
Public Attributes | |
| NetAddress? | Address |
| Peer Binding Address More... | |
| AuthenticationValues | AuthValues |
| Custom Authentication Data More... | |
| NetworkProjectConfig | Config |
| Custom NetworkProjectConfig used to start the simulation More... | |
| byte[] | ConnectionToken |
| Connection token sent by client to server. Not used in shared mode. More... | |
| Type[] | CustomCallbackInterfaces |
| User defined callback interfaces we will provide O(1) constant time lookup for More... | |
| string | CustomLobbyName |
| Session Custom Lobby to be published in More... | |
| FusionAppSettings | CustomPhotonAppSettings |
| Custom Photon Application Settings More... | |
| NetAddress? | CustomPublicAddress |
| Custom Public Reflexive Address More... | |
| string | CustomSTUNServer |
| Specify a Custom STUN Server used to Resolve the peer Reflexive Addresses It can be used to specify multiple STUN Servers separated by semicolon (;) More... | |
| bool | DisableNATPunchthrough |
| Flag to disable the NAT Punchthrough implementation and connect only via Relay More... | |
| bool? | EnableClientSessionCreation |
| Enables the Session creation when starting a Client with an specific Session Name More... | |
| GameMode | GameMode |
| Fusion.GameMode in which this peer will start More... | |
| Action< NetworkRunner > | HostMigrationResume |
| Callback invoked when the new Host is migrating from the old Host state More... | |
| HostMigrationToken | HostMigrationToken |
| Host Migration Token used when restarting the Fusion Simulation More... | |
| bool? | IsOpen |
| Session should be created Open or Closed to accept joins More... | |
| bool? | IsVisible |
| Session should be Visible or not in the Session Lobby list More... | |
| MatchmakingMode? | MatchmakingMode |
| Session Join Matchmaking Mode when joining a Session. For more information, check Fusion.Photon.Realtime.MatchmakingMode More... | |
| INetworkObjectInitializer | ObjectInitializer |
| See INetworkRunnerUpdater More... | |
| INetworkObjectProvider | ObjectProvider |
| Object pool to use More... | |
| Action< NetworkRunner > | OnGameStarted |
| Callback that is invoked when the Fusion has fully started More... | |
| int? | PlayerCount |
| Number of players allowed to connect to the session. More... | |
| NetworkSceneInfo? | Scene |
| Scene that will be set as the starting Scene. More... | |
| INetworkSceneManager | SceneManager |
| See INetworkSceneManager. More... | |
| string | SessionName |
| Photon Cloud Session Name used either to Create or Join a Session. More... | |
| Func< string > | SessionNameGenerator |
| Used to generate a new Session Name when creating a Session. More... | |
| 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. More... | |
| CancellationToken | StartGameCancellationToken |
| Optional CancellationToken used to cancel the NetworkRunner start up process and shutdown More... | |
| INetworkRunnerUpdater | Updater |
| See INetworkRunnerUpdater More... | |
| bool? | UseCachedRegions |
| Enables the usage of the previous cached regions pings. This speeds up the region ping process and the runner startup process. More... | |
| 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. More... | |
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
| override string ToString | ( | ) |
| NetAddress? Address |
Peer Binding Address
Default: NetAddress.Any(ushort)
| AuthenticationValues AuthValues |
Custom Authentication Data
Default: null (default authentication values)
| 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
| byte [] ConnectionToken |
Connection token sent by client to server. Not used in shared mode.
Default: null (empty connection token)
| Type [] CustomCallbackInterfaces |
User defined callback interfaces we will provide O(1) constant time lookup for
Default: null
| string CustomLobbyName |
Session Custom Lobby to be published in
Default: null (default Lobby for each Session Type, LobbyClientServer or LobbyShared)
| FusionAppSettings CustomPhotonAppSettings |
Custom Photon Application Settings
Default: null (Global PhotonAppSettings)
| NetAddress? CustomPublicAddress |
Custom Public Reflexive Address
Default: null
| string CustomSTUNServer |
Specify a Custom STUN Server used to Resolve the peer Reflexive Addresses It can be used to specify multiple STUN Servers separated by semicolon (;)
Default: null (no custom STUN Server)
| bool DisableNATPunchthrough |
Flag to disable the NAT Punchthrough implementation and connect only via Relay
Default: false
| bool? EnableClientSessionCreation |
Enables the Session creation when starting a Client with an specific Session Name
Default: false (clients can not create new Sessions)
Fusion.GameMode in which this peer will start
| Action<NetworkRunner> HostMigrationResume |
Callback invoked when the new Host is migrating from the old Host state
Default: null
Host Migration Token used when restarting the Fusion Simulation
Default: null
| bool? IsOpen |
Session should be created Open or Closed to accept joins
Default: true
| bool? IsVisible |
Session should be Visible or not in the Session Lobby list
Default: true
| MatchmakingMode? MatchmakingMode |
Session Join Matchmaking Mode when joining a Session. For more information, check Fusion.Photon.Realtime.MatchmakingMode
Default: MatchmakingMode.FillRoom
| INetworkObjectInitializer ObjectInitializer |
| INetworkObjectProvider ObjectProvider |
Object pool to use
Default: null
| Action<NetworkRunner> OnGameStarted |
Callback that is invoked when the Fusion has fully started
Default: null
| int? PlayerCount |
Number of players allowed to connect to the session.
Default: DefaultPlayers from the Global NetworkProjectConfig
| NetworkSceneInfo? Scene |
Scene that will be set as the starting Scene.
Default: null (no scene set)
| INetworkSceneManager SceneManager |
See INetworkSceneManager.
Default: null
More about Scene Loading: https://doc.photonengine.com/en-us/fusion/current/manual/scene-loading
| string SessionName |
Photon Cloud Session Name used either to Create or Join a Session.
Default: null (random session matching)
| 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)
| 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)
| CancellationToken StartGameCancellationToken |
Optional CancellationToken used to cancel the NetworkRunner start up process and shutdown
Defaults: null
| INetworkRunnerUpdater Updater |
| bool? UseCachedRegions |
Enables the usage of the previous cached regions pings. This speeds up the region ping process and the runner startup process.
Defaults: true
| 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)