BBPGlue.API.BBPPlayerRef Class Reference

Reference wrapper for a player instance exposing common transforms and actions. More...

Public Member Functions
	BBPPlayerRef (object raw)
	Initializes a new wrapper around the supplied raw player object.
void	ClearGuilt ()
	Clears the player's guilt state.
void	Reverse ()
	Reverses the player's facing or movement state (game-specific behavior).
void	SetHidden (bool hidden)
	Sets the player's hidden state.
void	SetNametag (bool state)
	Enables or disables the player's nametag.
void	Teleport (Vector3 position)
	Teleports the player to the supplied world position.

Properties
Component?	Component [get]
	The Unity component associated with the player, if any.
BBPEntity	Entity [get]
	The entity wrapper associated with this player.
GameObject?	GameObject [get]
	The Unity GameObject representing the player, if available.
bool	Invincible [get, set]
	Whether the player is currently invincible.
bool	Invisible [get]
	Whether the player is invisible.
int	PlayerNumber [get, set]
	The player index number.
Vector3	Position [get]
	The world position of the player, or Vector3.zero when unavailable.
object	Raw [get]
	The underlying raw player object.
string	RuleBreakText [get]
	Text describing the last rule break by the player.
bool	Tagged [get]
	Whether the player is tagged.
Transform?	Transform [get]
	The Unity Transform of the player, if available.

Detailed Description

Reference wrapper for a player instance exposing common transforms and actions.

Constructor & Destructor Documentation

BBPPlayerRef()

BBPGlue.API.BBPPlayerRef.BBPPlayerRef

(

object

raw

)

Initializes a new wrapper around the supplied raw player object.

Parameters

raw	The raw player object to wrap.

Member Function Documentation

ClearGuilt()

void BBPGlue.API.BBPPlayerRef.ClearGuilt

(

)

Clears the player's guilt state.

Reverse()

void BBPGlue.API.BBPPlayerRef.Reverse

(

)

Reverses the player's facing or movement state (game-specific behavior).

SetHidden()

void BBPGlue.API.BBPPlayerRef.SetHidden

(

bool

hidden

)

Sets the player's hidden state.

Parameters

hidden

True to hide the player; otherwise false.

SetNametag()

void BBPGlue.API.BBPPlayerRef.SetNametag

(

bool

state

)

Enables or disables the player's nametag.

Parameters

state

True to show the nametag; false to hide it.

Teleport()

void BBPGlue.API.BBPPlayerRef.Teleport

(

Vector3

position

)

Teleports the player to the supplied world position.

Parameters

position

Destination position.

Property Documentation

Component

Component? BBPGlue.API.BBPPlayerRef.Component

get

The Unity component associated with the player, if any.

Entity

BBPEntity BBPGlue.API.BBPPlayerRef.Entity

get

The entity wrapper associated with this player.

GameObject

GameObject? BBPGlue.API.BBPPlayerRef.GameObject

get

The Unity GameObject representing the player, if available.

Invincible

bool BBPGlue.API.BBPPlayerRef.Invincible

getset

Whether the player is currently invincible.

Invisible

bool BBPGlue.API.BBPPlayerRef.Invisible

get

Whether the player is invisible.

PlayerNumber

int BBPGlue.API.BBPPlayerRef.PlayerNumber

getset

The player index number.

Position

Vector3 BBPGlue.API.BBPPlayerRef.Position

get

The world position of the player, or Vector3.zero when unavailable.

Raw

object BBPGlue.API.BBPPlayerRef.Raw

get

The underlying raw player object.

RuleBreakText

string BBPGlue.API.BBPPlayerRef.RuleBreakText

get

Text describing the last rule break by the player.

Tagged

bool BBPGlue.API.BBPPlayerRef.Tagged

get

Whether the player is tagged.

Transform

Transform? BBPGlue.API.BBPPlayerRef.Transform

get

The Unity Transform of the player, if available.

---

The documentation for this class was generated from the following file:

• BBPPlayerRef.cs