Photon Fusion 2.0.3

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

Network object header information for a NetworkObject. More...

Inherits INetworkStruct, and IEquatable< NetworkObjectHeader >.

Public Member Functions

bool Equals (NetworkObjectHeader other)
 Checks if the current instance of NetworkObjectHeader is equal to another instance of the same type. More...
 
override bool Equals (object obj)
 Checks if the current instance of NetworkObjectHeader is equal to another object. More...
 
override int GetHashCode ()
 Generates a hash code for the current instance of NetworkObjectHeader. More...
 
override string ToString ()
 The string representation of the NetworkObjectHeader. More...
 

Static Public Member Functions

static int * GetBehaviourChangedTickArray (NetworkObjectHeader *header)
 Returns a pointer to the array of behaviour change ticks in a NetworkObjectHeader. More...
 
static int * GetDataPointer (NetworkObjectHeader *header)
 Returns a pointer to the data of a NetworkObjectHeader. More...
 
static int GetDataWordCount (NetworkObjectHeader *header)
 Returns the count of data words in a NetworkObjectHeader. More...
 
static NetworkTRSPDataGetMainNetworkTRSPData (NetworkObjectHeader *header)
 Returns a pointer to the main network TRSP data of a NetworkObjectHeader, if it exists. More...
 
static bool HasMainNetworkTRSP (NetworkObjectHeader *header)
 Checks if a NetworkObjectHeader has a main network TRSP. More...
 
static bool operator!= (NetworkObjectHeader left, NetworkObjectHeader right)
 Determines if two instances of NetworkObjectHeader are not equal. More...
 
static bool operator== (NetworkObjectHeader left, NetworkObjectHeader right)
 Determines if two instances of NetworkObjectHeader are equal. More...
 

Public Attributes

fixed int _reserved [10]
 Reserved space for future use. More...
 
short BehaviourCount
 The number of behaviours in the network object. More...
 
NetworkObjectHeaderFlags Flags
 The flags indicating various states or properties of the network object. More...
 
NetworkId Id
 The unique identifier of the network object. More...
 
PlayerRef InputAuthority
 The player reference who has input authority over the network object. More...
 
NetworkObjectNestingKey NestingKey
 The nesting key of the network object. More...
 
NetworkId NestingRoot
 The unique identifier of the root network object in the nesting hierarchy. More...
 
PlayerRef StateAuthority
 The player reference who has state authority over the network object. More...
 
NetworkObjectTypeId Type
 The type identifier of the network object. More...
 
short WordCount
 The size of the network object's data in words. More...
 

Static Public Attributes

const int PLAYER_DATA_WORD = 36 / Allocator.REPLICATE_WORD_SIZE
 The word index of the player data in the NetworkObjectHeader. More...
 
const int SIZE = 80
 The size of the NetworkObjectHeader in bytes. More...
 
const int WORDS = SIZE / Allocator.REPLICATE_WORD_SIZE
 The size of the NetworkObjectHeader in words. More...
 

Properties

int ByteCount [get]
 The size of the network object's data in bytes. More...
 

Detailed Description

Network object header information for a NetworkObject.

Member Function Documentation

◆ Equals() [1/2]

bool Equals ( NetworkObjectHeader  other)

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

◆ Equals() [2/2]

override bool Equals ( object  obj)

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

◆ GetBehaviourChangedTickArray()

static int* GetBehaviourChangedTickArray ( NetworkObjectHeader header)
static

Returns a pointer to the array of behaviour change ticks in a NetworkObjectHeader.

Parameters
headerPointer to the NetworkObjectHeader.
Returns
Pointer to the array of behaviour change ticks in the NetworkObjectHeader.

◆ GetDataPointer()

static int* GetDataPointer ( NetworkObjectHeader header)
static

Returns a pointer to the data of a NetworkObjectHeader.

Parameters
headerPointer to the NetworkObjectHeader.
Returns
Pointer to the data of the NetworkObjectHeader.

◆ GetDataWordCount()

static int GetDataWordCount ( NetworkObjectHeader header)
static

Returns the count of data words in a NetworkObjectHeader.

Parameters
headerPointer to the NetworkObjectHeader.
Returns
The count of data words in the NetworkObjectHeader.

◆ GetHashCode()

override int GetHashCode ( )

Generates a hash code for the current instance of NetworkObjectHeader.

◆ GetMainNetworkTRSPData()

static NetworkTRSPData* GetMainNetworkTRSPData ( NetworkObjectHeader header)
static

Returns a pointer to the main network TRSP data of a NetworkObjectHeader, if it exists.

Parameters
headerPointer to the NetworkObjectHeader.
Returns
Pointer to the main network TRSP data of the NetworkObjectHeader if it exists, null otherwise.

◆ HasMainNetworkTRSP()

static bool HasMainNetworkTRSP ( NetworkObjectHeader header)
static

Checks if a NetworkObjectHeader has a main network TRSP.

Parameters
headerPointer to the NetworkObjectHeader.
Returns
True if the NetworkObjectHeader has a main network TRSP, false otherwise.

◆ operator!=()

static bool operator!= ( NetworkObjectHeader  left,
NetworkObjectHeader  right 
)
static

Determines if two instances of NetworkObjectHeader are not equal.

Returns
True if the instances are not equal; otherwise, false.

◆ operator==()

static bool operator== ( NetworkObjectHeader  left,
NetworkObjectHeader  right 
)
static

Determines if two instances of NetworkObjectHeader are equal.

Returns
True if the instances are equal; otherwise, false.

◆ ToString()

override string ToString ( )

The string representation of the NetworkObjectHeader.

Member Data Documentation

◆ _reserved

fixed int _reserved[10]

Reserved space for future use.

◆ BehaviourCount

short BehaviourCount

The number of behaviours in the network object.

◆ Flags

The flags indicating various states or properties of the network object.

◆ Id

The unique identifier of the network object.

◆ InputAuthority

PlayerRef InputAuthority

The player reference who has input authority over the network object.

◆ NestingKey

The nesting key of the network object.

◆ NestingRoot

NetworkId NestingRoot

The unique identifier of the root network object in the nesting hierarchy.

◆ PLAYER_DATA_WORD

const int PLAYER_DATA_WORD = 36 / Allocator.REPLICATE_WORD_SIZE
static

The word index of the player data in the NetworkObjectHeader.

◆ SIZE

const int SIZE = 80
static

The size of the NetworkObjectHeader in bytes.

◆ StateAuthority

PlayerRef StateAuthority

The player reference who has state authority over the network object.

◆ Type

The type identifier of the network object.

◆ WordCount

short WordCount

The size of the network object's data in words.

◆ WORDS

const int WORDS = SIZE / Allocator.REPLICATE_WORD_SIZE
static

The size of the NetworkObjectHeader in words.

Property Documentation

◆ ByteCount

int ByteCount
get

The size of the network object's data in bytes.