Class NetworkTickSystem

Provides discretized time. This is useful for games that require ticks happening at regular interval on the server and clients.

Inheritance

object

NetworkTickSystem

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Netcode

Assembly: Unity.Netcode.Runtime.dll

Syntax

public class NetworkTickSystem

Constructors

NetworkTickSystem(uint, double, double)

Creates a new instance of the NetworkTickSystem class.

Declaration

public NetworkTickSystem(uint tickRate, double localTimeSec, double serverTimeSec)

Parameters

Type	Name	Description
uint	tickRate	The tick rate
double	localTimeSec	The initial local time to start at.
double	serverTimeSec	The initial server time to start at.

Fields

NoTick

Special value to indicate "No tick information"

Declaration

public const int NoTick = -2147483648

Field Value

Type	Description
int

Properties

LocalTime

The current local time. This is the time at which predicted or client authoritative objects move. This value is accurate when called in Update or during the Tick event but does not work correctly for FixedUpdate.

Declaration

public NetworkTime LocalTime { get; }

Property Value

Type	Description
NetworkTime

ServerTime

The current server time. This value is mostly used for internal purposes and to interpolate state received from the server. This value is accurate when called in Update or during the Tick event but does not work correctly for FixedUpdate.

Declaration

public NetworkTime ServerTime { get; }

Property Value

Type	Description
NetworkTime

TickRate

The TickRate of the tick system. This is used to decide how often a fixed network tick is run.

Declaration

public uint TickRate { get; }

Property Value

Type	Description
uint

Methods

Reset(double, double)

Resets the tick system to the given network time.

Declaration

public void Reset(double localTimeSec, double serverTimeSec)

Parameters

Type	Name	Description
double	localTimeSec	The local time in seconds.
double	serverTimeSec	The server time in seconds.

UpdateTick(double, double)

Called after advancing the time system to run ticks based on the difference in time.

Declaration

public void UpdateTick(double localTimeSec, double serverTimeSec)

Parameters

Type	Name	Description
double	localTimeSec	The local time in seconds
double	serverTimeSec	The server time in seconds

Events

Tick

Gets invoked before every network tick.

Declaration

public event Action Tick

Event Type

Type	Description
Action