Photon Fusion 2.1.1

NetworkObjectNestingKey Struct Reference

A key used to identify a network object nesting. More...

Inherits INetworkStruct.

Classes

class  EqualityComparer
 Implements the IEqualityComparer interface. More...

Public Member Functions

readonly bool Equals (NetworkObjectNestingKey other)
 Checks if the current instance of NetworkObjectNestingKey is equal to another instance of the same type.
override readonly bool Equals (object obj)
 Checks if the current instance of NetworkObjectNestingKey is equal to another object.
override readonly int GetHashCode ()
 Serves as the default hash function.
 NetworkObjectNestingKey (int value)
 Initializes a new instance of the NetworkObjectNestingKey struct with a specified value.
override readonly string ToString ()
 Returns a string that represents the current object.

Public Attributes

int Value
 The value of the NetworkObjectNestingKey.

Static Public Attributes

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

Properties

readonly bool IsNone [get]
 Checks if the NetworkObjectNestingKey is none.
readonly bool IsValid [get]
 Checks if the NetworkObjectNestingKey is valid.

Detailed Description

A key used to identify a network object nesting.

Constructor & Destructor Documentation

◆ NetworkObjectNestingKey()

NetworkObjectNestingKey ( int value)

Initializes a new instance of the NetworkObjectNestingKey struct with a specified value.

Parameters
valueThe value of the NetworkObjectNestingKey.

Member Function Documentation

◆ Equals() [1/2]

readonly bool Equals ( NetworkObjectNestingKey other)

Checks if the current instance of NetworkObjectNestingKey is equal to another instance of the same type.

Parameters
otherAn instance of NetworkObjectNestingKey to compare with the current instance.
Returns
True if the current instance is equal to the other parameter; otherwise, false.

◆ Equals() [2/2]

override readonly bool Equals ( object obj)

Checks if the current instance of NetworkObjectNestingKey is equal to another object.

Parameters
objAn object to compare with the current instance.
Returns
True if the current instance is equal to the obj parameter; otherwise, false.

◆ GetHashCode()

override readonly int GetHashCode ( )

Serves as the default hash function.

Returns
A hash code for the current object.

◆ ToString()

override readonly string ToString ( )

Returns a string that represents the current object.

Returns
A string that represents the current object.

Property Documentation

◆ IsNone

readonly bool IsNone
get

Checks if the NetworkObjectNestingKey is none.

Returns
True if the value of the NetworkObjectNestingKey is 0; otherwise, false.

◆ IsValid

readonly bool IsValid
get

Checks if the NetworkObjectNestingKey is valid.

Returns
True if the value of the NetworkObjectNestingKey is greater than 0; otherwise, false.