Zone Class Reference

Zone manager. More...

Inherits MonoBehaviour.

Public Member Functions
ZonePlayer	GetPlayer (int peerIndex)
	Gets the player with the given peer index. More...
ZonePlayer	GetPlayer (string playerId)
	Gets the player with the given player ID. More...
ZonePlayer	GetPlayer (GameObject avatar)
	Gets the player with the given avatar. More...
void	Shutdown ()
	Shutdown this zone server. More...

Public Attributes
const float	MusicFadeLength = 1f
	The amount of time it takes music to fade in and out. More...
GameObject	PlayerAvatarPrefab
	The avatar prefab to spawn for all players. More...
ZoneCheckpoint	DefaultCheckpoint
	The default checkpoint of this zone. More...
AudioClip	ZoneBGM
	The default checkpoint of this zone. More...

Properties
static Zone	Instance [get]
	Gets the sole instance of the zone. More...
ZonePlayer[]	Players [get]
	Gets an array of all players in this zone. More...
ZonePlayer	LocalPlayer [get]
	Gets the local player. More...
GameObject[]	Avatars [get]
	Gets an array containing the avatars of all players in the zone. More...
GameObject	LocalAvatar [get]
	Gets the avatar of the local player. More...
int[]	PlayerPeerIndices [get]
	Gets an array containing the peer indices of all players in the zone. More...
string[]	PlayerIDs [get]
	Gets an array containing the player IDs of all players in the zone. More...
PlayerProfile[]	PlayerProfiles [get]
	Gets an array containing the profiles of all players in the zone. More...
string[]	PlayerNicknames [get]
	Gets an array containing the nicknames of all players in the zone. More...
int	NumPlayers [get]
	Gets the number of players in the zone. More...
string	ServerTime [get]

Detailed Description

Zone manager.

Definition at line 30 of file Zone.cs.

Member Function Documentation

ZonePlayer Zone.GetPlayer ( int  peerIndex )

inline

Gets the player with the given peer index.

Definition at line 277 of file Zone.cs.

ZonePlayer Zone.GetPlayer ( string  playerId )

inline

Gets the player with the given player ID.

Definition at line 290 of file Zone.cs.

ZonePlayer Zone.GetPlayer ( GameObject  avatar )

inline

Gets the player with the given avatar.

Definition at line 303 of file Zone.cs.

void Zone.Shutdown ( )

inline

Shutdown this zone server.

Definition at line 316 of file Zone.cs.

Member Data Documentation

ZoneCheckpoint Zone.DefaultCheckpoint

The default checkpoint of this zone.

Definition at line 132 of file Zone.cs.

const float Zone.MusicFadeLength = 1f

The amount of time it takes music to fade in and out.

Definition at line 35 of file Zone.cs.

GameObject Zone.PlayerAvatarPrefab

The avatar prefab to spawn for all players.

Definition at line 128 of file Zone.cs.

AudioClip Zone.ZoneBGM

The default checkpoint of this zone.

Definition at line 136 of file Zone.cs.

Property Documentation

GameObject [] Zone.Avatars

get

Gets an array containing the avatars of all players in the zone.

Definition at line 65 of file Zone.cs.

Zone Zone.Instance

staticget

Gets the sole instance of the zone.

Definition at line 41 of file Zone.cs.

GameObject Zone.LocalAvatar

get

Gets the avatar of the local player.

Definition at line 73 of file Zone.cs.

ZonePlayer Zone.LocalPlayer

get

Gets the local player.

Definition at line 57 of file Zone.cs.

int Zone.NumPlayers

get

Gets the number of players in the zone.

Definition at line 119 of file Zone.cs.

string [] Zone.PlayerIDs

get

Gets an array containing the player IDs of all players in the zone.

Definition at line 95 of file Zone.cs.

string [] Zone.PlayerNicknames

get

Gets an array containing the nicknames of all players in the zone.

Definition at line 111 of file Zone.cs.

int [] Zone.PlayerPeerIndices

get

Gets an array containing the peer indices of all players in the zone.

Definition at line 87 of file Zone.cs.

PlayerProfile [] Zone.PlayerProfiles

get

Gets an array containing the profiles of all players in the zone.

Definition at line 103 of file Zone.cs.

ZonePlayer [] Zone.Players

get

Gets an array of all players in this zone.

Definition at line 49 of file Zone.cs.

---

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

• C:/Users/Dan/Documents/Doomsday/Liberi/Assets/Scripts/Core/Zone.cs