Reference
Dynamite for Unity
TashiNetworkTransport
Inherits
Unity.Netcode.NetworkTransport
Unity.Netcode.NetworkTransport
Public Methods
void StartSession(IncomingSessionDetails sessionDetails)
void StartSession(IncomingSessionDetails sessionDetails)
Applies the IncomingSessionDetails
and begins the session. This must only be called when no session is starting or is in progress.
If the local player is the lobby host and a Tashi Relay API key is specified then this will also initiate the Tashi Relay session allocation.
Public Fields
TashiNetworkTransportEditorConfig Config
TashiNetworkTransportEditorConfig Config
The TashiNetworkTransportEditorConfig
used to configure the network transport. This is set automatically.
Properties
SessionState SessionState
This has the following descriminants:
NotStarted
Starting
InProgress
OutgoingSessionDetails OutgoingSessionDetails
OutgoingSessionDetails OutgoingSessionDetails
Session details that should be shared with other players.
IncomingSessionDetails
Session details that have been received from other players.
Static Public Methods
static IncomingSessionDetails FromUnityLobby(Lobby lobby)
static IncomingSessionDetails FromUnityLobby(Lobby lobby)
Creates a IncomingSessionDetails
from a Lobby
.
Public Fields
DirectAddressBookEntry? TashiRelay
DirectAddressBookEntry? TashiRelay
An optional DirectAddressBookEntry
that specifies the address of an allocated Tashi Relay server. This is provided by the initial session host. A Tashi Relay isn't always necessary, but it can aid in bypassing NAT and firewalls for many players.
List<AddressBookEntry> AddressBook
List<AddressBookEntry> AddressBook
A list of AddressBookEntry
that is used to define the initial session address book.
AddressBookEntry? Host
AddressBookEntry? Host
The session host's AddressBookEntry
.
OutgoingSessionDetails
Session details that should be shared with other players.
Public Methods
bool AddTo(UpdatePlayerOptions playerOptions)
bool AddTo(UpdatePlayerOptions playerOptions)
Adds the required data to UpdatePlayerOptions
, which must be sent to the Unity lobby.
bool AddTo(UpdateLobbyOptions lobbyOptions)
bool AddTo(UpdateLobbyOptions lobbyOptions)
Adds the required data to UpdateLobbyOptions
, which must be sent to the Unity lobby.
Public Fields
DirectAddressBookEntry? TashiRelay
DirectAddressBookEntry? TashiRelay
An optional DirectAddressBookEntry
that specifies the address of an allocated Tashi Relay server. This is provided by the initial session host. A Tashi Relay isn't always necessary, but it can aid in bypassing NAT and firewalls for many players.
AddressBookEntry? AddressBookEntry
AddressBookEntry? AddressBookEntry
The local AddressBookEntry
that will enable other players to attempt a connection.