Interface INetworkSystem
Interface that allows functionality for clients to communicate over the network
Inherited Members
Namespace: Ride.Networking
Assembly: cs.temp.dll.dll
Syntax
public interface INetworkSystem : IRideSystem, IApiInject, IIdentity
Properties
Name | Description |
---|---|
currentRoom | The current networked room that you are in. Null if you are not in a room |
isConnected | Returns true if the client is ready for match making. This does not mean that the client is in a game |
isInRoom | True if the local player is in a networked room |
isMasterClient | True if this machine is the master client in a network room |
isServer | True if this instance is the server |
localPlayer | The networked player this machine represents |
networkClientState | The current connection state of this machine |
numPlayers | The number of players in the room or the lobby |
numPlayersInRooms | The number of players in network rooms |
numPlayersLookingForRooms | The number of players in the lobby that haven't joined a room |
numRooms | The number of network rooms created |
onConnect | Listeners that are invoked after successfully connecting to the network via Connect() |
onDisconnect | Listeners that are invoked after successfully connecting to the network via Disconnect() |
onEventRaised | Listeners that are invoked after successfully joining a network room via RaiseEvent() |
onInput_Fusion | |
onJoinRoom | Listeners that are invoked after successfully joining a network room via CreateRoom() or JoinRoom() |
onJoinRoom_Fusion | Listeners that are invoked after successfully joining a network room via CreateRoom() or JoinRoom() |
onLeaveRoom | Listeners that are invoked after successfully joining a network room via CreateRoom() or JoinRoom() |
onMasterClientSwitched | Listeners that are invoked when switching to a new MasterClient when the current one leaves. |
onPlayerEnterRoom | Listeners that are invoked after a remote player enters the room. |
onPlayerLeaveRoom | Listeners that are invoked after a remote player leaves the room. |
onSetupNetworkAgent | Listeners that are invoked after successfully joining a network room via CreateRoom() or JoinRoom(). Invoked after onJoinRoom |
playerNickName | The local player's nickname so that other clients know who they are |
rooms | The list of network rooms |
Methods
Name | Description |
---|---|
AddNetworkAgent(RideID, NetworkAgent) | |
CalculateRoomPing(String) | Calculates and returns the latency of the room in ms |
Connect() | Connect to the network |
CreateNetworkObject(PlayerRef, String, RideVector3, RideQuaternion) | Create an object in Fusion Network |
CreateNetworkObject(Unit) | Create an agent that sends data across the network |
CreateNetworkObject(String, RideVector3, RideQuaternion) | Create an object that sends data across the network |
CreateNetworkRoomObject(String, RideVector3, RideQuaternion) | Create an object that sends data across the network. This object has the lifetime of the room and exists even after the creator leaves the room. |
CreateRoom(SessionRequest) | Creates a networked session in Fusion environment. (Session is equivalent to room in PUN) |
CreateRoom(String) | Creates a networked room for clients to join |
Disconnect() | Disconnect from the network |
DoesRideIDPlayeridMappingExist(Int32) | Tests if there is a RideID associated with the network player id |
DoesRideIDViewMappingExist(Int32) | Tests if there is a RideID associated with the network view id |
GetNetworkAgent(RideID) | |
GetNetworkTime() | The current amount of network time that has passed. This time is mostly identical across all connected clients |
GetPing() | Returns current round trip time in milliseconds to the server and back. |
GetPlayerFromRideID(RideID) | Returns the unique network player id associated with the TSSid |
GetRideIDFromPlayer(Int32) | Returns the RideID associated with the network player id. |
GetRideIDFromView(Int32) | The RideID associated with the view id |
GetRoomCustomProperty<T>(String, String) | Returns a network synced property value of the room |
GetViewFromRideID(RideID) | Returns the unique network view id associated with the TSSid |
IsNetworkAgent(RideID) | |
JoinLobby() | Join the lobby to see the available rooms |
JoinRoom(String) | Makes a request for the local player to join a networked room. If successful, OnJoinedRoom is dispatched |
LeaveLobby() | Leave the lobby |
LeaveRoom() | The local player leaves their current rroom |
RaiseEvent(Byte, RaiseEventOptions, SendOptions, Object[]) | Dispatch an event across the network |
RegisterExistingPlayers() | Intended for Fusion only. Register existing players in current room |
SetRoomCustomProperty(String, Boolean) | Sets a value on a networ room that is automatically synced over the network |
SetRoomCustomProperty(String, Int32) | Sets a value on a networ room that is automatically synced over the network |
SetRoomCustomProperty(String, Single) | Sets a value on a networ room that is automatically synced over the network |
SetRoomCustomProperty(String, String) | Sets a value on a networ room that is automatically synced over the network |
SetupNetworkObject(IAgent) | Performs TSS setup on the networked agent |