Photon Fusion 2.0.3

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

ID for a NetworkObject Prefab which has been cataloged in a NetworkProjectConfig.PrefabTable. More...

Inherits INetworkStruct, IEquatable< NetworkPrefabId >, IComparable, and IComparable< NetworkPrefabId >.

Classes

class  EqualityComparer
 Equality comparer for NetworkPrefabId. More...
 

Public Member Functions

int CompareTo (NetworkPrefabId other)
 Compares the NetworkPrefabId to another NetworkPrefabId. More...
 
int IComparable. CompareTo (object obj)
 Compares the NetworkPrefabId to another object. More...
 
bool Equals (NetworkPrefabId other)
 Checks if the NetworkPrefabId is equal to another NetworkPrefabId. More...
 
override bool Equals (object obj)
 Checks if the NetworkPrefabId is equal to another object. More...
 
override int GetHashCode ()
 Gets the hash code of the NetworkPrefabId. More...
 
override string ToString ()
 Converts the NetworkPrefabId to a string. More...
 
string ToString (bool brackets, bool prefix)
 Converts the NetworkPrefabId to a string with optional brackets and prefix. More...
 

Static Public Member Functions

static NetworkPrefabId FromIndex (int index)
 Creates a NetworkPrefabId from an index. More...
 
static NetworkPrefabId FromRaw (uint value)
 Creates a NetworkPrefabId from a raw value. More...
 
static bool operator!= (NetworkPrefabId a, NetworkPrefabId b)
 Checks if two NetworkPrefabId are not equal. More...
 
static bool operator== (NetworkPrefabId a, NetworkPrefabId b)
 Checks if two NetworkPrefabId are equal. More...
 

Public Attributes

uint RawValue
 The raw value of the NetworkPrefabId. More...
 

Static Public Attributes

const int ALIGNMENT = 4
 The alignment of a NetworkPrefabId. More...
 
const int MAX_INDEX = int.MaxValue - 1
 The maximum index value of a NetworkPrefabId. More...
 
const int SIZE = 4
 The size of a NetworkPrefabId. More...
 

Properties

int AsIndex [get]
 Converts the NetworkPrefabId to an index. More...
 
bool IsNone [get]
 Checks if the NetworkPrefabId is none. More...
 
bool IsValid [get]
 Checks if the NetworkPrefabId is valid. More...
 

Detailed Description

ID for a NetworkObject Prefab which has been cataloged in a NetworkProjectConfig.PrefabTable.

Member Function Documentation

◆ CompareTo() [1/2]

int CompareTo ( NetworkPrefabId  other)

Compares the NetworkPrefabId to another NetworkPrefabId.

◆ CompareTo() [2/2]

int IComparable. CompareTo ( object  obj)

Compares the NetworkPrefabId to another object.

◆ Equals() [1/2]

bool Equals ( NetworkPrefabId  other)

Checks if the NetworkPrefabId is equal to another NetworkPrefabId.

◆ Equals() [2/2]

override bool Equals ( object  obj)

Checks if the NetworkPrefabId is equal to another object.

◆ FromIndex()

static NetworkPrefabId FromIndex ( int  index)
static

Creates a NetworkPrefabId from an index.

◆ FromRaw()

static NetworkPrefabId FromRaw ( uint  value)
static

Creates a NetworkPrefabId from a raw value.

◆ GetHashCode()

override int GetHashCode ( )

Gets the hash code of the NetworkPrefabId.

◆ operator!=()

static bool operator!= ( NetworkPrefabId  a,
NetworkPrefabId  b 
)
static

Checks if two NetworkPrefabId are not equal.

◆ operator==()

static bool operator== ( NetworkPrefabId  a,
NetworkPrefabId  b 
)
static

Checks if two NetworkPrefabId are equal.

◆ ToString() [1/2]

override string ToString ( )

Converts the NetworkPrefabId to a string.

◆ ToString() [2/2]

string ToString ( bool  brackets,
bool  prefix 
)

Converts the NetworkPrefabId to a string with optional brackets and prefix.

Member Data Documentation

◆ ALIGNMENT

const int ALIGNMENT = 4
static

The alignment of a NetworkPrefabId.

◆ MAX_INDEX

const int MAX_INDEX = int.MaxValue - 1
static

The maximum index value of a NetworkPrefabId.

◆ RawValue

uint RawValue

The raw value of the NetworkPrefabId.

◆ SIZE

const int SIZE = 4
static

The size of a NetworkPrefabId.

Property Documentation

◆ AsIndex

int AsIndex
get

Converts the NetworkPrefabId to an index.

◆ IsNone

bool IsNone
get

Checks if the NetworkPrefabId is none.

◆ IsValid

bool IsValid
get

Checks if the NetworkPrefabId is valid.