FrameworkZ::Players Class Reference

Players module for FrameworkZ. Defines and interacts with PLAYER object. More...

Public Member Functions
void	CreateCharacter (username, characterData, characterID)
void	DeleteCharacter (username, character)
void	DeleteCharacterByID (username, characterID)
void	Destroy (username)
table	GetCharacterDataByID (username, characterID)
	Gets saved character data by their ID.
void	GetLoadedCharacterByID (username)
void	GetNextCharacterID (username)
object	GetPlayerByID (username)
	Gets the player object by their username.
void	Initialize (isoPlayer)
void	LoadCharacter (_data, username, characterID)
void	LoadCharacter (username, characterData, survivorDescriptor, loadCharacterStartTime)
void	LoadCharacterByID (username, characterID)
void	New (isoPlayer)
void	OnCreateCharacter (data, username, characterData)
void	OnFillWorldObjectContextMenu (playerNumber, context, worldObjects, test)
void	OnInitGlobalModData (isNewGame)
void	OnLoadCharacter (data, characterID)
void	OnLoadCharacter (username, characterID)
void	OnPostLoadCharacter (isoPlayer, player, character, characterData)
void	OnPreLoadCharacter (isoPlayer, player, character, characterData)
void	OnStorageSet (isoPlayer, command, namespace, keys, value)
void	ResetCharacterSaveInterval ()
boolean	Save (username, continueOnFailure)
	Saves the player and their currently loaded character.
void	SaveCharacter (username, character)
void	SaveCharacterByID (username, characterID)
void	StartPlayerTick (player)

Data Fields
	Admin
FrameworkZ Players	List
	List of all instanced players in the game.
	Moderator
	Operator
	Owner
FrameworkZ	Players
FrameworkZ Players	Roles
	Roles for players in FrameworkZ.
	Super_Admin
	User

Detailed Description

Players module for FrameworkZ. Defines and interacts with PLAYER object.

Definition at line 13 of file Players.lua.

Member Function Documentation

CreateCharacter()

void CreateCharacter	(	username	,
		characterData	,
		characterID	)

DeleteCharacter()

void DeleteCharacter	(	username	,
		character	)

DeleteCharacterByID()

void DeleteCharacterByID	(	username	,
		characterID	)

Destroy()

void Destroy

(

username

)

GetCharacterDataByID()

table GetCharacterDataByID	(	username	,
		characterID	)

Gets saved character data by their ID.

Parameters

username	string The username of the player.
characterID	integer The ID of the character.

Returns

table or boolean The character data or false if the data failed to be retrieved.

GetLoadedCharacterByID()

void GetLoadedCharacterByID

(

username

)

GetNextCharacterID()

void GetNextCharacterID

(

username

)

GetPlayerByID()

object GetPlayerByID

(

username

)

Gets the player object by their username.

Parameters

username

string The username of the player.

Returns

object or boolean The player object or false if the player was not found.

Initialize()

void Initialize

(

isoPlayer

)

LoadCharacter() [1/2]

void LoadCharacter	(	_data	,
		username	,
		characterID	)

LoadCharacter() [2/2]

void LoadCharacter	(	username	,
		characterData	,
		survivorDescriptor	,
		loadCharacterStartTime	)

LoadCharacterByID()

void LoadCharacterByID	(	username	,
		characterID	)

New()

void New

(

isoPlayer

)

OnCreateCharacter()

void OnCreateCharacter	(	data	,
		username	,
		characterData	)

OnFillWorldObjectContextMenu()

void OnFillWorldObjectContextMenu	(	playerNumber	,
		context	,
		worldObjects	,
		test	)

OnInitGlobalModData()

void OnInitGlobalModData

(

isNewGame

)

OnLoadCharacter() [1/2]

void OnLoadCharacter	(	data	,
		characterID	)

OnLoadCharacter() [2/2]

void OnLoadCharacter	(	username	,
		characterID	)

OnPostLoadCharacter()

void OnPostLoadCharacter	(	isoPlayer	,
		player	,
		character	,
		characterData	)

OnPreLoadCharacter()

void OnPreLoadCharacter	(	isoPlayer	,
		player	,
		character	,
		characterData	)

OnStorageSet()

void OnStorageSet	(	isoPlayer	,
		command	,
		namespace	,
		keys	,
		value	)

ResetCharacterSaveInterval()

void ResetCharacterSaveInterval

(

)

Save()

boolean Save	(	username	,
		continueOnFailure	)

Saves the player and their currently loaded character.

Parameters

username	string The username of the player.
continueOnFailure	boolean (Optional) Whether or not to continue saving either the player or character if either should fail. Default = false. True not recommended.

Returns

boolean Whether or not the player was successfully saved.

string The failure message if the player or character failed to save.

SaveCharacter()

void SaveCharacter	(	username	,
		character	)

SaveCharacterByID()

void SaveCharacterByID	(	username	,
		characterID	)

StartPlayerTick()

void StartPlayerTick

(

player

)

Field Documentation

Admin

FrameworkZ::Players::Admin

Definition at line 31 of file Players.lua.

List

FrameworkZ Players List

List of all instanced players in the game.

Definition at line 18 of file Players.lua.

Moderator

FrameworkZ::Players::Moderator

Definition at line 29 of file Players.lua.

Operator

FrameworkZ::Players::Operator

Definition at line 27 of file Players.lua.

Owner

FrameworkZ::Players::Owner

Definition at line 35 of file Players.lua.

Players

FrameworkZ Players

Definition at line 37 of file Players.lua.

Roles

FrameworkZ Players Roles

Roles for players in FrameworkZ.

Definition at line 23 of file Players.lua.

Super_Admin

FrameworkZ::Players::Super_Admin

Definition at line 33 of file Players.lua.

User

FrameworkZ::Players::User

Definition at line 25 of file Players.lua.

---

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

• Players.lua