CHARACTER Class Reference

Character class for FrameworkZ. More...

Public Member Functions
void	AddRecognition (character, alias)
void	Destroy ()
	Destroy a character. This will remove the character from the list of characters and is usually called after a player has disconnected.
void	GetRecognition (character)
void	GetSaveableData ()
boolean	GiveItem (uniqueID)
	Give a character an item.
void	GiveItems (uniqueID, amount)
	Give a character items by the specified amount.
string	Initialize ()
	Initialize a character.
void	InitializeDefaultItems ()
	Initialize the default items for a character based on their faction. Called when FZ_CHAR mod data is first created.
boolean	IsCitizen ()
	Checks if a character is a citizen.
boolean	IsCombine ()
	Checks if a character is a combine.
void	OnLoad ()
void	OnPostLoad (firstLoad)
void	OnPreLoad ()
void	RecognizesCharacter (character)
void	RestoreData ()
boolean	Save (shouldTransmit)
	Save the character's data from the character object.
void	SetUID (uid)
boolean	TakeItem (uniqueID)
	Take an item from a character's inventory.
boolean	TakeItemByInstanceID (instanceID)
	Take an item from a character's inventory by its instance ID. Useful for taking a specific item from a stack.
void	TakeItems (uniqueID, amount)

Data Fields
CHARACTER	__index

Detailed Description

Character class for FrameworkZ.

Definition at line 827 of file Characters.lua.

Member Function Documentation

AddRecognition()

void AddRecognition	(	character	,
		alias	)

Destroy()

void Destroy

(

)

Destroy a character. This will remove the character from the list of characters and is usually called after a player has disconnected.

GetRecognition()

void GetRecognition

(

character

)

GetSaveableData()

void GetSaveableData

(

)

GiveItem()

boolean GiveItem

(

uniqueID

)

Give a character an item.

Parameters

uniqueID

string The ID of the item to give.

Returns

boolean Whether or not the item was successfully given.

GiveItems()

void GiveItems	(	uniqueID	,
		amount	)

Give a character items by the specified amount.

Parameters

itemID	string The ID of the item to give.
amount	integer The amount of the item to give.

Initialize()

string Initialize

(

)

Initialize a character.

Returns

string username

InitializeDefaultItems()

void InitializeDefaultItems

(

)

Initialize the default items for a character based on their faction. Called when FZ_CHAR mod data is first created.

IsCitizen()

boolean IsCitizen

(

)

Checks if a character is a citizen.

Returns

boolean Whether or not the character is a citizen.

IsCombine()

boolean IsCombine

(

)

Checks if a character is a combine.

Returns

boolean Whether or not the character is a combine.

OnLoad()

void OnLoad

(

)

OnPostLoad()

void OnPostLoad

(

firstLoad

)

OnPreLoad()

void OnPreLoad

(

)

RecognizesCharacter()

void RecognizesCharacter

(

character

)

RestoreData()

void RestoreData

(

)

Save()

boolean Save

(

shouldTransmit

)

Save the character's data from the character object.

Parameters

shouldTransmit

boolean (Optional) Whether or not to transmit the character's data to the server.

Returns

boolean Whether or not the character was successfully saved.

SetUID()

void SetUID

(

uid

)

TakeItem()

boolean TakeItem

(

uniqueID

)

Take an item from a character's inventory.

Parameters

uniqueID

string The unique ID of the item to take.

Returns

boolean string Whether or not the item was successfully taken and the success or failure message.

TakeItemByInstanceID()

boolean TakeItemByInstanceID

(

instanceID

)

Take an item from a character's inventory by its instance ID. Useful for taking a specific item from a stack.

Parameters

instanceID

integer The instance ID of the item to take.

Returns

boolean string Whether or not the item was successfully taken and the success or failure message.

TakeItems()

void TakeItems	(	uniqueID	,
		amount	)

Field Documentation

__index

CHARACTER __index

Definition at line 829 of file Characters.lua.

---

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

• Characters.lua