Beamable.Experimental.Api.Sim.SimNetworkInterface Interface Reference

This type defines the SimNetworkInterface for the Multiplayer feature. More...

Inheritance diagram for Beamable.Experimental.Api.Sim.SimNetworkInterface:

Public Member Functions
List< SimFrame >	Tick (long curFrame, long maxFrame, long expectedMaxFrame)
	Synchronize the network interface and receive any fully realized frames by the network More...
void	SendEvent (SimEvent evt)
	Push (or queue) an event onto the network More...

Properties
string	ClientId [get]
	Get a unique id for the client which is consistent across the network. Often, this will be the gamertag of the client's player.
bool	Ready [get]
	Is the network ready to operate?

Detailed Description

This type defines the SimNetworkInterface for the Multiplayer feature.

This guarantees that a given frame will only be sent to peers a maximum of 1 time and that a given frame will be surfaced to the SimClient a maximum of 1 time

Related Links

• See Beamable.Experimental.Api.Sim.SimClient script reference

Member Function Documentation

SendEvent()

void Beamable.Experimental.Api.Sim.SimNetworkInterface.SendEvent

(

SimEvent

evt

)

Push (or queue) an event onto the network

Parameters

evt	A SimEvent

Implemented in Beamable.Experimental.Api.Sim.SimNetworkEventStream, and Beamable.Experimental.Api.Sim.SimNetworkLocal.

Tick()

List< SimFrame > Beamable.Experimental.Api.Sim.SimNetworkInterface.Tick	(	long	curFrame,
		long	maxFrame,
		long	expectedMaxFrame
	)

Synchronize the network interface and receive any fully realized frames by the network

Parameters

curFrame
maxFrame
expectedMaxFrame

Returns

Implemented in Beamable.Experimental.Api.Sim.SimNetworkEventStream, and Beamable.Experimental.Api.Sim.SimNetworkLocal.

---

The documentation for this interface was generated from the following file:

• com.beamable/Runtime/Core/Platform/SDK/Sim/SimNetworkInterface.cs