Photon Fusion 2.1.1

Tick Struct Reference

A tick is a 32-bit integer that represents a frame number. More...

Inherits INetworkStruct.

Classes

class  EqualityComparer
 Provides a mechanism for comparing two Tick objects for equality. More...
class  RelationalComparer
 Provides a mechanism for comparing two Tick objects. More...

Public Member Functions

int CompareTo (Tick other)
 Compares the current Tick with another Tick.
override readonly bool Equals (object obj)
 Determines whether the specified object is equal to the current Tick.
readonly bool Equals (Tick other)
 Determines whether the specified Tick is equal to the current Tick.
override readonly int GetHashCode ()
 Serves as the default hash function.
Tick Next (int increment)
 Returns the next Tick, incremented by a specified value.
override readonly string ToString ()
 String representation of the Tick.

Static Public Member Functions

static implicit operator bool (Tick value)
 Converts a Tick to a boolean.
static implicit operator int (Tick value)
 Converts a Tick to an integer.
static implicit operator Tick (int value)
 Converts an integer to a Tick.
static operator uint (Tick value)
 Converts a Tick to an integer.
static bool operator!= (Tick a, Tick b)
 Determines whether the first specified Tick is not equal to the second specified Tick.
static bool operator< (Tick a, Tick b)
 Determines whether the first specified Tick is less than the second specified Tick.
static bool operator<= (Tick a, Tick b)
 Determines whether the first specified Tick is less than or equal to the second specified Tick.
static bool operator== (Tick a, Tick b)
 Determines whether the first specified Tick is equal to the second specified Tick.
static bool operator> (Tick a, Tick b)
 Determines whether the first specified Tick is greater than the second specified Tick.
static bool operator>= (Tick a, Tick b)
 Determines whether the first specified Tick is greater than or equal to the second specified Tick.

Public Attributes

int Raw
 The raw value of the Tick. This represents a frame number.

Static Public Attributes

const int ALIGNMENT = 4
 The alignment of the Tick structure in bytes.

Detailed Description

A tick is a 32-bit integer that represents a frame number.

Member Function Documentation

◆ CompareTo()

int CompareTo ( Tick other)

Compares the current Tick with another Tick.

Parameters
otherA Tick to compare with this Tick.
Returns
A value that indicates the relative order of the objects being compared.

◆ Equals() [1/2]

override readonly bool Equals ( object obj)

Determines whether the specified object is equal to the current Tick.

Parameters
objThe object to compare with the current Tick.
Returns
true if the specified object is equal to the current Tick; otherwise, false.

◆ Equals() [2/2]

readonly bool Equals ( Tick other)

Determines whether the specified Tick is equal to the current Tick.

Parameters
otherThe Tick to compare with the current Tick.
Returns
true if the specified Tick is equal to the current Tick; otherwise, false.

◆ GetHashCode()

override readonly int GetHashCode ( )

Serves as the default hash function.

Returns
A hash code for the current Tick.

◆ Next()

Tick Next ( int increment)

Returns the next Tick, incremented by a specified value.

Parameters
incrementThe value to increment the Tick by.
Returns
A new Tick that represents the current Tick incremented by the specified value.

◆ operator bool()

implicit operator bool ( Tick value)
static

Converts a Tick to a boolean.

Parameters
valueThe Tick to convert.
Returns
true if the Tick's raw value is greater than 0; otherwise, false.

◆ operator int()

implicit operator int ( Tick value)
static

Converts a Tick to an integer.

Parameters
valueThe Tick to convert.
Returns
An integer that represents the raw value of the specified Tick.

◆ operator Tick()

implicit operator Tick ( int value)
static

Converts an integer to a Tick.

Parameters
valueThe integer to convert.
Returns
A Tick that represents the specified integer. If the integer is less than 0, the Tick's raw value is set to 0.

◆ operator uint()

operator uint ( Tick value)
explicitstatic

Converts a Tick to an integer.

Parameters
valueThe Tick to convert.
Returns
An integer that represents the raw value of the specified Tick.