Photon Bolt Engine API  1.2.9
Static Public Member Functions | List of all members
BoltLauncher Class Reference

Utility class used to start Bolt as Server or Client. More...

Static Public Member Functions

static void SetUdpPlatform (UdpPlatform platform)
 Set a custom UDP platform. Use this method only to set custom properties to your desired platform. By default, there is no need to change the platform, this is handled internally by Bolt. More...
 
static void Shutdown ()
 Shutdown this Bolt instance. More...
 
static void StartClient (int port=-1)
 Starts Bolt as Client. More...
 
static void StartClient (BoltConfig config)
 Starts Bolt as Client. More...
 
static void StartClient (UdpEndPoint endpoint, BoltConfig config=null)
 Starts Bolt as Client. More...
 
static void StartServer (int port=-1)
 Starts Bolt as Server. More...
 
static void StartServer (BoltConfig config, string scene=null)
 Starts Bolt as Server. More...
 
static void StartServer (UdpEndPoint endpoint, string scene=null)
 Starts Bolt as Server. More...
 
static void StartServer (UdpEndPoint endpoint, BoltConfig config, string scene=null)
 Starts Bolt as Server. More...
 
static void StartSinglePlayer (BoltConfig config=null)
 Starts Bolt as a Single Player game More...
 

Detailed Description

Utility class used to start Bolt as Server or Client.

Member Function Documentation

◆ SetUdpPlatform()

static void BoltLauncher.SetUdpPlatform ( UdpPlatform  platform)
inlinestatic

Set a custom UDP platform. Use this method only to set custom properties to your desired platform. By default, there is no need to change the platform, this is handled internally by Bolt.

Parameters
platformCustom UdpPlatform

This example show how to set a custom PhotonPlatform:

BoltLauncher.SetUdpPlatform(new PhotonPlatform(new PhotonPlatformConfig
{
AppId = "your-app-id",
RegionMaster = "your-region",
UsePunchThrough = true, // set to false, to disable PunchThrough
MaxConnections = 32
}));

◆ Shutdown()

static void BoltLauncher.Shutdown ( )
inlinestatic

Shutdown this Bolt instance.

◆ StartClient() [1/3]

static void BoltLauncher.StartClient ( int  port = -1)
inlinestatic

Starts Bolt as Client.

Parameters
portPort where the Server will try to bind

◆ StartClient() [2/3]

static void BoltLauncher.StartClient ( BoltConfig  config)
inlinestatic

Starts Bolt as Client.

Parameters
configCustom Bolt configuration

◆ StartClient() [3/3]

static void BoltLauncher.StartClient ( UdpEndPoint  endpoint,
BoltConfig  config = null 
)
inlinestatic

Starts Bolt as Client.

Parameters
endpointCustom EndPoint where Bolt will try to bind
configCustom Bolt configuration

◆ StartServer() [1/4]

static void BoltLauncher.StartServer ( int  port = -1)
inlinestatic

Starts Bolt as Server.

Parameters
portPort where the Server will try to bind

◆ StartServer() [2/4]

static void BoltLauncher.StartServer ( BoltConfig  config,
string  scene = null 
)
inlinestatic

Starts Bolt as Server.

Parameters
configCustom Bolt configuration
sceneDefault Scene loaded by Bolt when the initialization is complete

◆ StartServer() [3/4]

static void BoltLauncher.StartServer ( UdpEndPoint  endpoint,
string  scene = null 
)
inlinestatic

Starts Bolt as Server.

Parameters
endpointCustom EndPoint where Bolt will try to bind
sceneDefault Scene loaded by Bolt when the initialization is complete

◆ StartServer() [4/4]

static void BoltLauncher.StartServer ( UdpEndPoint  endpoint,
BoltConfig  config,
string  scene = null 
)
inlinestatic

Starts Bolt as Server.

Parameters
endpointCustom EndPoint where Bolt will try to bind
configCustom Bolt configuration
sceneDefault Scene loaded by Bolt when the initialization is complete

◆ StartSinglePlayer()

static void BoltLauncher.StartSinglePlayer ( BoltConfig  config = null)
inlinestatic

Starts Bolt as a Single Player game

Parameters
configCustom Bolt configuration