NetworkId Struct Reference

The unique identifier for a network entity. More...

Inherits INetworkStruct.

Classes
class	EqualityComparer
	IEqualityComparer interface for NetworkId objects. More...

Public Member Functions
int	CompareTo (NetworkId other)
	Compares the current NetworkId object with another NetworkId object.
readonly bool	Equals (NetworkId other)
	Determines whether the current NetworkId object is equal to another NetworkId object.
override readonly bool	Equals (object obj)
	Determines whether the specified object is equal to the current NetworkId object.
override readonly int	GetHashCode ()
	Get the hash code for this NetworkId.
string	ToNamePrefixString ()
	String conversion specifically for use in prefixing names of GameObjects.
override readonly string	ToString ()
	String representation of the NetworkId.
void	Write (NetBitBuffer *buffer)
	Writes this NetworkId to the provided NetBitBuffer.

Static Public Member Functions
static NetworkId	FromRaw (uint value)
	Creates a new instance from raw value.
static implicit	operator bool (NetworkId id)
	Converts the NetworkId object to a boolean value.
static bool	operator!= (NetworkId a, NetworkId b)
	Determines whether two NetworkId objects are not equal.
static bool	operator== (NetworkId a, NetworkId b)
	Determines whether two NetworkId objects are equal.
static NetworkId	Read (NetBitBuffer *buffer)
	Reads a NetworkId from the provided NetBitBuffer.
static void	Write (NetBitBuffer *buffer, NetworkId id)
	Writes the NetworkId to the provided NetBitBuffer.

Public Attributes
uint	Raw
	The raw value of the network id.

Static Public Attributes
const int	ALIGNMENT = 4
	The alignment of the network id in bytes.
const int	BLOCK_SIZE = 8
	The size of the network id block in bytes.

Properties
static EqualityComparer	Comparer = new EqualityComparer() [get]
	The IEqualityComparer for NetworkId objects.
readonly bool	IsReserved [get]
	Signal if the network id is reserved.
readonly bool	IsValid [get]
	Signal if the network id is valid.

Detailed Description

The unique identifier for a network entity.

Member Function Documentation

CompareTo()

int CompareTo

(

NetworkId

other

)

Compares the current NetworkId object with another NetworkId object.

Parameters

other

A NetworkId object to compare with this object.

Returns

A value that indicates the relative order of the objects being compared.

Equals() [1/2]

readonly bool Equals

(

NetworkId

other

)

Determines whether the current NetworkId object is equal to another NetworkId object.

Parameters

other

A NetworkId object to compare with this object.

Returns

true if the current object is equal to the other parameter; otherwise, false.

Equals() [2/2]

override readonly bool Equals

(

object

obj

)

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

Parameters

obj	The object to compare with the current object.

Returns

true if the specified object is equal to the current object; otherwise, false.

FromRaw()

NetworkId FromRaw ( uint value )

static

Creates a new instance from raw value.

Parameters

value

Returns

Read()

NetworkId Read ( NetBitBuffer * buffer )

static

Reads a NetworkId from the provided NetBitBuffer.

Parameters

buffer

The buffer to read the NetworkId from.

Returns

The NetworkId read from the buffer.

Write() [1/2]

void Write

(

NetBitBuffer *

buffer

)

Writes this NetworkId to the provided NetBitBuffer.

Parameters

buffer

The buffer to write this NetworkId to.

Write() [2/2]

void Write ( NetBitBuffer * buffer, NetworkId id )

static

Writes the NetworkId to the provided NetBitBuffer.

Parameters

buffer	The buffer to write the NetworkId to.
id	The NetworkId to write.