Photon Fusion 2.0.0

Classes | Public Member Functions | Public Attributes | Static Public Attributes | Properties | List of all members
NetworkObjectNestingKey Struct Reference

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

Inherits INetworkStruct, and IEquatable< NetworkObjectNestingKey >.

Classes

class  EqualityComparer
 Implements the IEqualityComparer interface. More...
 

Public Member Functions

bool Equals (NetworkObjectNestingKey other)
 Checks if the current instance of NetworkObjectNestingKey is equal to another instance of the same type.
 
override bool Equals (object obj)
 Checks if the current instance of NetworkObjectNestingKey is equal to another object.
 
override int GetHashCode ()
 Serves as the default hash function.
 
 NetworkObjectNestingKey (int value)
 Initializes a new instance of the NetworkObjectNestingKey struct with a specified value.
 
override 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.
 
const int SIZE = 4
 The size of the NetworkObjectNestingKey in bytes.
 

Properties

bool IsNone [get]
 Checks if the NetworkObjectNestingKey is none.
 
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]

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 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 int GetHashCode ( )

Serves as the default hash function.

Returns
A hash code for the current object.

◆ ToString()

override string ToString ( )

Returns a string that represents the current object.

Returns
A string that represents the current object.

Property Documentation

◆ IsNone

bool IsNone
get

Checks if the NetworkObjectNestingKey is none.

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

◆ IsValid

bool IsValid
get

Checks if the NetworkObjectNestingKey is valid.

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