PlayerRef Struct Reference

Represents a Fusion player. More...

Inherits INetworkStruct.

Public Member Functions
override readonly bool	Equals (object obj)
	Determines whether the specified object is equal to the current object.
readonly bool	Equals (PlayerRef other)
	Determines whether the specified PlayerRef is equal to the current PlayerRef.
override readonly int	GetHashCode ()
	Serves as the default hash function.
override readonly string	ToString ()
	Returns a string that represents the current object.

Static Public Member Functions
static PlayerRef	FromEncoded (int encoded)
	Creates a new PlayerRef from the given encoded value. Same as FromRaw.
static PlayerRef	FromIndex (int index)
	Creates a new PlayerRef from the given index.
static PlayerRef	FromRaw (int raw)
	Creates a new PlayerRef from the given raw value. Same as FromEncoded.
static bool	operator!= (PlayerRef a, PlayerRef b)
	Determines whether two PlayerRef instances are not equal.
static bool	operator== (PlayerRef a, PlayerRef b)
	Determines whether two PlayerRef instances are equal.
static unsafe PlayerRef	Read (NetBitBuffer *buffer)
	Reads a PlayerRef from the provided NetBitBuffer.
static unsafe void	Write (NetBitBuffer *buffer, PlayerRef playerRef)
	Writes the PlayerRef to the provided NetBitBuffer.
static unsafe void	Write< T > (T *buffer, PlayerRef playerRef)
	Writes the PlayerRef to the provided buffer.

Static Public Attributes
const int	MASTER_CLIENT_RAW = -1
	A constant representing the raw index value for the master client.

Properties
readonly int	AsIndex [get]
	Returns the PlayerRef int as an integer Id value.
static IEqualityComparer< PlayerRef >	Comparer = new IndexEqualityComparer() [get]
	Gets an equality comparer that can be used to compare two PlayerRef instances.
static PlayerRef	InternalMasterClientIdentifier [get]
	Special master client player ref value of -1. This is not a valid PlayerRef value in itself, and no Runner will ever be assigned this value as its LocalPlayer. It is used by properties like Object.StateAuthority to indicate that the MasterClient has authority To get the current master client PlayerRef use NetworkRunner.GetMasterClient.
static PlayerRef	Invalid [get]
	Invalid player ref. Used to differentiate no player ref (None) from an invalid one.
readonly bool	IsInternalMasterClientIdentifier [get]
	Returns true if this PlayerRef indicates the MasterClient rather than a specific Player by Index, This is a special flag value which has the encoded index value of -2 (internal raw backing value of -1). This is not a valid PlayerRef value in itself, and no Runner will ever be assigned this value as its LocalPlayer. It is used by properties like Object.StateAuthority to indicate that the MasterClient has authority (which ever player that currently is), rather than a specific Player.
readonly bool	IsInvalid [get]
	Returns true if this PlayerRef has an invalid value.
readonly bool	IsMasterClient [get]
readonly bool	IsNone [get]
	Returns true if the index value equals -1 (internal raw value of 0), indicating no player.
readonly bool	IsRealPlayer [get]
	If this player ref is a valid unique player index.
static PlayerRef	MasterClient [get]
static PlayerRef	None [get]
	None player.
readonly int	PlayerId [get]
	Returns the PlayerRef as an integer Id value.
readonly int	RawEncoded [get]
	Returns the index backing value without modification. Unlike AsIndex which returns the backing value - 1.

Detailed Description

Represents a Fusion player.

The PlayerRef, in contrast to the player index, is 1-based. The reason is that default(PlayerRef) will return a "null/invalid" player ref struct for convenience. There are automatic cast operators that can cast an int into a PlayerRef.

default(PlayerRef), internally a 0, means NOBODY
PlayerRef, internally 1, is the same as player index 0
PlayerRef, internally 2, is the same as player index 1

Member Function Documentation

Equals() [1/2]

override readonly bool Equals

(

object

obj

)

Determines whether the specified object is equal to the current 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.

Equals() [2/2]

readonly bool Equals

(

PlayerRef

other

)

Determines whether the specified PlayerRef is equal to the current PlayerRef.

Parameters

other

The PlayerRef to compare with the current PlayerRef.

Returns

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

FromEncoded()

PlayerRef FromEncoded ( int encoded )

static

Creates a new PlayerRef from the given encoded value. Same as FromRaw.

Parameters

encoded

The encoded value to create the PlayerRef from.

Returns

A new PlayerRef that represents the encoded value.

FromIndex()

PlayerRef FromIndex ( int index )

static

Creates a new PlayerRef from the given index.

Parameters

index

The index to create the PlayerRef from.

Returns

A new PlayerRef that represents the index.

FromRaw()

PlayerRef FromRaw ( int raw )

static

Creates a new PlayerRef from the given raw value. Same as FromEncoded.

Parameters

raw	The raw value to create the PlayerRef from.

Returns

A new PlayerRef that represents the encoded value.

operator!=()

bool operator!= ( PlayerRef a, PlayerRef b )

static

Determines whether two PlayerRef instances are not equal.

Parameters

a	The first PlayerRef to compare.
b	The second PlayerRef to compare.

Returns

true if the PlayerRefs are not equal; otherwise, false.

operator==()

bool operator== ( PlayerRef a, PlayerRef b )

static

Determines whether two PlayerRef instances are equal.

Parameters

a	The first PlayerRef to compare.
b	The second PlayerRef to compare.

Returns

true if the PlayerRefs are equal; otherwise, false.

Read()

unsafe PlayerRef Read ( NetBitBuffer * buffer )

static

Reads a PlayerRef from the provided NetBitBuffer.

Parameters

buffer

The buffer to read from.

Returns

The PlayerRef read from the buffer.

Write()

unsafe void Write ( NetBitBuffer * buffer, PlayerRef playerRef )

static

Writes the PlayerRef to the provided NetBitBuffer.

Parameters

buffer	The buffer to write to.
playerRef	The PlayerRef to write.

Write< T >()

unsafe void Write< T > ( T * buffer, PlayerRef playerRef )

static

Writes the PlayerRef to the provided buffer.

Template Parameters

T	The type of the buffer. Must be unmanaged and implement INetBitWriteStream.

Parameters

buffer	The buffer to write to.
playerRef	The PlayerRef to write.

Type Constraints

T	:	unmanaged
T	:	INetBitWriteStream

Property Documentation

AsIndex

readonly int AsIndex

get

Returns the PlayerRef int as an integer Id value.

-1=None -2=MasterClient >=0=PlayerId

PlayerId

readonly int PlayerId

get

Returns the PlayerRef as an integer Id value.

-1=None -2=MasterClient

RawEncoded

readonly int RawEncoded

get

Returns the index backing value without modification. Unlike AsIndex which returns the backing value - 1.

0=None -1=MasterClient >0=PlayerId