FrameworkZ API Documentation - PLAYER

Home / PLAYER Class

PLAYER

class

Player class for FrameworkZ.

0
Functions
36
Methods
1
Fields

📋 On This Page

Fields

1
PLAYER 📋 table
Player class for FrameworkZ.
Initial value: {}

Methods

36

PLAYER:Destroy()

method
Destroys the player object.

Returns

🏷️ mixed
of \boolean Whether or not the player was successfully destroyed and \string The message on success or failure.

PLAYER:GenerateUID()

method undocumented
No documentation available

PLAYER:GetCharacter()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

PLAYER:GetCharacterDataByID(characterID, callback)

method undocumented
No documentation available

Parameters (inferred)

characterID ❓ unknown
Parameter inferred from function signature
callback ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

PLAYER:GetCharacters()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

PLAYER:GetCustomData()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

PLAYER:GetIsoPlayer()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

PLAYER:GetMaxCharacters()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

PLAYER:GetPreviousCharacter()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

PLAYER:GetRole()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

PLAYER:GetSaveableData()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

PLAYER:GetSteamID()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

PLAYER:GetStoredData()

method
Gets the stored player mod data table. Used internally. Do not use this unless you know what you are doing. Updating data on the mod data will cause inconsistencies between the mod data and the FrameworkZ player object.

Returns

📋 table
The stored player mod data table.

PLAYER:GetUsername()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

PLAYER:GetWhitelists()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

PLAYER:Initialize()

method
Initializes the player object.

Returns

📝 string
The username of the player.

PLAYER:InitializeDefaultFactionWhitelists()

method undocumented
No documentation available

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

PLAYER:IsWhitelisted(factionID)

method undocumented
No documentation available

Parameters (inferred)

factionID ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

PLAYER:LoadCharacter(characterID)

method undocumented
No documentation available

Parameters (inferred)

characterID ❓ unknown
Parameter inferred from function signature

PLAYER:PlayLocalSound(soundName)

method
Plays a sound for the player that only they can hear.

Parameters

soundName 📝 string
The name of the sound to play.

Returns

🔢 integer
The sound's ID.

PLAYER:RestoreData(data)

method undocumented
No documentation available

Parameters (inferred)

data ❓ unknown
Parameter inferred from function signature

PLAYER:Save()

method
Saves the player's data.

Parameters

shouldTransmit ✅ boolean
(Optional) Whether or not to transmit the player's data to the server.

Returns

✅ boolean
Whether or not the player was successfully saved.

PLAYER:SetCharacter(character)

method undocumented
No documentation available

Parameters (inferred)

character ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

PLAYER:SetCharacters(characters)

method undocumented
No documentation available

Parameters (inferred)

characters ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

PLAYER:SetCustomData(customData)

method undocumented
No documentation available

Parameters (inferred)

customData ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

PLAYER:SetIsoPlayer(isoPlayer)

method undocumented
No documentation available

Parameters (inferred)

isoPlayer ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

PLAYER:SetMaxCharacters(maxCharacters)

method undocumented
No documentation available

Parameters (inferred)

maxCharacters ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

PLAYER:SetModel(characterData)

method undocumented
No documentation available

Parameters (inferred)

characterData ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

PLAYER:SetPreviousCharacter(previousCharacter)

method undocumented
No documentation available

Parameters (inferred)

previousCharacter ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

PLAYER:SetRole(role)

method undocumented
No documentation available

Parameters (inferred)

role ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

PLAYER:SetSteamID(steamID)

method undocumented
No documentation available

Parameters (inferred)

steamID ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

PLAYER:SetUsername(username)

method undocumented
No documentation available

Parameters (inferred)

username ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

PLAYER:SetWhitelisted(factionID, whitelisted)

method undocumented
No documentation available

Parameters (inferred)

factionID ❓ unknown
Parameter inferred from function signature
whitelisted ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

PLAYER:SetWhitelists(whitelists)

method undocumented
No documentation available

Parameters (inferred)

whitelists ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

PLAYER:StopSound(soundNameOrID)

method
Stops a sound for the player.

Parameters

soundNameOrID 🏷️ mixed
of \string or \integer The name or ID of the sound to stop.

PLAYER:ValidatePlayerData()

method undocumented
No documentation available