FrameworkZ API - All Functions

Home / All Functions & Methods

📋 All Functions & Methods

Complete reference of all 943 functions and methods.

25
Functions
474
Methods
444
Undocumented
943
Total

Functions

25

AggregatedOptions.new(uniqueID)

function
Construct a container for grouped options.

Parameters

uniqueID 📝 string
Aggregation key.

Returns

📋 table
AggregatedOptions instance.

ContextMenuBuilder.new(menuManager, context)

function
Builder that wraps an ISContextMenu for option aggregation.

Parameters

menuManager 📋 table
Owning MenuManager.
context 📋 table
ISContextMenu being built.

Returns

📋 table
ContextMenuBuilder instance.

FrameworkZ.Characters.PostLoad(data, characterData)

function
Post-load callback function for character initialization.

Parameters

data 📋 table
The data containing the IsoPlayer object.
characterData 📋 table
The character's stored data.

Returns

📋 table
The initialized character object.

FrameworkZ.Entities.OnGameStart()

function
Register entity context menu hook once the game starts.

FrameworkZ.Entities.OnObjectAboutToBeRemoved(object)

function
Invoked before an entity world object is removed.

Parameters

object 📋 table
The object being removed.

FrameworkZ.Entities.OnObjectAdded(object)

function
Called when an object is added to the world. Adds the entity to the object's mod data.

Parameters

object 📋 table
The object that was added to the world.

FrameworkZ.Entities.OnPreFillWorldObjectContextMenu(player, context, worldObjects, test)

function
Build interaction submenu entries for entity objects on right-click.

Parameters

player 🔢 integer
The local player index.
context 📋 table
The context menu being built.
worldObjects 📋 table
The world objects under the cursor.
test ✅ boolean
Test flag from PZ hook.

FrameworkZ.Foundation.New()

function
Create a new instance of the FrameworkZ framework.

Returns

📋 table
The new instance of the FrameworkZ framework.

FrameworkZ.Foundation.OnGetData(data, namespace, keys, subscriptionID)

function
Network callback for getting data from storage.

Parameters

data 📋 table
The request data.
namespace 📝 string
The namespace to retrieve from.
keys 📝 string
or \table The key(s) to retrieve.
subscriptionID 📝 string
(Optional) Subscription ID for callback.

Returns

🏷️ mixed
The retrieved value.

FrameworkZ.Foundation.OnRemoveData(data)

function
Client receives key removal broadcast.

Parameters

data 📋 table
The removal data containing namespace and key.

FrameworkZ.Foundation.OnSaveNamespace(data)

function
Client-side callback for saving a specific namespace.

Parameters

data 📋 table
The data containing the isoPlayer and namespace.

FrameworkZ.Foundation.OnSaveNamespace(data, namespace)

function
Server-side callback for saving a specific namespace.

Parameters

data 📋 table
The data containing the isoPlayer object.
namespace 📝 string
The namespace to save.

FrameworkZ.Foundation.OnSetData(data, namespace, keys, value, subscriptionID, broadcast)

function
Network callback for setting data in storage.

Parameters

data 📋 table
The request data.
namespace 📝 string
The namespace to store in.
keys 📝 string
or \table The key(s) to set.
value 🏷️ mixed
The value to store.
subscriptionID 📝 string
(Optional) Subscription ID for callback.
broadcast ✅ boolean
Whether to broadcast the change.

Returns

✅ boolean
Success status.

FrameworkZ.Foundation.OnSync(data)

function
Server-side response to client sync request.

Parameters

data 📋 table
The sync request data containing namespace and key.

Returns

📋 table
Returns a table with namespace, key, and value if successful.

FrameworkZ.Foundation.OnSync(data, namespace, keys, value)

function
Server-side response to client sync request.

Parameters

data 📋 table
The sync request data containing namespace and key.

Returns

📋 table
Returns a table with namespace, key, and value if successful.

FrameworkZ.Foundation.OnSyncBroadcast(data)

function
Client receives sync data from broadcast.

Parameters

data 📋 table
The broadcast data containing namespace, key, and value.

FrameworkZ.Foundation.OnTeleportToLimbo(data)

function
Network callback function for teleporting a player to the limbo area.

Parameters

data 📋 table
The data containing the isoPlayer object.

Returns

✅ boolean
Returns true if successful, false otherwise.

FrameworkZ.Interfaces.Opt(options, key, default)

function
Safely read an option value with a default.

Parameters

options 📋 table
Options table or nil.
key 📝 string
Key to read.
default 🏷️ mixed
Fallback value.

Returns

🏷️ mixed
The value or default.

FrameworkZ.Logs.OnWeaponHitCharacter(characterGivingDamage, characterTakingDamage, handWeapon, damage)

function
Log damage dealt to players from players and zombies.

Parameters

characterGivingDamage 📋 table
The character dealing the damage.
characterTakingDamage 📋 table
The character taking the damage.
handWeapon 📋 table
The weapon used to deal the damage.
damage 🔢 integer
The amount of damage dealt.

FrameworkZ.UI.GetCenteredX(length, fontSize, text)

function
Get the x position to center text based on the text's width and what you're centering relative to.

Parameters

int 🏷️ length
The length of the object you're centering the text in.
string 🏷️ fontSize
The font size of the text (could be UIFont.Small, UIFont.Medium, UIFont.Large, or UIFont.Title).
string 🏷️ text
The text you're centering.

FrameworkZ.UI.GetHeight(fontSize, text)

function
Get the height of text.

Parameters

fontSize 📝 string
The font size (UIFont.Small, UIFont.Medium, UIFont.Large, UIFont.Title).
text 📝 string
The text to measure.

Returns

🔢 number
The height of the text.

FrameworkZ.UI.GetMiddle(length, fontSize, text)

function
Get the middle position for text alignment.

Parameters

length 🔢 integer
The length of the container.
fontSize 📝 string
The font size (UIFont.Small, UIFont.Medium, UIFont.Large, UIFont.Title).
text 📝 string
The text to measure.

Returns

🔢 number
The middle position for text alignment.

generateRequestID()

function
Generate a time-based unique request ID for network requests.

Returns

📝 string
A unique request ID based on the current timestamp and a random number.

Options.new(text, target, callback, callbackParameters, addOnTop, useMultiple, count)

function
Construct a menu option descriptor.

Parameters

text 📝 string
Display text.
target 📋 table
Callback target/self.
callback ⚡ function
Function to execute.
callbackParameters 📋 table
Optional parameters table.
addOnTop ✅ boolean
Whether to insert at top of menu.
useMultiple ✅ boolean
Whether to show count badge.
count 🔢 integer
Count for multiple selection.

Returns

📋 table
Options instance.

Methods

474

CHARACTER:AddRecognition(character, alias)

method
Add a character to the recognition list.

Parameters

character 📋 table
The character object to add to recognition.
alias 📝 string
(Optional) The alias to recognize the character as.

Returns

✅ boolean
\string Whether the recognition was successfully added and a message.

CHARACTER:Destroy()

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

CHARACTER:GetAge()

method
Get the character's age.

Returns

🔢 integer
The character's age.

CHARACTER:GetAllHealth()

method
Get and sync all character health data from isoPlayer.

Returns

📋 table
The character's health data.

CHARACTER:GetBeardColor()

method
Get the character's beard color.

Returns

📋 table
The character's beard color as RGB values.

CHARACTER:GetBeardStyle()

method
Get the character's beard style.

Returns

📝 string
The character's beard style.

CHARACTER:GetBodyParts()

method
Get the character's body part data.

Returns

📋 table
The character's body part data.

CHARACTER:GetBoredom()

method
Get the character's boredom stat.

Returns

🔢 number
The character's boredom level.

CHARACTER:GetColdStrength()

method
Get the character's cold strength.

Returns

🔢 number
The character's cold strength.

CHARACTER:GetDescription()

method
Get the character's description.

Returns

📝 string
The character's description.

CHARACTER:GetDrunkenness()

method
Get the character's drunkenness stat.

Returns

🔢 number
The character's drunkenness level.

CHARACTER:GetEndurance()

method
Get the character's endurance stat.

Returns

🔢 number
The character's endurance level.

CHARACTER:GetEquipment()

method
Get and sync character equipment from isoPlayer.
Only extracts equipment slots (Hat, Shirt, Pants, etc.), not inventory contents.

Returns

📋 table
The character's equipment data by slot.

CHARACTER:GetEyeColor()

method
Get the character's eye color.

Returns

📋 table
The character's eye color as RGB values.

CHARACTER:GetFaction()

method
Get the character's faction.

Returns

📝 string
The character's faction ID.

CHARACTER:GetFatigue()

method
Get the character's fatigue stat.

Returns

🔢 number
The character's fatigue level.

CHARACTER:GetGender()

method
Get the character's gender.

Returns

📝 string
The character's gender.

CHARACTER:GetHairColor()

method
Get the character's hair color.

Returns

📋 table
The character's hair color as RGB values.

CHARACTER:GetHairStyle()

method
Get the character's hair style.

Returns

📝 string
The character's hair style.

CHARACTER:GetHasCold()

method
Get whether the character has a cold.

Returns

✅ boolean
Whether the character has a cold.

CHARACTER:GetHealth()

method
Get the character's overall body health.

Returns

🔢 number
The character's overall body health.

CHARACTER:GetHeight()

method
Get the character's height.

Returns

🔢 number
The character's height.

CHARACTER:GetHunger()

method
Get the character's hunger stat.

Returns

🔢 number
The character's hunger level.

CHARACTER:GetID()

method
Get the character's ID.

Returns

🔢 integer
The character's ID.

CHARACTER:GetInventory()

method
Get the character's inventory object.

Returns

📋 table
The character's inventory object.

CHARACTER:GetInventoryContents()

method
Get and sync inventory contents from the character's Inventory object.
Delegates to the Inventory object's Save() method.

Returns

📋 table
The inventory contents data with INVENTORY_LOGICAL and INVENTORY_PHYSICAL.

CHARACTER:GetInventoryID()

method
Get the character's inventory ID.

Returns

🔢 integer
The character's inventory ID.

CHARACTER:GetIsoPlayer()

method
Get the character's IsoPlayer object.

Returns

📋 table
The character's IsoPlayer object.

CHARACTER:GetName()

method
Get the character's name.

Returns

📝 string
The character's name.

CHARACTER:GetPain()

method
Get the character's pain stat.

Returns

🔢 number
The character's pain level.

CHARACTER:GetPanic()

method
Get the character's panic stat.

Returns

🔢 number
The character's panic level.

CHARACTER:GetPerks()

method
Get the character's perks (same as traits in PZ).

Returns

📋 table
The character's perks.

CHARACTER:GetPhysique()

method
Get the character's physique.

Returns

📝 string
The character's physique.

CHARACTER:GetPlayer()

method
Get the character's associated player object.

Returns

📋 table
The character's player object.

CHARACTER:GetPosition()

method
Get and sync character position and direction from isoPlayer.

Returns

📋 table
The character's position data.

CHARACTER:GetRecognition(character)

method
Get how this character recognizes another character.

Parameters

character 📋 table
The character object to get recognition for.

Returns

📝 string
The name or alias this character recognizes the other as.

CHARACTER:GetRecognizes()

method
Get the character's recognition list.

Returns

📋 table
The character's recognition list.

CHARACTER:GetSaveableData()

method
Get the character's saveable data with filtered properties.

Returns

📋 table
The character's saveable data.

CHARACTER:GetSickness()

method
Get the character's sickness level.

Returns

🔢 number
The character's sickness level.

CHARACTER:GetSkills()

method
Get the character's skills/XP data.

Returns

📋 table
The character's skills data.

CHARACTER:GetSkinColor()

method
Get the character's skin color.

Returns

🔢 integer
The character's skin color constant.

CHARACTER:GetStats()

method
Get and sync all character stats from isoPlayer.

Returns

📋 table
The character's stats data.

CHARACTER:GetStress()

method
Get the character's stress stat.

Returns

🔢 number
The character's stress level.

CHARACTER:GetTemperature()

method
Get the character's body temperature.

Returns

🔢 number
The character's body temperature.

CHARACTER:GetThirst()

method
Get the character's thirst stat.

Returns

🔢 number
The character's thirst level.

CHARACTER:GetTraits()

method
Get the character's traits.

Returns

📋 table
The character's traits.

CHARACTER:GetUID()

method
Get the character's unique ID.

Returns

📝 string
The character's unique ID.

CHARACTER:GetUsername()

method
Get the character's username.

Returns

📝 string
The character's username.

CHARACTER:GetWeight()

method
Get the character's weight.

Returns

🔢 number
The character's weight.

CHARACTER:GetWetness()

method
Get the character's wetness level.

Returns

🔢 number
The character's wetness level.

CHARACTER:GiveItem(uniqueID)

method
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.

CHARACTER:GiveItems(uniqueID, amount)

method
Give a character items by the specified amount.

Parameters

uniqueID 📝 string
The unique ID of the item to give.
amount 🔢 integer
The amount of the item to give.

CHARACTER:Initialize(callback)

method
Initialize a character.

Returns

✅ boolean
\string Whether initialization was successful and a message.

CHARACTER:InitializeDefaultItems()

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

CHARACTER:IsCitizen()

method
Checks if a character is a citizen.

Returns

✅ boolean
Whether or not the character is a citizen.

CHARACTER:IsCombine()

method
Checks if a character is a combine.

Returns

✅ boolean
Whether or not the character is a combine.

CHARACTER:OnLoad()

method
Character load hook. Called during character loading.

CHARACTER:OnPostLoad(firstLoad)

method
Character post-load hook. Called after character loading is complete.

Parameters

firstLoad ✅ boolean
Whether this is the first time loading this character.

CHARACTER:OnPreLoad()

method
Character pre-load hook. Called before character loading begins.

CHARACTER:RecognizesCharacter(character)

method
Check if this character recognizes another character.

Parameters

character 📋 table
The character object to check recognition for.

Returns

✅ boolean
Whether this character recognizes the other character.

CHARACTER:Restore(callback)

method
Restore this character from persisted data and attach it to the owning player.

Parameters

callback ⚡ function
Callback(characterData|false, message) invoked when restore completes.

Returns

✅ boolean
Success flag.
📝 string
Status or error message.

CHARACTER:RestoreData(characterData)

method
Used for restoring character data from a table, typically a table gathered through the FZ Data Storage system.

Parameters

characterData 📋 table
(Optional) The character data table to restore from.

CHARACTER:RestoreEquipment(characterData)

method
Restore worn equipment from saved character data.

Parameters

characterData 📋 table
Character data payload containing equipment info.

Returns

✅ boolean
Success flag.
📝 string
Descriptive message.

CHARACTER:RestoreHealth(characterData)

method
Restore health values, environmental effects, and body part states.

Parameters

characterData 📋 table
Character data payload containing health fields/body part data.

Returns

✅ boolean
Success flag.
📝 string
Descriptive message.

CHARACTER:RestoreInventory(characterData)

method
Restore logical/physical inventory (not worn equipment) from saved character data.

Parameters

characterData 📋 table
Character data payload containing INVENTORY_LOGICAL and INVENTORY_PHYSICAL.

Returns

✅ boolean
Success flag.
📝 string
Descriptive message.

CHARACTER:RestoreModel(characterData, reset)

method
Restore visual model (gender, skin, hair, beard) from saved character data.

Parameters

characterData 📋 table
Character data payload used to rebuild visuals.
reset (optional) ✅ boolean
Whether to call isoPlayer:resetModel() after applying visuals.

Returns

✅ boolean
Success flag.
📝 string
Descriptive message.

CHARACTER:RestorePosition(x, y, z, angles)

method
Restore world position and facing direction.

Parameters

x 🔢 number
X coordinate.
y 🔢 number
Y coordinate.
z 🔢 number
Z level.
angles (optional) 🔢 number
Facing direction angle.

Returns

✅ boolean
Success flag.
📝 string
Descriptive message.

CHARACTER:RestoreSkills(characterData)

method
Restore skills/XP levels from saved data.

Parameters

characterData 📋 table
Character data payload containing XP/skills table.

Returns

✅ boolean
Success flag.
📝 string
Descriptive message.

CHARACTER:RestoreStats(characterData)

method
Restore high-level moodle/stat values (hunger, thirst, fatigue, etc.).

Parameters

characterData 📋 table
Character data payload containing STAT_* fields.

Returns

✅ boolean
Success flag.
📝 string
Descriptive message.

CHARACTER:RestoreTraits(characterData)

method
Restore trait list to the IsoPlayer and character object.

Parameters

characterData 📋 table
Character data payload containing trait array.

Returns

✅ boolean
Success flag.
📝 string
Descriptive message.

CHARACTER:Save(callback)

method
Save the character's data from the character object.

Parameters

callback ⚡ function
Optional callback function(success, message) called when save completes.

Returns

✅ boolean
Whether or not the character was successfully saved.

CHARACTER:SetAge(age)

method
Set the character's age.

Parameters

age 🔢 integer
The age to set.

CHARACTER:SetBeardColor(beardColor)

method
Set the character's beard color.

Parameters

beardColor 📋 table
The beard color to set as RGB values.

CHARACTER:SetBeardStyle(beardStyle)

method
Set the character's beard style.

Parameters

beardStyle 📝 string
The beard style to set.

CHARACTER:SetBodyParts(bodyParts)

method
Set the character's body part data.

Parameters

bodyParts 📋 table
The body part data to set.

CHARACTER:SetBoredom(boredom)

method
Set the character's boredom stat.

Parameters

boredom 🔢 number
The boredom level to set.

CHARACTER:SetColdStrength(coldStrength)

method
Set the character's cold strength.

Parameters

coldStrength 🔢 number
The cold strength to set.

CHARACTER:SetDescription(description)

method
Set the character's description.

Parameters

description 📝 string
The description to set.

CHARACTER:SetDrunkenness(drunkenness)

method
Set the character's drunkenness stat.

Parameters

drunkenness 🔢 number
The drunkenness level to set.

CHARACTER:SetEndurance(endurance)

method
Set the character's endurance stat.

Parameters

endurance 🔢 number
The endurance level to set.

CHARACTER:SetEquipment(equipment)

method
Set the character's equipment data.

Parameters

equipment 📋 table
The equipment data to set.

CHARACTER:SetEyeColor(eyeColor)

method
Set the character's eye color.

Parameters

eyeColor 📋 table
The eye color to set as RGB values.

CHARACTER:SetFaction(faction)

method
Set the character's faction.

Parameters

faction 📝 string
The faction ID to set.

CHARACTER:SetFatigue(fatigue)

method
Set the character's fatigue stat.

Parameters

fatigue 🔢 number
The fatigue level to set.

CHARACTER:SetGender(gender)

method
Set the character's gender.

Parameters

gender 📝 string
The gender to set.

CHARACTER:SetHairColor(hairColor)

method
Set the character's hair color.

Parameters

hairColor 📋 table
The hair color to set as RGB values.

CHARACTER:SetHairStyle(hairStyle)

method
Set the character's hair style.

Parameters

hairStyle 📝 string
The hair style to set.

CHARACTER:SetHasCold(hasCold)

method
Set whether the character has a cold.

Parameters

hasCold ✅ boolean
Whether the character has a cold.

CHARACTER:SetHealth(health)

method
Set the character's overall body health.

Parameters

health 🔢 number
The health level to set.

CHARACTER:SetHeight(height)

method
Set the character's height.

Parameters

height 🔢 number
The height to set.

CHARACTER:SetHunger(hunger)

method
Set the character's hunger stat.

Parameters

hunger 🔢 number
The hunger level to set.

CHARACTER:SetID(id)

method
Set the character's ID.

Parameters

id 🔢 integer
The ID to set.

CHARACTER:SetInventory(inventory)

method
Set the character's inventory object.

Parameters

inventory 📋 table
The inventory object to set.

CHARACTER:SetInventoryID(inventoryID)

method
Set the character's inventory ID.

Parameters

inventoryID 🔢 integer
The inventory ID to set.

CHARACTER:SetIsoPlayer(isoPlayer)

method
Set the character's IsoPlayer object (read-only).

Parameters

isoPlayer 📋 table
The IsoPlayer object (cannot be set after creation).

CHARACTER:SetName(name)

method
Set the character's name.

Parameters

name 📝 string
The name to set.

CHARACTER:SetPain(pain)

method
Set the character's pain stat.

Parameters

pain 🔢 number
The pain level to set.

CHARACTER:SetPanic(panic)

method
Set the character's panic stat.

Parameters

panic 🔢 number
The panic level to set.

CHARACTER:SetPerks(perks)

method
Set the character's perks (same as traits in PZ).

Parameters

perks 📋 table
The perks to set.

CHARACTER:SetPhysique(physique)

method
Set the character's physique.

Parameters

physique 📝 string
The physique to set.

CHARACTER:SetPlayer(player)

method
Set the character's associated player object.

Parameters

player 📋 table
The player object to set.

CHARACTER:SetRecognizes(recognizes)

method
Set the character's recognition list.

Parameters

recognizes 📋 table
The recognition list to set.

CHARACTER:SetSickness(sickness)

method
Set the character's sickness level.

Parameters

sickness 🔢 number
The sickness level to set.

CHARACTER:SetSkills(skills)

method
Set the character's skills/XP data.

Parameters

skills 📋 table
The skills data to set.

CHARACTER:SetSkinColor(skinColor)

method
Set the character's skin color.

Parameters

skinColor 🔢 integer
The skin color constant to set.

CHARACTER:SetStress(stress)

method
Set the character's stress stat.

Parameters

stress 🔢 number
The stress level to set.

CHARACTER:SetTemperature(temperature)

method
Set the character's body temperature.

Parameters

temperature 🔢 number
The temperature to set.

CHARACTER:SetThirst(thirst)

method
Set the character's thirst stat.

Parameters

thirst 🔢 number
The thirst level to set.

CHARACTER:SetTraits(traits)

method
Set the character's traits.

Parameters

traits 📋 table
The traits to set.

CHARACTER:SetUID(uid)

method
Set the character's unique ID.

Parameters

uid 📝 string
The unique ID to set.

CHARACTER:SetUsername(username)

method
Set the character's username (read-only).

Parameters

username 📝 string
The username (cannot be set after creation).

CHARACTER:SetWeight(weight)

method
Set the character's weight.

Parameters

weight 🔢 number
The weight to set.

CHARACTER:SetWetness(wetness)

method
Set the character's wetness level.

Parameters

wetness 🔢 number
The wetness level to set.

CHARACTER:Sync()

method
Updates stats, health, skills, traits, equipment, inventory, and position from the game state.

CHARACTER:TakeItem(uniqueID)

method
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.

CHARACTER:TakeItemByInstanceID(instanceID)

method
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.

CHARACTER:TakeItems(uniqueID, amount)

method
Take multiple items from a character's inventory by unique ID.

Parameters

uniqueID 📝 string
The unique ID of the items to take.
amount 🔢 integer
The number of items to take.

CLASS:Initialize()

method
Register this CLASS instance with the module list.

Returns

📝 string
Class ID.

ContextMenuBuilder:addAggregatedOption(aggregatedOption)

method
Register an AggregatedOptions container for later building.

Parameters

aggregatedOption 📋 table
AggregatedOptions instance.

ContextMenuBuilder:addAggregatedOptionWithCallback(uniqueID, target, text, callback, params, addOnTop, useMultiple, count)

method
Convenience to add an aggregated option by ID.

Parameters

uniqueID 📝 string
Aggregation key.
target 📋 table
Callback target/self.
text 📝 string
Display text.
callback ⚡ function
Callback to invoke.
params 📋 table
Optional parameters.
addOnTop ✅ boolean
Whether to add on top of menu.
useMultiple ✅ boolean
Whether to append count indicator.
count 🔢 integer
Count value.

ContextMenuBuilder:addOption(name, target, callback, parameters, addOnTop)

method
Add a basic option to the context menu.

Parameters

name 📝 string
Display text.
target 📋 table
Callback target/self.
callback ⚡ function
Callback.
parameters 📋 table
Optional parameters.
addOnTop ✅ boolean
Whether to add on top of menu.

Returns

📋 table
The created option.

ContextMenuBuilder:addSubMenu(name, addOnTop, options)

method
Add a submenu entry and return its builder.

Parameters

name 📝 string
Submenu label.
addOnTop ✅ boolean
Whether to add on top of menu.
options 📋 table
Optional predefined option list.

Returns

📋 table
The created menu option and submenu builder.

ContextMenuBuilder:buildAggregatedOptions()

method
Build and add all aggregated options to the context menu, then clear the queue.

ContextMenuBuilder:getAggregatedOptions()

method
Return the aggregated options table.

ContextMenuBuilder:getContext()

method
Get the underlying ISContextMenu.

ContextMenuBuilder:getMenuManager()

method
Get owning MenuManager.

ContextMenuBuilder:getOptions()

method
Return the options added through this builder.

DATABASE:AddSubscriber(player, character, temporary)

method
Adds a subscriber to the database.

Parameters

player 📦 object
The player object subscribing.
character (optional) 📦 object
The character object subscribing.
temporary ✅ bool
Whether the subscription is temporary.

Returns

✅ bool
\string success, message

📝 Notes

Character subscriptions will always be removed on character unload. However a player's subscription will persist between loads unless 'temporary' parameter is true.

ENTITY:Initialize()

method
Initialize an entity.

Returns

📝 string
The entity's ID.

ENTITY:ValidateEntityData(worldObject)

method
Validate the entity's data.

Returns

✅ boolean
Whether or not any of the entity's new data was initialized.

FACTION:GetColor()

method
Get the faction's display color RGBA.

Returns

📋 table
Color table with r, g, b, a values.

FACTION:Initialize()

method
Initialize a faction.

Returns

📝 string
faction ID

FrameworkZ.Characters:AddToCache(uid, character)

method
Add a character to the UID cache.

Parameters

uid 📝 string
The character's unique ID.
character 📋 table
The character object to add.

Returns

📋 table
\boolean The added character object or false if failed.

FrameworkZ.Characters:AddToList(username, character)

method
Add a character to the active character list.

Parameters

username 📝 string
The player's username.
character 📋 table
The character object to add.

Returns

📋 table
\boolean The added character object or false if failed.

FrameworkZ.Characters:GetCharacterByID(username)

method
Gets the user's loaded character by their ID.

Parameters

username 📝 string
The player's username to get their character object with.

Returns

📋 table
The character object from the list of characters.

FrameworkZ.Characters:GetCharacterByUID(uid)

method
Gets a character by their unique ID.

Parameters

uid 📝 string
The character's unique ID.

Returns

📋 table
The character object from the cache or nil if not found.

FrameworkZ.Characters:GetCharacterInventoryByID(username)

method
Gets a character's inventory by their username.

Parameters

username 📝 string
The player's username.

Returns

📋 table
The character's inventory object or nil if not found.

FrameworkZ.Characters:Initialize(isoPlayer, id, callback)

method
Initialize a character and add it to the system.

Parameters

isoPlayer 📋 table
The IsoPlayer object associated with this character.
id 🔢 integer
The character's ID from the player stored data.

Returns

📋 table
\string The initialized character object or false and an error message.

FrameworkZ.Characters:New(isoPlayer, id)

method
Create a new character object.

Parameters

isoPlayer 📋 table
The IsoPlayer object associated with this character.
id 🔢 integer
The character's ID from the player stored data.

Returns

📦 object | ✅ boolean
The new character object or false if the process failed to create a new character object.
📝 string
An error message if the process failed.

FrameworkZ.Characters:OnInitGlobalModData()

method
Initialize global mod data for the Characters module.

FrameworkZ.Characters:OnPostLoad(isoPlayer, characterData)

method
Initializes a player's character after loading.

Parameters

isoPlayer 📋 table
The IsoPlayer object.
characterData 📋 table
The character's stored data.

Returns

📋 table
The initialized character object.

FrameworkZ.Characters:OnStorageSet(isoPlayer, command, namespace, keys, value)

method
Storage set event handler for character data.

Parameters

isoPlayer 📋 table
The IsoPlayer object.
command 📝 string
The command type.
namespace 📝 string
The data namespace.
keys 📝 string
The data keys.
value 📋 table
The data value.

FrameworkZ.Characters:PlayerTick(player)

method
Player tick function for handling character auto-save on client.

Parameters

player 📋 table
The player object to process.

FrameworkZ.Characters:ProcessCreationData(creationData, player)

method
Process character creation data from UI into complete character data structure.

Parameters

creationData 📋 table
Data from character creation interfaces.
player 📦 object
PLAYER object for UID generation.

Returns

📋 table | ✅ boolean
Complete character data structure or false if processing failed.
📝 string
Error message if processing failed.

FrameworkZ.Characters:RemoveFromCache(uid)

method
Remove a character from the UID cache.

Parameters

uid 📝 string
The character's unique ID.

Returns

✅ boolean
Whether the character was successfully removed.

FrameworkZ.Characters:RemoveFromList(username)

method
Remove a character from the active character list.

Parameters

username 📝 string
The player's username.

Returns

✅ boolean
Whether the character was successfully removed.

FrameworkZ.Characters:Save(username)

method
Saves the user's currently loaded character.

Parameters

username 📝 string
The player's username to get their loaded character from.

Returns

✅ boolean
Whether or not the character was successfully saved.

FrameworkZ.Classes:GetClassByID(factionID)

method
Lookup a CLASS by ID.

Parameters

factionID 📝 string
The class ID to fetch.

Returns

❔ table?
The CLASS object or nil if missing.

FrameworkZ.Classes:Initialize(id, object)

method
Register a CLASS object into the module list.

Parameters

id 📝 string
Class ID.
object 📋 table
CLASS instance to register.

Returns

📝 string
Registered class ID.

FrameworkZ.Classes:New(name)

method
Create a new class object definition.

Parameters

name 📝 string
Class ID/name.

Returns

📋 table
The CLASS instance.

FrameworkZ.Commands:CanExecuteCommand(player, command)

method
Check if a player can execute a command (fallback method)

Parameters

player ❓ unknown
IsoPlayer
command 🏷️ Command
object

Returns

✅ boolean
Can execute

FrameworkZ.Commands:ExecuteCommand(player, commandName, args)

method
Execute a command

Parameters

player 🏷️ IsoPlayer
executing the command
commandName 🏷️ Command
name or alias
args 🏷️ Array
of arguments

Returns

✅ boolean
Success status

FrameworkZ.Commands:GetAllCommands()

method
Get all registered commands

Returns

📋 table
Map of commandName -> command object

FrameworkZ.Commands:GetCommand(commandName)

method
Get command by name

Parameters

commandName 🏷️ Command
name

Returns

❔ table?
Command object

FrameworkZ.Commands:GetCommandCount()

method
Get count of registered commands

Returns

🔢 number
Count

FrameworkZ.Commands:HookChatSystem()

method
Hook into the chat system to intercept commands

FrameworkZ.Commands:Initialize()

method
Initialize the Commands module

FrameworkZ.Commands:LoadCustomCommands()

method
Load custom commands from command definition files

FrameworkZ.Commands:LogCommandExecution(player, commandName, args, success)

method
Log command execution

FrameworkZ.Commands:New(name)

method
Create a new command object

Parameters

name 🏷️ Command
name

Returns

📋 table
Command object

FrameworkZ.Commands:ParseCommandString(commandText)

method
Parse a command string into parts

Parameters

commandText 🏷️ Command
text (without prefix)

Returns

📋 table
Array of command parts

FrameworkZ.Commands:ProcessCommand(player, message)

method
Process a chat message as a potential command

Parameters

player 🏷️ IsoPlayer
who sent the message
message 🏷️ Chat
message text

Returns

✅ boolean
True if message was a command and was handled

FrameworkZ.Commands:Register(command)

method
Register a command object

Parameters

command 🏷️ Command
object (created with New())

Returns

✅ boolean
Success status

FrameworkZ.Commands:SendMessage(player, message)

method
Send a message to a player

Parameters

player ❓ unknown
IsoPlayer
message 🏷️ Message
text

FrameworkZ.Commands:UnregisterCommand(commandName)

method
Unregister a command

Parameters

commandName 🏷️ Command
name

Returns

✅ boolean
Success

FrameworkZ.Config:GetOption(optionName)

method
Get a configuration option value.

Parameters

optionName 📝 string
The name of the option to retrieve.

Returns

🏷️ mixed
The value of the option.

FrameworkZ.Config:SetOption(optionName, value)

method
Set a configuration option value.

Parameters

optionName 📝 string
The name of the option to set.
value 🏷️ mixed
The value to set for the option.

FrameworkZ.Databases:GetData(database, keys)

method
Retrieves data from a specified database and keys.

Parameters

database 📝 string | 📦 object
The name of the database or the specific database object.
keys 📋 table
The keys to traverse in the database.

Returns

🌟 any
\string The retrieved data or nil if not found, and a message if applicable.

FrameworkZ.Entities:EmitSound(worldObject, sound)

method
Play a world sound at an entity's square.

Parameters

worldObject 📋 table
The world object to use as the source.
sound 📝 string
The sound cue name.

Returns

✅ boolean
Whether the sound was queued.

FrameworkZ.Entities:GetData(worldObject, index)

method
Get persisted entity data value by key from a world object.

Parameters

worldObject 📋 table
The world object containing entity mod data.
index 📝 string
The persistData key to retrieve.

Returns

🏷️ mixed
The stored value or nil if missing.

FrameworkZ.Entities:GetEntityByID(entityID)

method
Get an entity by their ID.

Parameters

entityID 📝 string
The entity's ID.

Returns

📋 table
Entity Object

FrameworkZ.Entities:Initialize(data, name)

method
Initialize an entity.

Parameters

data 📋 table
The entity's object data
name 📝 string
The entity's name (i.e. ID)

Returns

📝 string
Entity ID

FrameworkZ.Entities:IsEntity(object)

method
Checks if an object is an entity (needs optimization from cached entities).

Parameters

object 📋 table
The object to check.

Returns

✅ boolean
Whether or not the object is an entity and its entity ID if it is an entity.
🔢 integer
The entity ID if the object is an entity.

FrameworkZ.Entities:LoadGridsquare(square)

method
Placeholder for loading entity data on chunk load.

Parameters

square 📋 table
The gridsquare being loaded.

FrameworkZ.Entities:New(name)

method
Create a new entity object.

Parameters

name 📝 string
The entity's name (i.e. ID).
square 📋 table
The square the entity is on.

Returns

📋 table
The entity's object table.

FrameworkZ.Entities:SetData(worldObject, index, value)

method
Update a persisted entity data value and transmit the change.

Parameters

worldObject 📋 table
The world object containing entity mod data.
index 📝 string
The persistData key to update.
value 🏷️ mixed
The value to set.

Returns

✅ boolean
Whether the data was updated.

FrameworkZ.Factions:GetFactionByID(factionID)

method
Get a faction by their ID.

Parameters

factionID 📝 string
The faction's ID

Returns

📋 table
The faction's object.

FrameworkZ.Factions:GetFactionNameByID(factionID)

method
Get a faction's name by their ID. Useful for getting a faction's actual name if the initialized faction ID differs from the name field.

Parameters

factionID 📝 string
The faction's ID.

Returns

📝 string
The faction's name.

FrameworkZ.Factions:Initialize(id, object)

method
Initialize a faction.

Parameters

data 📋 table
The faction object's data.
name 📝 string
The faction's name (i.e. ID).

Returns

📝 string
The faction ID.

FrameworkZ.Factions:New(name)

method
Create a new faction object.

Parameters

name 📝 string
Faction name.

Returns

📋 table
The new faction object.

FrameworkZ.Foundation.Events:EveryDays()

method
Daily timer event that executes once per in-game day.

FrameworkZ.Foundation.Events:OnClientCommand(module, command, isoPlayer, arguments)

method
Handles client commands received on the server.

Parameters

module 📝 string
The module name that sent the command.
command 📝 string
The command that was sent.
isoPlayer 📦 object
The player object that sent the command.
arguments 📋 table
The arguments that were sent with the command.

FrameworkZ.Foundation.Events:OnConnected()

method
Called when a player connects to the server.

FrameworkZ.Foundation.Events:OnCreatePlayer()

method
Called when a new player character is created.

FrameworkZ.Foundation.Events:OnDisconnect()

method
Called when a player disconnects from the server.

FrameworkZ.Foundation.Events:OnFillInventoryObjectContextMenu(player, context, items)

method
Called when filling an inventory object's context menu.

Parameters

player 📦 object
The player object.
context 📦 object
The context menu object.
items 📋 table
The items being examined.

FrameworkZ.Foundation.Events:OnFillWorldObjectContextMenu(playerNumber, context, worldObjects, test)

method
Called when filling a world object's context menu.

Parameters

playerNumber 🔢 integer
The player number.
context 📦 object
The context menu object.
worldObjects 📋 table
The world objects being examined.
test ✅ boolean
Test parameter.

FrameworkZ.Foundation.Events:OnGameStart()

method
Called when the game starts.

FrameworkZ.Foundation.Events:OnInitGlobalModData(isNewGame)

method
Called when global mod data is initialized.

Parameters

isNewGame ✅ boolean
Whether this is a new game or loading an existing one.

FrameworkZ.Foundation.Events:OnKeyStartPressed(key)

method
Called when a key starts being pressed.

Parameters

key 🔢 integer
The key code that was pressed.

FrameworkZ.Foundation.Events:OnMainMenuEnter()

method
Called when entering the main menu.

FrameworkZ.Foundation.Events:OnObjectLeftMouseButtonDown(object, x, y)

method
Called when the left mouse button is pressed down on an object.

Parameters

object 📦 object
The object that was clicked.
x 🔢 integer
The X coordinate of the click.
y 🔢 integer
The Y coordinate of the click.

FrameworkZ.Foundation.Events:OnPlayerDeath(player)

method
Called when a player dies.

Parameters

player 📦 object
The player object that died.

FrameworkZ.Foundation.Events:OnPreFillInventoryObjectContextMenu(playerID, context, items)

method
Called before filling an inventory object's context menu.

Parameters

playerID 🔢 integer
The player ID.
context 📦 object
The context menu object.
items 📋 table
The items being examined.

FrameworkZ.Foundation.Events:OnReceiveGlobalModData(key, data)

method
Called when global mod data is received.

Parameters

key 📝 string
The key of the data received.
data 🏷️ mixed
The data that was received.

FrameworkZ.Foundation.Events:OnResetLua(reason)

method
Called when the Lua state is reset.

Parameters

reason 📝 string
The reason for the reset.

FrameworkZ.Foundation.Events:OnServerCommand(module, command, arguments)

method
Handles server commands received on the client.

Parameters

module 📝 string
The module name that sent the command.
command 📝 string
The command that was sent.
arguments 📋 table
The arguments that were sent with the command.

FrameworkZ.Foundation.Events:OnServerStarted()

method
Called when the server starts.

FrameworkZ.Foundation:AddAllHookHandlers(hookName)

method
Add a new hook handler to the list for all categories.

Parameters

hookName 📝 string
The name of the hook handler to add.

FrameworkZ.Foundation:AddChannel(key)

method
Add a new channel to the network system. Channels are used to subscribe to; changes in values, or fire events.

Parameters

key 📝 string
or \table The key to use for the channel. Use a table to create nested channels. \see FrameworkZ.Foundation::Subscribe for an example on how to supply a table as a key.

FrameworkZ.Foundation:AddHookHandler(hookName, category)

method
Add a new hook handler to the list.

Parameters

hookName 📝 string
The name of the hook handler to add.
category 📝 string
The category of the hook (framework, module, plugin, generic). Defaults to HOOK_CATEGORY_GENERIC if not specified.

FrameworkZ.Foundation:Broadcast(namespace, keys, remove)

method
Broadcasts updated or removed data to all clients.

Parameters

namespace 📝 string
The namespace containing the data.
key 📝 string
The key being broadcast.
remove ✅ boolean
Whether this is a removal operation.

FrameworkZ.Foundation:CleanupConfirmations(timeout)

method
Cleans up pending confirmations that have not been confirmed within a timeout period.

Parameters

timeout 🔢 number
The timeout in seconds to clean up pending confirmations. Default: 300 seconds (5 minutes).

FrameworkZ.Foundation:ClearBatchSyncQueue(isoPlayer)

method
Clear the sync queue for a player.

Parameters

isoPlayer 📦 object
The player whose queue to clear.

FrameworkZ.Foundation:EveryDays()

method
TODO move to shared timer hook

FrameworkZ.Foundation:ExecuteAllHooks(hookName, ...)

method
Execute all of the hooks.

Parameters

hookName 📝 string
The name of the hook.

FrameworkZ.Foundation:ExecuteFrameworkHooks(hookName, ...)

method
Execute the framework hooks.

Parameters

hookName 📝 string
The name of the hook.

FrameworkZ.Foundation:ExecuteGamemodeHooks(hookName, ...)

method
Execute the gamemode hooks.

Parameters

hookName 📝 string
The name of the hook.

FrameworkZ.Foundation:ExecuteGenericHooks(hookName, ...)

method
Execute generic hooks.

Parameters

hookName 📝 string
The name of the hook.

FrameworkZ.Foundation:ExecuteHook(hookName, category, ...)

method
Execute a given hook by its hook name for its given category.

Parameters

hookName 📝 string
The name of the hook.
category 📝 string
The category of the hook (framework, module, plugin, generic). Defaults to HOOK_CATEGORY_GENERIC if not specified.

📝 Notes

When a function is defined and registered as a hook, sometimes it's as an object. However in the definition it could be as some.func() or some:func() (notice the period and colon between the examples). If the function is defined as some:func() then the object is passed as the first argument. If the function is defined as some.func() then the object is not passed as the first argument, in which case we would also need to define some.func_PassOverHookableObject function which must return \boolean true. This tells the hook system to not supply the object as the first argument if the function is apart of an object in the first place. Generic function hooks do not store an object and so do not have to worry about defining that additional property on its own function.

FrameworkZ.Foundation:ExecuteModuleHooks(hookName, ...)

method
Execute module hooks.

Parameters

hookName 📝 string
The name of the hook.

FrameworkZ.Foundation:ExecutePluginHooks(hookName, ...)

method
Execute plugin hooks.

Parameters

hookName 📝 string
The name of the hook.

FrameworkZ.Foundation:Fire(key, data, arguments)

method
Fires a callback for a key. This will call the callback for the key with the value supplied.

Parameters

key 📝 string
The key to fire the callback for. Use a \table to fire the callback for nested values. \see FrameworkZ.Foundation::Subscribe for an example on how to supply a table as a key.
data 📋 table
The standard data to pass to the callback. Generally contains diagnostic information.
arguments 📋 table
The values to pass to the callback. This can be any type of values stored in the table.

Returns

📋 table
A table of return values from the callbacks. The keys are the IDs of the callbacks and the values are the return values from the callbacks.

FrameworkZ.Foundation:GetChannel(key)

method
Get the channel for a key. This will return the channel data for the key.

Parameters

key 📝 string
or \table The key to use for the channel. Use a table to create nested channels. \see FrameworkZ.Foundation::Subscribe for an example on how to supply a table as a key.

Returns

📋 table
The channel data for the key.

FrameworkZ.Foundation:GetChannelMeta(key)

method
Get the meta data for a channel. This will return the meta data for the key.

Parameters

key 📝 string
or \table The key to use for the channel. Use a table to create nested channels. \see FrameworkZ.Foundation::Subscribe for an example on how to supply a table as a key.

Returns

📋 table
The meta data for the key.

FrameworkZ.Foundation:GetData(isoPlayer, namespace, keys, subscriptionID, callback)

method
Gets a value from a namespace by key(s).

Parameters

isoPlayer 📦 object
(Optional) The player to get the value for. This is only used on the client to send a request to the server.
namespace 📝 string
The namespace to get the value from.
keys 📝 string
or \table The key(s) to get the value for. Supplying a table will do a lookup through all keys and get value at the last index.
subscriptionID 📝 string
(Optional) A unique identifier for the subscription to be fired server-side after the value has been retrieved.
callback ⚡ function
(Optional) A callback function to call after the value is retrieved. This is only used on the client to handle the response from the server.

Returns

🌟 any
(except \function) The value for the key in the namespace, or false if the namespace or key does not exist. Server-side only.

📝 Notes

If called on the client, the value may only be accessed in the callback immediately, or later after data has synchronized.

FrameworkZ.Foundation:GetLocalData(namespace, keys)

method
Gets data from local storage using namespace and keys.

Parameters

namespace 📝 string
The namespace to retrieve data from.
keys 📝 string
or \table The key(s) to retrieve. If table, performs nested lookup.

Returns

🏷️ mixed
The retrieved data, or an error code if not found.

FrameworkZ.Foundation:GetModule(moduleName)

method
Get a module by name.

Parameters

moduleName 📝 string
The name of the module.

Returns

📦 object | ✅ boolean
The module object or false if the module was not found.

FrameworkZ.Foundation:GetModuleMetaObject(moduleName)

method
Get a module's meta object stored on a module. Not every module will have a meta object. This is a very specific use case and is used for getting instantiable objects such as PLAYER objects or CHARACTER objects.

Parameters

moduleName 📝 string
The name of the module.

Returns

📦 object
The meta object stored on the module or false if nothing was found.

FrameworkZ.Foundation:GetNamespace(namespace)

method
Retrieves the entire namespace table.

Parameters

namespace 📝 string
The namespace to retrieve.

Returns

📋 table
The namespace table or nil if not found.

FrameworkZ.Foundation:GetNestedValue(root, path)

method
Get a nested value from a table using a path. This is used to get values from nested tables.

Parameters

root 📋 table
The root table to get the value from.
path 📋 table
The path to the value. This is a table of keys to traverse the nested tables.

Returns

🏷️ mixed
The value at the end of the path, or nil if the path does not exist.

📝 Notes

Example path argument: {"key", "subkey"} == root["key"]["subkey"]

FrameworkZ.Foundation:GetSubscribers(key)

method
Get the subscribers for a key. This will return the subscribers for the key.

Parameters

key 📝 string
The key to get the subscribers for. Use a \table to get the subscribers for nested values. \see FrameworkZ.Foundation::Subscribe for an example on how to supply a table as a key.

Returns

📋 table
The subscribers for the key.

FrameworkZ.Foundation:GetVersion()

method
Get the version of FrameworkZ Foundation.

Returns

📝 string
The version of the FrameworkZ Foundation.

FrameworkZ.Foundation:HasChannel(key)

method
Check if a channel exists for a key. This will return true if the channel exists, false otherwise.

Parameters

key 📝 string
or \table The key to use for the channel. Use a table to create nested channels. \see FrameworkZ.Foundation::Subscribe for an example on how to supply a table as a key.

Returns

✅ boolean
True if the channel exists, false otherwise.

FrameworkZ.Foundation:HasSubscription(key, id)

method
Check if a subscription exists for a key. This will return true if the subscription exists, false otherwise.

Parameters

key 📝 string
The key to check for. Use a \table to check for nested values. \see FrameworkZ.Foundation::Subscribe for an example on how to supply a table as a key.
id 📝 string
The ID of the function callback being checked.

Returns

✅ boolean
True if the subscription exists, false otherwise.

FrameworkZ.Foundation:Initialize()

method
Initializes the FrameworkZ Foundation system by setting up event handlers and registering them with the Project Zomboid event system.

📝 Notes

The LoadGridSquare event is not added to the hook system for performance reasons, as it is called very frequently.

This function wraps the Project Zomboid Events system to integrate with the FrameworkZ hook system, allowing all foundation events to be processed through the hook mechanism.

FrameworkZ.Foundation:InitializeClient(isoPlayer)

method
Main client initialization function. Sets up player state and communicates with the server.

Parameters

isoPlayer 📦 object
The player object being initialized.

FrameworkZ.Foundation:InitializePlayer(isoPlayer, playerData, charactersData)

method
Initializes a player with framework data and sets up their initial state.

Parameters

isoPlayer 📦 object
The player's ISO object.
playerData 📋 table
(Optional) Existing player data for restoration.
charactersData 📋 table
(Optional) Existing character data for restoration.

Returns

✅ boolean
\table, \table Returns success status, player data, and character data.

FrameworkZ.Foundation:LogChannels()

method
Log all channels and their subscribers to the console. This is useful for debugging and understanding the network system.

FrameworkZ.Foundation:NewModule(moduleObject, moduleName)

method
Create a new module for the FrameworkZ framework.

Parameters

moduleObject 📦 object
The object to use as the module.
moduleName 📝 string
The name of the module.

Returns

📦 object
The new module.

FrameworkZ.Foundation:OnClientCommand(module, command, isoPlayer, arguments)

method
Handles incoming commands from the client on the server.

Parameters

module 📝 string
The name of the module that sent the command. This should match the NetworksName defined in FrameworkZ.Foundation.NetworksName.
command 📝 string
The command that was sent by the client.
isoPlayer 📦 object
The player that sent the command. This is the player object that sent the command.
arguments 📋 table
The arguments that were sent with the command. This contains the data needed to process the command.

📝 Notes

This function is called on the server when a client sends a command to the server. It processes the command and sends a response back to the client using the networking system.

FrameworkZ.Foundation:OnGameStart()

method
Called when the game starts. Executes the OnGameStart function for all modules.

FrameworkZ.Foundation:OnServerCommand(module, command, arguments)

method
Handles incoming commands from the server on the client.

Parameters

module 📝 string
The name of the module that sent the command. This should match the NetworksName defined in FrameworkZ.Foundation.NetworksName.
command 📝 string
The command that was sent by the server.
arguments 📋 table
The arguments that were sent with the command. This contains the data needed to process the command.

📝 Notes

This function is called on the client when the server sends a command to the client. It processes the command and sends a response back to the server using the networking system.

FrameworkZ.Foundation:OnServerStarted()

method
Callback for when the server starts. Initializes server-side tick systems.

FrameworkZ.Foundation:PathToString(path)

method
Convert a path to a string. This is used to convert a table path to a string path.

Parameters

path 📝 string
or \table The path to convert. If a string is supplied, it will be returned as is. If a table is supplied, it will be concatenated with dots.

Returns

📝 string
The string representation of the path.

FrameworkZ.Foundation:PostInitializeClient(player)

method
Post-initialization phase that completes the client setup and shows success notification.

Parameters

player 📦 object
The framework player object that has been initialized.

FrameworkZ.Foundation:PreInitializeClient(isoPlayer)

method
Pre-initialization phase for client setup. Sets up the UI and executes module hooks.

Parameters

isoPlayer 📦 object
The player object being initialized.

FrameworkZ.Foundation:ProcessSaveableData(object, ignoreList, encodeList)

method
Processes an object to extract saveable data, filtering out functions and handling nested objects.

Parameters

object 📋 table
The object to process for saving.
ignoreList 📋 table
List of keys to ignore during processing.
encodeList 📋 table
List of keys that should be encoded using their GetSaveableData method.

Returns

📋 table
The processed saveable data.

FrameworkZ.Foundation:QueueBatchSync(isoPlayer, namespace, key)

method
Queue a key in a namespace for batch synchronization.

Parameters

isoPlayer 📦 object
The player to queue sync for.
namespace 📝 string
The namespace containing the data.
key 📝 string
The key to sync.

FrameworkZ.Foundation:RegisterFramework()

method
Register FrameworkZ. This is called after framework definition.

FrameworkZ.Foundation:RegisterFrameworkHandler()

method
Register hook handlers for the framework.

FrameworkZ.Foundation:RegisterGamemodeHandler(gamemode)

method
Register hook handlers for the gamemode.

Parameters

gamemode 📋 table
The gamemode table containing the functions.

FrameworkZ.Foundation:RegisterGenericHandler()

method
Register generic hook handlers that don't belong to a specific object.

FrameworkZ.Foundation:RegisterHandler(hookName, handler, object, functionName, category)

method
Register a handler for a hook.

Parameters

hookName 📝 string
The name of the hook.
handler ⚡ function
The function to call when the hook is executed.
object (optional) 📋 table
The object containing the function.
functionName (optional) 📝 string
The name of the function to call.
category 📝 string
The category of the hook (framework, module, plugin, generic). Defaults to HOOK_CATEGORY_GENERIC if not specified.

FrameworkZ.Foundation:RegisterHandlers(objectOrHandlers, category)

method
Register handlers for a specific category.

Parameters

objectOrHandlers 📋 table
The object containing the functions, or nil for generic handlers.
category 📝 string
The category of the hook (framework, module, plugin, generic). Defaults to HOOK_CATEGORY_GENERIC if not specified.

FrameworkZ.Foundation:RegisterModule(module)

method
Register a module for FrameworkZ. This is called after module definition.

Parameters

module 📦 object
The module to register.

FrameworkZ.Foundation:RegisterModuleHandler(module)

method
Register hook handlers for a module.

Parameters

module 📋 table
The module table containing the functions.

FrameworkZ.Foundation:RegisterNamespace(name)

method
Registers a storage namespace, e.g., "Players"

Parameters

name 📝 string
The name of the namespace to register.

📝 Notes

This must be used in the shared scope within an OnInitGlobalModData function.

FrameworkZ.Foundation:RegisterPluginHandler(plugin)

method
Register hook handlers for a plugin.

Parameters

plugin 📋 table
The plugin table containing the functions.

FrameworkZ.Foundation:RemoveChannel(key)

method
Remove a channel from the network system. This will remove all subscribers and meta data for the channel.

Parameters

key 📝 string
or \table The key to use for the channel. Use a table to create nested channels. \see FrameworkZ.Foundation::Subscribe for an example on how to supply a table as a key.

FrameworkZ.Foundation:RemoveData(namespace, key)

method
Removes a key from a namespace and broadcasts removal.

Parameters

namespace 📝 string
The namespace to remove from.
key 📝 string
The key to remove.

FrameworkZ.Foundation:RemoveHookHandler(hookName, category)

method
Remove a hook handler from the list.

Parameters

hookName 📝 string
The name of the hook handler to remove.
category 📝 string
The category of the hook (framework, module, plugin, generic). Defaults to HOOK_CATEGORY_GENERIC if not specified.

FrameworkZ.Foundation:RestoreData(isoPlayer, command, namespace, keys, callback)

method
Restores data from storage for client-server synchronization.

Parameters

isoPlayer 📦 object
The player object.
command 📝 string
The command identifier.
namespace 📝 string
The namespace to restore from.
keys 📝 string
or \table The key(s) to restore.
callback ⚡ function
Callback function to handle the restored data.

Returns

✅ boolean
Returns true if successful on server, varies on client.

FrameworkZ.Foundation:RestorePlayer(isoPlayer, player, username, playerData, charactersData)

method
Restores player data from storage or creates new data if none exists.

Parameters

isoPlayer 📦 object
The player's ISO object.
player 📦 object
The framework player object.
username 📝 string
The player's username.
playerData 📋 table
(Optional) Existing player data on client-side.
charactersData 📋 table
(Optional) Existing character data on client-side.

Returns

📋 table
\table The player data and character data, or false if new.

FrameworkZ.Foundation:SaveData(isoPlayer)

method
Saves all namespace data to persistent storage.

Parameters

isoPlayer 📦 object
(Optional) The player object. Used on client to send request to server.

FrameworkZ.Foundation:SaveNamespace(isoPlayer, namespace)

method
Saves a specific namespace to persistent storage.

Parameters

isoPlayer 📦 object
(Optional) The player object. Used on client to send request to server.
namespace 📝 string
The namespace to save.

FrameworkZ.Foundation:SendFire(isoPlayer, subscriptionID, callback, ...)

method
Sends a fire event to the server or client. This is used to send events to subscribers.

Parameters

isoPlayer 📦 object
The player sending the fire event. If nil, the event will be fired but no confirmation will be sent back (send and forget).
subscriptionID 📝 string
The ID of the subscription to fire. This is the key used to subscribe to the event. It's recommended to use a string matching your function's callback name in a unique way when adding a subscription.
callback ⚡ function
The callback to call when the server confirms the fire event. This is optional and can be nil if you don't need confirmation.

Returns

📝 string
The request ID for the fire event. This can be used to track the request and get confirmation later.

FrameworkZ.Foundation:SendGet(key, callback, callbackID, broadcast, ...)

method
Sends a get request to the server.

Parameters

key 🏷️ mixed
The key to get. Does not support getting functions.
callback ⚡ function
The callback to call on the client when the server returns the value.
callbackID 📝 string
The key to use for the callback on the server after getting the value.
broadcast ✅ boolean
Whether to broadcast the get callback to all clients.

FrameworkZ.Foundation:SendSet(key, value, callback, callbackID, broadcast)

method
Sends a set request to the server.

Parameters

key 📝 string
or \table The key to set. Use a table to set nested values. \note Example key argument as a table: {"key", "subkey"} == _G["key"]["subkey"] or _G.key.subkey on lookup when setting.
value 🏷️ mixed
The value to set. Does not support functions.
callback ⚡ function
The callback to call on the client when the server confirms the set.
callbackID 📝 string
The key to use for the callback on the server after setting the value.
broadcast ✅ boolean
Whether to broadcast the set callback to all clients.

FrameworkZ.Foundation:ServerTick()

method
Server tick handler that manages periodic data saving.
This prevents redundant writes and ensures data is saved as soon as it changes.

📝 Notes

Periodic saves are now disabled since SetData() persists immediately.

FrameworkZ.Foundation:SetData(isoPlayer, namespace, keys, value, subscriptionID, broadcast, callback)

method
Sets a value in a namespace and (optionally) broadcasts to all clients.

Parameters

isoPlayer 📦 object
(Optional when called server-side only) The player to set the value for. This is only used on the client to send a request to the server.
namespace 📝 string
The namespace to set the value in.
keys 📝 string
or \table The key(s) to set the value for. Supplying a table will do a lookup through all keys and set value at the last index.
value 🌟 any
(except \function) The value to set.
subscriptionID 📝 string
(Optional) A unique identifier for the subscription to be fired server-side after the value has been set.
broadcast ✅ boolean
(Optional) Whether or not to broadcast the value to all clients.
callback ⚡ function
(Optional) A callback function to call after the value is set. This is only used on the client to handle the response from the server.

Returns

✅ boolean
Whether or not the value was set successfully. Server-side only.

📝 Notes

If called on the client, the value may only be accessed in the callback immediately, or later after data has synchronized.

FrameworkZ.Foundation:SetLocalData(namespace, keys, value)

method
Sets data in local storage using namespace and keys.

Parameters

namespace 📝 string
The namespace to store data in.
keys 📝 string
or \table The key(s) to set. If table, performs nested assignment.
value 🏷️ mixed
The value to store.

Returns

✅ boolean
Returns true if successful, false otherwise.

FrameworkZ.Foundation:SetNestedValue(root, path, value)

method
Set a nested value in a table using a path. This is used to set values in nested tables.

Parameters

root 📋 table
The root table to set the value in.
path 📋 table
The path to the value. This is a table of keys to traverse the nested tables.
value 🏷️ mixed
The value to set at the end of the path.

Returns

🏷️ mixed
The value that was set at the end of the path.

📝 Notes

Example path argument: {"key", "subkey"} == root["key"]["subkey"] = value

FrameworkZ.Foundation:StartBatchSync(isoPlayer, interval, onComplete)

method
Begin processing the queued keys for a player with a timer-based batch system.

Parameters

isoPlayer 📦 object
The player to sync data for.
interval 🔢 number
(Optional) The interval between sync operations. Default: 0.1 seconds.
onComplete ⚡ function
(Optional) Callback to call when sync is complete.

FrameworkZ.Foundation:StartServerTick()

method
Starts the server tick system that manages timers and periodic operations.

FrameworkZ.Foundation:Subscribe(key, idOrCallback, maybeCallback)

method
Subscribes to a key to listen for changes with the first three arguments supplied, or can be used for sending/receiving fire events with the first two arguments supplied.

Parameters

key 📝 string
The key to subscribe to. Use a \table to subscribe to nested values. \note Example key argument as a table: {"key", "subkey"} == _G["key"]["subkey"] or _G.key.subkey on lookup when subscribing.
idOrCallback 📝 string
or \function The ID of the function callback being added, or the callback function itself. If a string is supplied, it will be used as the ID for the callback.
maybeCallback ⚡ function
The callback function to call when the key changes. This is optional if the first argument is a function.

Returns

⚡ function
The callback function that was added. This can be used to unsubscribe later.

FrameworkZ.Foundation:SyncToPlayer(isoPlayer, namespace, keys, value)

method
Sends a specific key to a specific player.

Parameters

isoPlayer 📦 object
The player to send the data to.
namespace 📝 string
The namespace containing the data.
key 📝 string
The key to send.

FrameworkZ.Foundation:TeleportToLimbo(isoPlayer)

method
Teleports a player to the configured limbo location.

Parameters

isoPlayer 📦 object
The player object to teleport.

Returns

✅ boolean
Returns true if successful, false if the player object is invalid.

FrameworkZ.Foundation:UnregisterFrameworkHandler()

method
Unregister hook handlers for the framework.

FrameworkZ.Foundation:UnregisterGamemodeHandler(gamemode)

method
Unregister hook handlers for the gamemode.

Parameters

gamemode 📋 table
The gamemode table containing the functions.

FrameworkZ.Foundation:UnregisterGenericHandler()

method
Unregister generic hook handlers that don't belong to a specific object.

FrameworkZ.Foundation:UnregisterHandler(hookName, handler, object, functionName, category)

method
Unregister a handler from a hook.

Parameters

hookName 📝 string
The name of the hook.
handler ⚡ function
The function to unregister.
object 📋 table
(Optional) The object containing the function.
functionName 📝 string
(Optional) The name of the function to unregister.
category 📝 string
The category of the hook (framework, module, plugin, generic). Defaults to HOOK_CATEGORY_GENERIC if not specified.

FrameworkZ.Foundation:UnregisterHandlers(objectOrHandlers, category)

method
Unregister handlers for a specific category.

Parameters

objectOrHandlers 📋 table
The object containing the functions, or nil for generic handlers.
category 📝 string
The category of the hook (framework, module, plugin, generic). Defaults to HOOK_CATEGORY_GENERIC if not specified.

FrameworkZ.Foundation:UnregisterModuleHandler(module)

method
Unregister hook handlers for a module.

Parameters

module 📋 table
The module table containing the functions.

FrameworkZ.Foundation:UnregisterPluginHandler(plugin)

method
Unregister hook handlers for a plugin.

Parameters

plugin 📋 table
The plugin table containing the functions.

FrameworkZ.Foundation:Unsubscribe(key, id)

method
Unsubscribes from a key. This will remove the callback from the channel.

Parameters

key 📝 string
The key to unsubscribe from. Use a \table to unsubscribe from nested values. \see FrameworkZ.Foundation::Subscribe for an example on how to supply a table as a key.
id 🏷️ sting
The ID of the function callback being removed. Default for fire events: "__default"

FrameworkZ.Foundation:Watch(key, id, callback)

method
Subscribes and fires callback immediately if the value is already set. Useful for UIs.

Parameters

key 📝 string
or \table The key to watch. Use a table to watch nested values. \see FrameworkZ.Foundation::Subscribe for an example on how to supply a table as a key.
id 📝 string
The ID of the function callback being added.
callback ⚡ function
The callback to call when the key changes.

FrameworkZ.Interfaces:Create(kind, options)

method
Factory helper for creating interface elements by kind string.

Parameters

kind 📝 string
The element type (Panel, Label, Button, Slider, Combo, ComboBox, TextEntry, TextBox).
options 📋 table
Options forwarded to the concrete creator.

Returns

❔ table?
The created element or nil if kind is unknown.

FrameworkZ.Interfaces:CreateButton(options)

method
Create a themed ISButton.

Parameters

options 📋 table
Position, size, title, callbacks, theme, overrides, parent.

Returns

📋 table
The initialized button.

FrameworkZ.Interfaces:CreateCombo(options)

method
Create a themed ISComboBox.

Parameters

options 📋 table
Position, size, options list, callbacks, theme, parent.

Returns

📋 table
The initialized combo box.

FrameworkZ.Interfaces:CreateComboBox(options)

method
Alias for CreateCombo.

FrameworkZ.Interfaces:CreateLabel(options)

method
Create a themed ISLabel with alignment helpers.

Parameters

options 📋 table
Position, text, theme, alignment, and parent options.

Returns

📋 table
The initialized label.

FrameworkZ.Interfaces:CreatePanel(options)

method
Create a themed ISPanel with optional overrides.

Parameters

options 📋 table
Position, size, theme, and parent options.

Returns

📋 table
The initialized panel.

FrameworkZ.Interfaces:CreateSlider(options)

method
Create a themed ISSliderPanel.

Parameters

options 📋 table
Position, size, min/max/step/value, callbacks, theme, parent.

Returns

📋 table
The initialized slider.

FrameworkZ.Interfaces:CreateTextBox(options)

method
Alias for CreateTextEntry.

FrameworkZ.Interfaces:CreateTextEntry(options)

method
Create a themed ISTextEntryBox (single or multiline).

Parameters

options 📋 table
Position, size, text, theme, multiline, parent, overrides.

Returns

📋 table
The initialized text entry.

FrameworkZ.Inventories:ApplyEquipmentColor(item, itemData)

method
Apply equipment color AFTER equipping to prevent randomization override

Parameters

item 🏷️ InventoryItem
The equipped item
itemData 📋 table
The item data containing color information

Returns

✅ boolean
True if color was applied

FrameworkZ.Inventories:ExtractBasicProperties(item, itemData)

method
Extract basic item properties (condition, weight, uses)

Parameters

item 🏷️ InventoryItem
The item to extract from
itemData 📋 table
The data table to populate

FrameworkZ.Inventories:ExtractClothingProperties(item, itemData)

method
Extract clothing-specific properties (dirty, wet, bloody, holes, patches)

Parameters

item 🏷️ InventoryItem
The item to extract from
itemData 📋 table
The data table to populate

FrameworkZ.Inventories:ExtractColorData(item, itemData)

method
Extract color/tint information (prefers visual tint for clothing)

Parameters

item 🏷️ InventoryItem
The item to extract from
itemData 📋 table
The data table to populate

FrameworkZ.Inventories:ExtractContainerProperties(item, itemData)

method
Extract container-specific properties (capacity, contents with recursive extraction)

Parameters

item 🏷️ InventoryItem
The item to extract from
itemData 📋 table
The data table to populate

FrameworkZ.Inventories:ExtractFoodProperties(item, itemData)

method
Extract food-specific properties (freshness, age, frozen state)

Parameters

item 🏷️ InventoryItem
The item to extract from
itemData 📋 table
The data table to populate

FrameworkZ.Inventories:ExtractItemData(item)

method
Extract comprehensive item data by calling all category-specific extractors

Parameters

item 🏷️ InventoryItem
The item to extract data from

Returns

📋 table
Comprehensive item data

FrameworkZ.Inventories:ExtractLiteratureProperties(item, itemData)

method
Extract literature-specific properties (pages, locks, writing)

Parameters

item 🏷️ InventoryItem
The item to extract from
itemData 📋 table
The data table to populate

FrameworkZ.Inventories:ExtractModData(item, itemData)

method
Extract ModData from an item

Parameters

item 🏷️ InventoryItem
The item to extract from
itemData 📋 table
The data table to populate

FrameworkZ.Inventories:ExtractWeaponProperties(item, itemData)

method
Extract weapon-specific properties (ammo, magazine, bullets)

Parameters

item 🏷️ InventoryItem
The item to extract from
itemData 📋 table
The data table to populate

FrameworkZ.Inventories:GetInventoryByID(id)

method
Get an inventory by its ID.

Parameters

id 🔢 integer
The inventory's ID.

Returns

📋 table | ✅ boolean
The inventory object or false if not found.
📝 string
Error message if not found.

FrameworkZ.Inventories:GetItemByUniqueID(inventoryID, uniqueID)

method
Get an item by its unique ID from a specific inventory.

Parameters

inventoryID 🔢 integer
The inventory's ID to search in.
uniqueID 📝 string
The item's unique ID.

Returns

📋 table | ✅ boolean
The item object or false if not found.
📝 string
Error message if not found.

FrameworkZ.Inventories:GetItemCountByID(inventoryID, uniqueID)

method
Get the count of items with a specific unique ID in an inventory.

Parameters

inventoryID 🔢 integer
The inventory's ID to search in.
uniqueID 📝 string
The item's unique ID.

Returns

🔢 integer | ✅ boolean
The count or false if inventory not found.
📝 string
Error message if failed.

FrameworkZ.Inventories:Initialize(id, object)

method
Initialize an inventory.

Parameters

id 📋 table
The inventory's id.
object 📋 table
The inventory's object.

Returns

🔢 integer
The inventory's ID.

FrameworkZ.Inventories:IsFrameworkZItemType(itemType)

method
Check if an item type is a FrameworkZ item (O(1) lookup)

Parameters

itemType 📝 string
The full item type (e.g., "Base.Hat_Beanie")

Returns

✅ boolean
True if it's a FrameworkZ item

FrameworkZ.Inventories:New(username, type, id)

method
Create a new inventory object.

Parameters

username 📝 string
The owner's username. Can be nil for no owner.
type 📝 string
The type of inventory. Can be nil, but creates a character inventory type by default. Refer to FrameworkZ.Inventories.Types table for available types.
id 📝 string
The inventory's ID. Can be nil for an auto generated ID (recommended).

Returns

📋 table
The new inventory object.

FrameworkZ.Inventories:Rebuild(isoPlayer, inventory, items)

method
Recursively traverses the inventory table for missing data while referencing the item definitions to rebuild the inventory.

Parameters

inventory 📋 table
The inventory to rebuild.

Returns

📋 table
The rebuilt inventory.

FrameworkZ.Inventories:Restore(character, inventoryData)

method
Restore character inventory and equipment data

Parameters

character 📋 table
The character object
inventoryData 📋 table
The saved inventory data

Returns

✅ boolean
Whether restoration was successful

FrameworkZ.Inventories:RestoreEquipment(character, inventoryData)

method
Restore all equipment (both physical and logical) for a character

Parameters

character 📋 table
The character object
inventoryData 📋 table
The complete inventory data containing equipment info

Returns

✅ boolean
Whether restoration was successful

FrameworkZ.Inventories:RestoreItemData(item, itemData)

method
Restore comprehensive item data from saved data

Parameters

item 🏷️ InventoryItem
The item to restore to
itemData 📋 table
The saved item data

Returns

✅ boolean
True if restoration was successful

FrameworkZ.Inventories:RestoreLogicalItems(character, logicalInventoryData)

method
Restore equipped FrameworkZ items (logical items) - DEPRECATED: Use RestoreEquipment instead

Parameters

character 📋 table
The character object
logicalInventoryData 📋 table
The logical inventory data containing equipped items

Returns

✅ boolean
Whether restoration was successful

FrameworkZ.Inventories:Save(character)

method
Save character inventory and equipment data

Parameters

character 📋 table
The character object with inventory

Returns

📋 table
The complete inventory data including equipment

FrameworkZ.Items:CreateItem(uniqueID, isoPlayer, callback)

method
Creates an item instance and links it to a world item.

Parameters

uniqueID 📝 string
The unique ID of the item to create.
isoPlayer 📦 object
The ISO Player to create the item for.
callback ⚡ function
(Optional) A callback function to execute after the item is created but before OnInstanced is called.

Returns

✅ boolean
\string \object \object Success status and message, also the item instance and world item.

FrameworkZ.Items:RemoveInstance(instanceID, username)

method
Removes an item instance from the game world and the item instance list.

Parameters

instanceID 🔢 integer
The instance ID of the item to remove.
username 📦 object
(Optional) The player's username whose inventory the item should be removed from.

Returns

✅ boolean
\string Success status and message.

FrameworkZ.Logs:AddLog(logType, message, player)

method
Add a log entry.

Parameters

logType 📝 string
The type of log (e.g., "PlayerAction", "SystemEvent").
message 📝 string
The log message.
player 📋 table
Optional player table associated with the log.

FrameworkZ.Logs:GetLogs(logType, player)

method
Retrieve log entries.

Parameters

logType 📝 string
Optional log type to filter by.
player 📝 string
Optional player username to filter by.

Returns

📋 table
A table of log entries.

FrameworkZ.Logs:LoadLogsFromFile(player)

method
Load log entries from a file.

Parameters

player 📝 string
The player username to load logs for.

FrameworkZ.Logs:OpenLogMenu()

method
Display logs in a menu for admins.

FrameworkZ.Logs:SaveLogToFile(logEntry)

method
Save a log entry to a file.

Parameters

logEntry 📋 table
The log entry to save.

FrameworkZ.Logs:SearchLogs(keyword)

method
Search log entries by keyword.

Parameters

keyword 📝 string
The keyword to search for.

Returns

📋 table
A table of log entries that contain the keyword.

FrameworkZ.Notifications:AddToQueue(message, notificationType, duration, ui)

method
Adds a notification to the queue.

Parameters

message 📝 string
The message to display.
notificationType 📝 string
The type of notification to display. See notification types.
duration 🔢 integer
The duration the notification should be displayed for.
ui 📦 object
The UI object that would cover where notifications display. Useful if you want to display notifications over top of a specific UI object.

Returns

📦 object
The notification UI object.

FrameworkZ.Optimizations:ApplyFullSync(update)

method
Apply full sync update (client-side)

FrameworkZ.Optimizations:ApplyPositionUpdate(update)

method
Apply position update (client-side)

FrameworkZ.Optimizations:ApplyStatsUpdate(update)

method
Apply stats update (client-side)

FrameworkZ.Optimizations:ApplySyncUpdate(update)

method
Apply a sync update (client-side)

FrameworkZ.Optimizations:CalculateDistance(pos1, pos2)

method
Calculate distance between two positions

FrameworkZ.Optimizations:CleanupCache()

method
Clean up old cache entries

FrameworkZ.Optimizations:CompressData(data)

method
Compress data for transmission

FrameworkZ.Optimizations:EnableClientPrediction()

method
Enable client-side prediction

FrameworkZ.Optimizations:EstimateDataSize(data)

method
Estimate size of data in bytes

FrameworkZ.Optimizations:GetMetrics()

method
Get current metrics

FrameworkZ.Optimizations:HandleClientSync(command, player, args)

method
Handle client sync requests (server-side)

FrameworkZ.Optimizations:HandleServerSync(command, args)

method
Handle sync updates from server (client-side)

FrameworkZ.Optimizations:Initialize()

method
Initialize the optimizations module

FrameworkZ.Optimizations:InitializeClient()

method
Initialize client-side optimizations

FrameworkZ.Optimizations:InitializeServer()

method
Initialize server-side optimizations

FrameworkZ.Optimizations:InterpolatePosition(player, update)

method
Interpolate position for smooth movement

FrameworkZ.Optimizations:OnPlayerMove(player)

method
Handle player movement events

FrameworkZ.Optimizations:OnPlayerUpdate(player)

method
Handle player update events

FrameworkZ.Optimizations:OnTick()

method
Main tick update loop

FrameworkZ.Optimizations:PerformFullResync()

method
Perform a full resync of all players

FrameworkZ.Optimizations:ProcessBatchQueue()

method
Process the batch queue

FrameworkZ.Optimizations:QueuePositionSync(player)

method
Queue a position sync for a player

FrameworkZ.Optimizations:RequestFullResync(username)

method
Request a full resync from server (client-side)

FrameworkZ.Optimizations:ResetMetrics()

method
Reset metrics

FrameworkZ.Optimizations:SendBatchUpdate(batch)

method
Send a batched update to clients

FrameworkZ.Optimizations:SendFullPlayerSync(player)

method
Send full player sync data

FrameworkZ.Optimizations:SendSyncUpdate(data)

method
Send a single sync update

FrameworkZ.Optimizations:Shutdown()

method
Shutdown the optimizations module

FrameworkZ.Optimizations:UpdateCacheTimestamp(username)

method
Update cache timestamp

FrameworkZ.Optimizations:UpdateMetrics()

method
Update and log metrics

FrameworkZ.Players:CreateCharacterSaveInterval()

method
Create the character auto-save interval timer.

FrameworkZ.Players:GetAllPlayers()

method
Get all registered players.

Returns

📋 table
Table of all PLAYER objects indexed by username.

FrameworkZ.Players:GetCharacterDataByID(username, characterID, callback)

method
Gets saved character data by their ID.

Parameters

username 📝 string
The username of the player.
characterID 🔢 integer
The ID of the character.
callback ⚡ function
(Optional) Callback function for async handling.

Returns

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

FrameworkZ.Players:GetLoadedCharacterByID(username)

method
Get the loaded character for a specific player.

Parameters

username 📝 string
The username of the player.

Returns

🏷️ CHARACTER | ✅ boolean
The loaded CHARACTER object or false if not found or no character loaded.

FrameworkZ.Players:GetNextCharacterID(username)

method
Get the next available character ID for a player.

Parameters

username 📝 string
The username of the player.

Returns

🔢 number | ✅ boolean
The next character ID or false if max characters reached or player not found.
❔ string?
Error message if applicable.

FrameworkZ.Players:GetPlayerByID(username)

method
Gets the player object by their username.

Parameters

username 📝 string
The username of the player.

Returns

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

FrameworkZ.Players:Initialize(isoPlayer)

method
Initialize a player and add them to the player list.

Parameters

isoPlayer 🏷️ IsoPlayer
The Project Zomboid IsoPlayer object to initialize.

Returns

🏷️ PLAYER | ✅ boolean
The initialized PLAYER object or false if creation failed.

FrameworkZ.Players:New(isoPlayer)

method
Create a new PLAYER object.

Parameters

isoPlayer 🏷️ IsoPlayer
The Project Zomboid IsoPlayer object to create a player for.

Returns

🏷️ PLAYER | ✅ boolean
The new PLAYER object or false if isoPlayer is nil.

FrameworkZ.Players:ResetCharacterSaveInterval()

method
Reset the character auto-save interval timer.

FrameworkZ.Players:Save(username, continueOnFailure, callback)

method
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.

FrameworkZ.Players:StartPlayerTick(player)

method
Start the player tick system for executing periodic player updates.

Parameters

player 🏷️ PLAYER
The player object to start ticking for.

FrameworkZ.Plugins:AddEventHandler(eventName)

method
Add a new event handler to the list.

Parameters

eventName 📝 string
The name of the event handler to add.

FrameworkZ.Plugins:ExecuteCommand(commandName, ...)

method
Execute a custom command.

Parameters

commandName 📝 string
The name of the command.

FrameworkZ.Plugins:ExecutePluginHook(hookName, ...)

method
Execute a hook for all loaded plugins.

Parameters

hookName 📝 string
The name of the hook to execute.

FrameworkZ.Plugins:Initialize()

method
Initialize the Plugins module - loads all registered plugins.

FrameworkZ.Plugins:LoadAllPlugins()

method
Load all registered plugins.

FrameworkZ.Plugins:LoadPlugin(pluginName)

method
Load a registered plugin.

Parameters

pluginName 📝 string
The name of the plugin to load.

FrameworkZ.Plugins:Log(message)

method
Log a message for debugging purposes.

Parameters

message 📝 string
The message to log.

FrameworkZ.Plugins:RegisterCommand(commandName, callback)

method
Register a custom command for a plugin.

Parameters

commandName 📝 string
The name of the command.
callback ⚡ function
The function to call when the command is executed.

FrameworkZ.Plugins:RegisterPlugin(plugin, overwrite)

method
Register a plugin.

Parameters

pluginName 📝 string
The name of the plugin.
pluginTable 📋 table
The table containing the plugin's functions and data.
metadata 📋 table
Optional metadata for the plugin.

FrameworkZ.Plugins:RegisterPluginEventHandlers(plugin)

method
Register event handlers for a plugin.

Parameters

plugin 📋 table
The plugin table containing the functions.

FrameworkZ.Plugins:RemoveEventHandler(eventName)

method
Remove an event handler from the list.

Parameters

eventName 📝 string
The name of the event handler to remove.

FrameworkZ.Plugins:UnloadPlugin(pluginName)

method
Unload a loaded plugin.

Parameters

pluginName 📝 string
The name of the plugin to unload.

FrameworkZ.Plugins:UnregisterPluginEventHandlers(plugin)

method
Unregister event handlers for a plugin.

Parameters

plugin 📋 table
The plugin table containing the functions.

FrameworkZ.Plugins:UnregisterPluginHook(pluginName, hookName)

method
Unregister a specific hook for a plugin.

Parameters

pluginName 📝 string
The name of the plugin.
hookName 📝 string
The name of the hook to unregister.

FrameworkZ.Roles:AssignRole(username, roleId)

method
Assign a role to a player

Parameters

username 🏷️ Player
username
roleId 🏷️ Role
ID to assign

Returns

✅ boolean
Success status

FrameworkZ.Roles:CachePermission(username, permission, result)

method
Cache a permission check result

FrameworkZ.Roles:ClearPermissionCache(username)

method
Clear permission cache

FrameworkZ.Roles:CountAssignedPlayers()

method
Count players with role assignments

Returns

🔢 number
Count

FrameworkZ.Roles:GetAllPermissions(username)

method
Get all permissions for a player (including inherited)

Parameters

username 🏷️ Player
username

Returns

📋 table
Map of permission -> true

FrameworkZ.Roles:GetAllRoles()

method
Get all registered roles

Returns

📋 table
Map of roleId -> role data

FrameworkZ.Roles:GetFormattedRoleName(roleId)

method
Get formatted role name with color for display

Parameters

roleId 🏷️ Role
ID

Returns

📝 string
Formatted name

FrameworkZ.Roles:GetPlayerRoles(username)

method
Get all roles assigned to a player

Parameters

username 🏷️ Player
username

Returns

📋 table
Array of role IDs

FrameworkZ.Roles:GetPlayersWithRole(roleId)

method
Get all players with a specific role

Parameters

roleId 🏷️ Role
ID

Returns

📋 table
Array of usernames

FrameworkZ.Roles:GetPrimaryRole(username)

method
Get the highest priority role for a player

Parameters

username 🏷️ Player
username

Returns

❔ table?
Role data

FrameworkZ.Roles:GetRole(roleId)

method
Get a role by ID

Parameters

roleId 🏷️ Role
ID

Returns

❔ table?
Role data

FrameworkZ.Roles:GetRoleColor(roleId)

method
Get role color

Parameters

roleId 🏷️ Role
ID

Returns

📋 table
{r, g, b} or nil

FrameworkZ.Roles:GetRoleCount()

method
Get count of registered roles

Returns

🔢 number
Count

FrameworkZ.Roles:HasPermission(username, permission)

method
Check if a player has a specific permission

Parameters

username 🏷️ Player
username (or IsoPlayer object)
permission 🏷️ Permission
string (supports wildcards)

Returns

✅ boolean
Has permission

FrameworkZ.Roles:HasRole(username, roleId)

method
Check if a player has a specific role

Parameters

username 🏷️ Player
username
roleId 🏷️ Role
ID

Returns

✅ boolean
Has role

FrameworkZ.Roles:Initialize()

method
Initialize the Roles module

FrameworkZ.Roles:LoadCustomRoles()

method
Load custom roles from role definition files

FrameworkZ.Roles:LoadPlayerRoles()

method
Load player role assignments from save data

FrameworkZ.Roles:MatchesWildcard(permission, pattern)

method
Check if a permission matches a wildcard pattern

Parameters

permission 🏷️ Permission
to check
pattern 🏷️ Pattern
with wildcards (e.g., "chat.*")

Returns

✅ boolean
Matches

FrameworkZ.Roles:RegisterDefaultRoles()

method
Register the default built-in roles

FrameworkZ.Roles:RegisterRole(roleData)

method
Register a new role

Parameters

roleData 🏷️ Table
containing role definition

Returns

✅ boolean
Success status

FrameworkZ.Roles:RemoveRole(username, roleId)

method
Remove a role from a player

Parameters

username 🏷️ Player
username
roleId 🏷️ Role
ID to remove

Returns

✅ boolean
Success status

FrameworkZ.Roles:SavePlayerRoles()

method
Save player role assignments

FrameworkZ.Roles:UnregisterRole(roleId)

method
Unregister a role

Parameters

roleId 🏷️ Role
ID

Returns

✅ boolean
Success

FrameworkZ.Roles:UpdateRoleHierarchy(role)

method
Update role hierarchy for inheritance

FrameworkZ.Timers:Simple(delay, func)

method
Creates a simple timer that executes a function after a delay.

Parameters

integer 🏷️ delay
The delay in seconds before the function is executed.
function 🏷️ func
The function to execute after the delay.

FrameworkZ.Utilities:CopyTable(originalTable, tableCopies, shouldCopyMetatable)

method
Copies a table.

Parameters

originalTable 📋 table
The table to copy.
tableCopies 📋 table
(Internal) The table of copies used internally by the function.

Returns

📋 table
The copied table.

FrameworkZ.Utilities:DumpTable(tbl)

method
Convert a table to a string representation.

Parameters

tbl 📋 table
The table to dump.

Returns

📝 string
String representation of the table.

FrameworkZ.Utilities:GetItemColor(item)

method
Extracts color information from a Project Zomboid item.

Parameters

item 📦 object
The InventoryItem to extract color from.

Returns

🔢 number
r Red component (0.0-1.0)
🔢 number
g Green component (0.0-1.0)
🔢 number
b Blue component (0.0-1.0)
🔢 number
a Alpha component (0.0-1.0)

FrameworkZ.Utilities:GetPrettyDuration(timeInSeconds)

method
Convert seconds to a human-readable duration string.

Parameters

timeInSeconds 🔢 number
The time in seconds.

Returns

📝 string
Pretty formatted duration (e.g., "1 day and 3 hours").

FrameworkZ.Utilities:GetRandomNumber(min, max, keepLeadingZeros)

method
Generate a random number between min and max.

Parameters

min 🔢 integer
Minimum value.
max 🔢 integer
Maximum value.
keepLeadingZeros (optional) ✅ boolean
If true, format with leading zeros.

Returns

🔢 integer | 📝 string
Random number (string if keepLeadingZeros).

FrameworkZ.Utilities:IsExterior(square)

method
Check if a square is exterior (no room).

Parameters

square 🏷️ IsoGridSquare
The square to check.

Returns

✅ boolean
True if exterior.

FrameworkZ.Utilities:IsSemiExterior(square)

method
Check if a square is semi-exterior (in a room but has path to exterior).

Parameters

square 🏷️ IsoGridSquare
The square to check.

Returns

✅ boolean
True if semi-exterior.

FrameworkZ.Utilities:IsTrulyInterior(square)

method
Check if a square is truly interior (no path to exterior without passing through walls/doors/windows).

Parameters

square 🏷️ IsoGridSquare
The square to check.

Returns

✅ boolean
True if truly interior.

FrameworkZ.Utilities:MergeTables(t1, t2, visited)

method
Merge two tables recursively.

Parameters

t1 📋 table
The target table to merge into.
t2 📋 table
The source table to merge from.
visited (optional) 📋 table
Internal tracking for circular references.

Returns

📋 table
The merged table (t1).

FrameworkZ.Utilities:OrderedNext(t, state)

method
Internal: Iterator function for ordered table traversal.

Parameters

t 📋 table
The table being iterated.
state 🏷️ mixed
The current state (previous key).

Returns

🏷️ mixed
\mixed Next key and value.

FrameworkZ.Utilities:OrderedPairs(t)

method
Iterate table in sorted key order.

Parameters

t 📋 table
The table to iterate.

Returns

⚡ function
\table \nil Iterator function, table, and initial state.

FrameworkZ.Utilities:Pack(...)

method
Pack variadic arguments into a table with count.

Returns

📋 table
Table with n (count) and arguments.

FrameworkZ.Utilities:PrintTable(tbl)

method
Print a table to console using DumpTable.

Parameters

tbl 📋 table
The table to print.

FrameworkZ.Utilities:RemoveContextDuplicates(worldObjects)

method
Remove duplicate world objects from context menu.

Parameters

worldObjects 📋 table
Array of world objects.

Returns

📋 table
Array without duplicates.

FrameworkZ.Utilities:TableContainsKey(t, key)

method
Check if a table contains a specific key.

Parameters

t 📋 table
The table to search.
key 🏷️ mixed
The key to find.

Returns

✅ boolean
True if the key exists.

FrameworkZ.Utilities:TableContainsValue(t, value)

method
Check if a table contains a specific value.

Parameters

t 📋 table
The table to search.
value 🏷️ mixed
The value to find.

Returns

✅ boolean
True if the value exists.

FrameworkZ.Utilities:TableIsEmpty(t)

method
Check if a table is empty.

Parameters

t 📋 table
The table to check.

Returns

✅ boolean
True if empty or not a table.

FrameworkZ.Utilities:TrimString(str, maxLength, addEllipsis)

method
Trims a string to a maximum length, optionally adding ellipsis.

Parameters

str 📝 string
The string to trim.
maxLength 🏷️ int
The maximum allowed length.
addEllipsis ✅ boolean
(Optional) If true, appends "..." if trimmed.

Returns

📝 string
The trimmed string.

FrameworkZ.Utilities:Unpack(t)

method
Unpack a packed table back to individual arguments.

Parameters

t 📋 table
The packed table with n count.

Returns

🏷️ vararg
The unpacked arguments.

FrameworkZ.Utilities:WordWrapText(text, maxLength, eolDelimiter)

method
Word wraps text to a specified length.

Parameters

text 📝 string
The text to word wrap.
maxLength 🏷️ int
The maximum length of a line (default: 28).
eolDelimiter 📝 string
(Optional) The end of line delimiter. Returns a \table of lines if not supplied.

Returns

🏷️ mixed
The word wrapped text as a \string or a \table of lines of text if no eolDelimiter was supplied as an argument.

FrameworkZ:GetObject(objectName)

method
Get a locked object by name.

Parameters

objectName 📝 string
The name of the object.

Returns

📋 table
The locked object.

FrameworkZ:InitializeObject()

method
Initialize the FrameworkZ object.

FrameworkZ:IsInitialized()

method
Check if FrameworkZ is initialized.

Returns

✅ boolean
True if initialized.

FrameworkZ:LoadAndLockObject(object)

method
Load and lock an object to prevent modification.

Parameters

object 📋 table
The object to load and lock.

FrameworkZ:LoadObject(object)

method
Load an object and initialize it.

Parameters

object 📋 table
The object to load.

Returns

📋 table | ✅ boolean
A copy of the loaded object or false if failed.
📝 string
Success or error message.

FrameworkZ:RegisterObject(object)

method
Register an object with FrameworkZ.

Parameters

object 📋 table
The object to register (must have Meta.Name).

Returns

📋 table | ✅ boolean
The registered object or false if failed.

FrameworkZ:UnloadObject(objectName)

method
Unload an object by name (requires __allowUnload permission).

Parameters

objectName 📝 string
The name of the object to unload.

Returns

✅ boolean
True if unloaded successfully.

INVENTORY:AddItem(item)

method
Add an item to the inventory.

Parameters

item 📝 string
The item's ID.

🔗 See Also

  • CHARACTER::GiveItem(uniqueID)

INVENTORY:AddItems(uniqueID, quantity)

method
Add multiple items to the inventory.

Parameters

uniqueID 📝 string
The item's ID.
quantity 🔢 integer
The quantity of the item to add.

🔗 See Also

  • CHARACTER::GiveItems(uniqueID)

INVENTORY:GetItemByUniqueID(uniqueID)

method
Get an item by its unique ID.

Parameters

uniqueID 📝 string
The item's unique ID.

Returns

📋 table | ✅ boolean
The item object or false if not found.
📝 string
Error message if not found.

INVENTORY:GetItemCountByID(uniqueID)

method
Get the count of items with a specific unique ID.

Parameters

uniqueID 📝 string
The item's unique ID.

Returns

🔢 integer
The count of matching items.

INVENTORY:GetItems()

method
Get all items in the inventory.

Returns

📋 table
The items table.

INVENTORY:GetName()

method
Get the inventory's name.

Returns

📝 string
The inventory's name.

INVENTORY:GetSaveableData()

method
Get filtered saveable data for the inventory.

Returns

📋 table
The processed saveable data.

INVENTORY:Initialize()

method
Initialize an inventory.

Returns

📝 string
The inventory's ID.

INVENTORY:RemoveItem(item)

method
Remove an item from the inventory.

Parameters

item 📋 table
The item object to remove.

Returns

✅ boolean
\string True if successful and a message.

INVENTORY:Save()

method
Save the inventory to character data

Returns

📋 table
The complete inventory data including equipment

PLAYER:Destroy(callback)

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:GetCharacter()

method
Get the player's currently loaded character.

Returns

❔ CHARACTER?
The currently loaded character object or nil if no character is loaded.

PLAYER:GetCharacterDataByID(characterID, callback)

method
Get character data by character ID with optional async callback.

Parameters

characterID 🔢 number
The ID of the character to retrieve.
callback (optional) ⚡ function
Optional callback function(data, message) for async retrieval.

Returns

📋 table | ✅ boolean
Character data table or false if not found.
📝 string
Message describing success or failure.

PLAYER:GetCharacters()

method
Get all characters owned by this player.

Returns

📋 table
Table of character data indexed by character ID.

PLAYER:GetCustomData()

method
Get the player's custom data table.

Returns

📋 table
The custom data table for storing additional player information.

PLAYER:GetIsoPlayer()

method
Get the player's IsoPlayer object.

Returns

🏷️ IsoPlayer
The Project Zomboid IsoPlayer object associated with this player.

PLAYER:GetMaxCharacters()

method
Get the maximum number of characters the player can create.

Returns

🔢 number
The maximum character limit for this player.

PLAYER:GetPreviousCharacter()

method
Get the player's previous character ID.

Returns

🔢 number
The ID of the character the player last played.

PLAYER:GetRole()

method
Get the player's role.

Returns

📝 string
The player's current role (User, Operator, Moderator, Admin, Super_Admin, or Owner).

PLAYER:GetSaveableData()

method
Get player data suitable for saving/serialization.

Returns

📋 table
Filtered player data table ready for saving.

PLAYER:GetSteamID()

method
Get the player's Steam ID.

Returns

📝 string
The player's Steam ID.

PLAYER:GetStoredData()

method
Get the stored player mod data table.

Returns

📋 table
The raw FZ_PLY mod data table stored on the IsoPlayer.

PLAYER:GetUsername()

method
Get the player's username.

Returns

📝 string
The player's username.

PLAYER:GetWhitelists()

method
Get the player's faction whitelists.

Returns

📋 table
Table mapping faction IDs to whitelist status (true/false).

PLAYER:Initialize()

method
Initializes the player object.

Returns

📝 string
The username of the player.

PLAYER:InitializeDefaultFactionWhitelists()

method
Initialize default faction whitelists for the player based on faction settings.

PLAYER:IsWhitelisted(factionID)

method
Check if the player is whitelisted for a specific faction.

Parameters

factionID 📝 string
The faction ID to check.

Returns

✅ boolean
True if whitelisted, false otherwise.

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
Restore player data from saved data table.

Parameters

data 📋 table
The saved player data containing Role, MaxCharacters, PreviousCharacter, Whitelists, and CustomData.

PLAYER:Save(callback)

method
Saves the player's data.

Parameters

callback (optional) ⚡ function
Optional callback(success, message) invoked after server save confirmation.

Returns

✅ boolean
Whether or not the player save was initiated.

PLAYER:SetCharacter(character)

method
Set the player's currently loaded character.

Parameters

character 🏷️ CHARACTER
The character object to set as the loaded character.

PLAYER:SetCharacters(characters)

method
Set the characters table for this player.

Parameters

characters 📋 table
Table of character data indexed by character ID.

PLAYER:SetCustomData(customData)

method
Set the player's custom data table.

Parameters

customData 📋 table
The custom data table to store.

Returns

❔ boolean?
True if set successfully, false if invalid input.

PLAYER:SetIsoPlayer(isoPlayer)

method
Set the player's IsoPlayer object.

Parameters

isoPlayer 🏷️ IsoPlayer
The IsoPlayer object (read-only, cannot be changed after creation).

PLAYER:SetMaxCharacters(maxCharacters)

method
Set the maximum number of characters the player can create.

Parameters

maxCharacters 🔢 number
The maximum character limit (must be at least 1).

Returns

❔ boolean?
True if set successfully, false if invalid input.

PLAYER:SetPreviousCharacter(previousCharacter)

method
Set the player's previous character ID.

Parameters

previousCharacter 🔢 number
The character ID to set as previous character.

Returns

❔ boolean?
True if set successfully, false if invalid input.

PLAYER:SetRole(role)

method
Set the player's role.

Parameters

role 📝 string
The role to set (read-only, cannot be changed after creation).

PLAYER:SetSteamID(steamID)

method
Set the player's Steam ID.

Parameters

steamID 📝 string
The Steam ID (read-only, cannot be changed after creation).

PLAYER:SetUsername(username)

method
Set the player's username.

Parameters

username 📝 string
The username (read-only, cannot be changed after creation).

PLAYER:SetWhitelisted(factionID, whitelisted)

method
Set the player's whitelist status for a specific faction.

Parameters

factionID 📝 string
The faction ID to update whitelist status for.
whitelisted ✅ boolean
Whether the player is whitelisted for this faction.

Returns

❔ boolean?
True if set successfully, false if faction ID not provided.

PLAYER:SetWhitelists(whitelists)

method
Set the player's faction whitelists table.

Parameters

whitelists 📋 table
Table mapping faction IDs to whitelist status.

Returns

❔ boolean?
True if set successfully, false if invalid input.

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.

UI:RegisterNextStep(fromMenuName, toMenuName, fromMenu, toMenu, enterToMenuCallback, exitToMenuCallback, toMenuParameters)

method
Registers a navigation step between UI menus.

Parameters

fromMenuName 🏷️ Name
of the source menu.
toMenuName 🏷️ Name
of the destination menu.
fromMenu 🏷️ Reference
to the source menu object.
toMenu 🏷️ Reference
to the destination menu object.
enterToMenuCallback ⚡ Callback
invoked when entering the destination menu.
exitToMenuCallback ⚡ Callback
invoked when exiting the destination menu.
toMenuParameters 🏷️ Optional
parameters passed to the destination menu.

Undocumented Functions

444

.Add(func)

function undocumented
No documentation available

Parameters (inferred)

func ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

addRolePermissions(roleId)

function undocumented
No documentation available

Parameters (inferred)

roleId ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

AggregatedOptions:addOption(option)

method undocumented
No documentation available

Parameters (inferred)

option ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

AggregatedOptions:getOptions()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

AggregatedOptions:getUniqueID()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

buildSubMenu(subMenuBuilder)

function undocumented
No documentation available

Parameters (inferred)

subMenuBuilder ❓ unknown
Parameter inferred from function signature

button.onMouseMove(self2, dx, dy)

function undocumented
No documentation available

Parameters (inferred)

self2 ❓ unknown
Parameter inferred from function signature
dx ❓ unknown
Parameter inferred from function signature
dy ❓ unknown
Parameter inferred from function signature

button.onMouseMove(x, y)

function undocumented
No documentation available

Parameters (inferred)

x ❓ unknown
Parameter inferred from function signature
y ❓ unknown
Parameter inferred from function signature

button.onMouseMoveOutside(self2, dx, dy)

function undocumented
No documentation available

Parameters (inferred)

self2 ❓ unknown
Parameter inferred from function signature
dx ❓ unknown
Parameter inferred from function signature
dy ❓ unknown
Parameter inferred from function signature

button.onMouseMoveOutside(x, y)

function undocumented
No documentation available

Parameters (inferred)

x ❓ unknown
Parameter inferred from function signature
y ❓ unknown
Parameter inferred from function signature

calculateWidthHeight(originalAspectRatio, width, height, changeValue)

function undocumented
No documentation available

Parameters (inferred)

originalAspectRatio ❓ unknown
Parameter inferred from function signature
width ❓ unknown
Parameter inferred from function signature
height ❓ unknown
Parameter inferred from function signature
changeValue ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

call(_, ...)

function undocumented
No documentation available

Parameters (inferred)

_ ❓ unknown
Parameter inferred from function signature
... ❓ unknown
Parameter inferred from function signature

call(tbl, ...)

function undocumented
No documentation available

Parameters (inferred)

tbl ❓ unknown
Parameter inferred from function signature
... ❓ unknown
Parameter inferred from function signature

callback(target, parameters)

function undocumented
No documentation available

Parameters (inferred)

target ❓ unknown
Parameter inferred from function signature
parameters ❓ unknown
Parameter inferred from function signature

characterInitializedCallback(success, message2)

function undocumented
No documentation available

Parameters (inferred)

success ❓ unknown
Parameter inferred from function signature
message2 ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

checkPlayerValidity(candidates, targetPlayer)

function undocumented
No documentation available

Parameters (inferred)

candidates ❓ unknown
Parameter inferred from function signature
targetPlayer ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

clickOverlay.onMouseEnter(overlayPanel)

function undocumented
No documentation available

Parameters (inferred)

overlayPanel ❓ unknown
Parameter inferred from function signature

clickOverlay.onMouseExit(overlayPanel)

function undocumented
No documentation available

Parameters (inferred)

overlayPanel ❓ unknown
Parameter inferred from function signature

clickOverlay.onMouseUp(overlayPanel, x, y)

function undocumented
No documentation available

Parameters (inferred)

overlayPanel ❓ unknown
Parameter inferred from function signature
x ❓ unknown
Parameter inferred from function signature
y ❓ unknown
Parameter inferred from function signature

clientLoadCharacter(_data, success, message)

function undocumented
No documentation available

Parameters (inferred)

_data ❓ unknown
Parameter inferred from function signature
success ❓ unknown
Parameter inferred from function signature
message ❓ unknown
Parameter inferred from function signature

collect(tbl, prefix)

function undocumented
No documentation available

Parameters (inferred)

tbl ❓ unknown
Parameter inferred from function signature
prefix ❓ unknown
Parameter inferred from function signature

collect(tbl, prefix)

function undocumented
No documentation available

Parameters (inferred)

tbl ❓ unknown
Parameter inferred from function signature
prefix ❓ unknown
Parameter inferred from function signature

COMMAND:CanRun(player, args)

method undocumented
No documentation available

Parameters (inferred)

player ❓ unknown
Parameter inferred from function signature
args ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

COMMAND:CanRun(player, args)

method undocumented
No documentation available

Parameters (inferred)

player ❓ unknown
Parameter inferred from function signature
args ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

COMMAND:CanRun(player, args)

method undocumented
No documentation available

Parameters (inferred)

player ❓ unknown
Parameter inferred from function signature
args ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

COMMAND:CanRun(player, args)

method undocumented
No documentation available

Parameters (inferred)

player ❓ unknown
Parameter inferred from function signature
args ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

COMMAND:CanRun(player, args)

method undocumented
No documentation available

Parameters (inferred)

player ❓ unknown
Parameter inferred from function signature
args ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

COMMAND:CanRun(player, args)

method undocumented
No documentation available

Parameters (inferred)

player ❓ unknown
Parameter inferred from function signature
args ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

COMMAND:OnRun(player, args)

method undocumented
No documentation available

Parameters (inferred)

player ❓ unknown
Parameter inferred from function signature
args ❓ unknown
Parameter inferred from function signature

COMMAND:OnRun(player, args)

method undocumented
No documentation available

Parameters (inferred)

player ❓ unknown
Parameter inferred from function signature
args ❓ unknown
Parameter inferred from function signature

COMMAND:OnRun(player, args)

method undocumented
No documentation available

Parameters (inferred)

player ❓ unknown
Parameter inferred from function signature
args ❓ unknown
Parameter inferred from function signature

COMMAND:OnRun(player, args)

method undocumented
No documentation available

Parameters (inferred)

player ❓ unknown
Parameter inferred from function signature
args ❓ unknown
Parameter inferred from function signature

COMMAND:OnRun(player, args)

method undocumented
No documentation available

Parameters (inferred)

player ❓ unknown
Parameter inferred from function signature
args ❓ unknown
Parameter inferred from function signature

COMMAND:OnRun(player, args)

method undocumented
No documentation available

Parameters (inferred)

player ❓ unknown
Parameter inferred from function signature
args ❓ unknown
Parameter inferred from function signature

compress(t)

function undocumented
No documentation available

Parameters (inferred)

t ❓ unknown
Parameter inferred from function signature

ConnectToServer.OnConnected(self)

function undocumented
No documentation available

Parameters (inferred)

self ❓ unknown
Parameter inferred from function signature

createSecureFunction(originalFunction, object)

function undocumented
No documentation available

Parameters (inferred)

originalFunction ❓ unknown
Parameter inferred from function signature
object ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

createSecureFunction(originalFunction, object, originalObject)

function undocumented
No documentation available

Parameters (inferred)

originalFunction ❓ unknown
Parameter inferred from function signature
object ❓ unknown
Parameter inferred from function signature
originalObject ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

CreateUID()

function undocumented
No documentation available

Returns (inferred)

📦 object
Return type inferred from function name pattern

DATABASE:Broadcast()

method undocumented
No documentation available

DATABASE:GetData()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

DATABASE:GetField(name)

method undocumented
No documentation available

Parameters (inferred)

name ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

DATABASE:GetName()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

DATABASE:GetSubscribers()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

DATABASE:Initialize()

method undocumented
No documentation available

Returns (inferred)

⭕ void
Return type inferred from function name pattern

DATABASE:RemoveSubscriber(player, character, sticky)

method undocumented
No documentation available

Parameters (inferred)

player ❓ unknown
Parameter inferred from function signature
character ❓ unknown
Parameter inferred from function signature
sticky ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

DATABASE:Save()

method undocumented
No documentation available

DATABASE:SetData(data)

method undocumented
No documentation available

Parameters (inferred)

data ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

DATABASE:SetField(name, value)

method undocumented
No documentation available

Parameters (inferred)

name ❓ unknown
Parameter inferred from function signature
value ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

DATABASE:SetName(name)

method undocumented
No documentation available

Parameters (inferred)

name ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

DATABASE:SetSubscribers(subscribers)

method undocumented
No documentation available

Parameters (inferred)

subscribers ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

dataCallback(characterData, message)

function undocumented
No documentation available

Parameters (inferred)

characterData ❓ unknown
Parameter inferred from function signature
message ❓ unknown
Parameter inferred from function signature

factionImage.render(self)

function undocumented
No documentation available

Parameters (inferred)

self ❓ unknown
Parameter inferred from function signature

FIELD:AddSubscriber(player, character, temporary)

method undocumented
No documentation available

Parameters (inferred)

player ❓ unknown
Parameter inferred from function signature
character ❓ unknown
Parameter inferred from function signature
temporary ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FIELD:Broadcast()

method undocumented
No documentation available

FIELD:GetDatabaseName()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FIELD:GetKeys()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FIELD:GetTable()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FIELD:GetValue()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FIELD:Initialize()

method undocumented
No documentation available

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FIELD:RemoveSubscriber(player, character, sticky)

method undocumented
No documentation available

Parameters (inferred)

player ❓ unknown
Parameter inferred from function signature
character ❓ unknown
Parameter inferred from function signature
sticky ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FIELD:SetDatabaseName(name)

method undocumented
No documentation available

Parameters (inferred)

name ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FIELD:SetKeys(keys)

method undocumented
No documentation available

Parameters (inferred)

keys ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FIELD:SetTable(tbl)

method undocumented
No documentation available

Parameters (inferred)

tbl ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FIELD:SetValue(value)

method undocumented
No documentation available

Parameters (inferred)

value ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

findBestCandidate(candidates)

function undocumented
No documentation available

Parameters (inferred)

candidates ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Databases.OnBroadcast(data, dbName, dbData)

function undocumented
No documentation available

Parameters (inferred)

data ❓ unknown
Parameter inferred from function signature
dbName ❓ unknown
Parameter inferred from function signature
dbData ❓ unknown
Parameter inferred from function signature

FrameworkZ.Databases.OnSetData(data, database, keys, value)

function undocumented
No documentation available

Parameters (inferred)

data ❓ unknown
Parameter inferred from function signature
database ❓ unknown
Parameter inferred from function signature
keys ❓ unknown
Parameter inferred from function signature
value ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.Databases:GetDatabase(name)

method undocumented
No documentation available

Parameters (inferred)

name ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Databases:Initialize(name)

method undocumented
No documentation available

Parameters (inferred)

name ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.Databases:New(name)

method undocumented
No documentation available

Parameters (inferred)

name ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.Databases:SetData(database, keys, value, doNotSave, doNotBroadcast)

method undocumented
No documentation available

Parameters (inferred)

database ❓ unknown
Parameter inferred from function signature
keys ❓ unknown
Parameter inferred from function signature
value ❓ unknown
Parameter inferred from function signature
doNotSave ❓ unknown
Parameter inferred from function signature
doNotBroadcast ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.DollarFormats:CommaValue(amount)

method undocumented
No documentation available

Parameters (inferred)

amount ❓ unknown
Parameter inferred from function signature

FrameworkZ.DollarFormats:Get(amount, decimal, prefix, neg_prefix)

method undocumented
No documentation available

Parameters (inferred)

amount ❓ unknown
Parameter inferred from function signature
decimal ❓ unknown
Parameter inferred from function signature
prefix ❓ unknown
Parameter inferred from function signature
neg_prefix ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.DollarFormats:Round(val, decimal)

method undocumented
No documentation available

Parameters (inferred)

val ❓ unknown
Parameter inferred from function signature
decimal ❓ unknown
Parameter inferred from function signature

FrameworkZ.Factions:GetClassByID(factionID)

method undocumented
No documentation available

Parameters (inferred)

factionID ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Fields.OnBroadcast(data, dbName, keys, value)

function undocumented
No documentation available

Parameters (inferred)

data ❓ unknown
Parameter inferred from function signature
dbName ❓ unknown
Parameter inferred from function signature
keys ❓ unknown
Parameter inferred from function signature
value ❓ unknown
Parameter inferred from function signature

FrameworkZ.Fields:GetList()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Fields:Initialize(dbName, keyCode)

method undocumented
No documentation available

Parameters (inferred)

dbName ❓ unknown
Parameter inferred from function signature
keyCode ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.Fields:New()

method undocumented
No documentation available

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.Foundation.OnConfirmClient(data)

function undocumented
No documentation available

Parameters (inferred)

data ❓ unknown
Parameter inferred from function signature

FrameworkZ.Foundation.OnInitializePlayer(data)

function undocumented
No documentation available

Parameters (inferred)

data ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.Foundation.OnSaveData(data)

function undocumented
No documentation available

Parameters (inferred)

data ❓ unknown
Parameter inferred from function signature

FrameworkZ.Interfaces:GetInterface(index)

method undocumented
No documentation available

Parameters (inferred)

index ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Interfaces:Initialize()

method undocumented
No documentation available

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.Interfaces:New(uniqueID, parentTable)

method undocumented
No documentation available

Parameters (inferred)

uniqueID ❓ unknown
Parameter inferred from function signature
parentTable ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.Interfaces:Register(tbl, index)

method undocumented
No documentation available

Parameters (inferred)

tbl ❓ unknown
Parameter inferred from function signature
index ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.Items:AddInstance(item, isoPlayer, worldItem, callback)

method undocumented
No documentation available

Parameters (inferred)

item ❓ unknown
Parameter inferred from function signature
isoPlayer ❓ unknown
Parameter inferred from function signature
worldItem ❓ unknown
Parameter inferred from function signature
callback ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.Items:CreateWorldItem(isoPlayer, fullItemID)

method undocumented
No documentation available

Parameters (inferred)

isoPlayer ❓ unknown
Parameter inferred from function signature
fullItemID ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.Items:FindFirstInstanceByID(owner, uniqueID)

method undocumented
No documentation available

Parameters (inferred)

owner ❓ unknown
Parameter inferred from function signature
uniqueID ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Items:GetInstance(instanceID)

method undocumented
No documentation available

Parameters (inferred)

instanceID ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Items:GetItemByUniqueID(uniqueID)

method undocumented
No documentation available

Parameters (inferred)

uniqueID ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Items:GetStoredData(worldItem)

method undocumented
No documentation available

Parameters (inferred)

worldItem ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Items:Initialize(data)

method undocumented
No documentation available

Parameters (inferred)

data ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.Items:LinkWorldItemToInstanceData(worldItem, instanceData)

method undocumented
No documentation available

Parameters (inferred)

worldItem ❓ unknown
Parameter inferred from function signature
instanceData ❓ unknown
Parameter inferred from function signature

FrameworkZ.Items:New(uniqueID, itemID, isBase)

method undocumented
No documentation available

Parameters (inferred)

uniqueID ❓ unknown
Parameter inferred from function signature
itemID ❓ unknown
Parameter inferred from function signature
isBase ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.Items:OnDropItemCallback(parameters)

method undocumented
No documentation available

Parameters (inferred)

parameters ❓ unknown
Parameter inferred from function signature

FrameworkZ.Items:OnEquipItemCallback(parameters)

method undocumented
No documentation available

Parameters (inferred)

parameters ❓ unknown
Parameter inferred from function signature

FrameworkZ.Items:OnExamineItemCallback(parameters)

method undocumented
No documentation available

Parameters (inferred)

parameters ❓ unknown
Parameter inferred from function signature

FrameworkZ.Items:OnFillInventoryObjectContextMenu(player, context, items)

method undocumented
No documentation available

Parameters (inferred)

player ❓ unknown
Parameter inferred from function signature
context ❓ unknown
Parameter inferred from function signature
items ❓ unknown
Parameter inferred from function signature

FrameworkZ.Items:OnUnequipItemCallback(parameters)

method undocumented
No documentation available

Parameters (inferred)

parameters ❓ unknown
Parameter inferred from function signature

FrameworkZ.Items:OnUseItemCallback(parameters)

method undocumented
No documentation available

Parameters (inferred)

parameters ❓ unknown
Parameter inferred from function signature

FrameworkZ.Items:RemoveItemInstanceByUniqueID(owner, uniqueID)

method undocumented
No documentation available

Parameters (inferred)

owner ❓ unknown
Parameter inferred from function signature
uniqueID ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.Logs:GetRootDirectory()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Logs:Initialize()

method undocumented
No documentation available

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.Logs:LogError(message)

method undocumented
No documentation available

Parameters (inferred)

message ❓ unknown
Parameter inferred from function signature

FrameworkZ.Logs:LogInfo(message)

method undocumented
No documentation available

Parameters (inferred)

message ❓ unknown
Parameter inferred from function signature

FrameworkZ.Logs:LogPlayerAction(player, action)

method undocumented
No documentation available

Parameters (inferred)

player ❓ unknown
Parameter inferred from function signature
action ❓ unknown
Parameter inferred from function signature

FrameworkZ.Logs:LogSystemEvent(message)

method undocumented
No documentation available

Parameters (inferred)

message ❓ unknown
Parameter inferred from function signature

FrameworkZ.Logs:LogWarning(message)

method undocumented
No documentation available

Parameters (inferred)

message ❓ unknown
Parameter inferred from function signature

FrameworkZ.Notifications:OnGameStart()

method undocumented
No documentation available

FrameworkZ.Notifications:PlayerTick(isoPlayer)

method undocumented
No documentation available

Parameters (inferred)

isoPlayer ❓ unknown
Parameter inferred from function signature

FrameworkZ.Notifications:ProcessQueue(isProcessingContinued)

method undocumented
No documentation available

Parameters (inferred)

isProcessingContinued ❓ unknown
Parameter inferred from function signature

FrameworkZ.Overrides.DoTooltip(objTooltip, item, panel)

function undocumented
No documentation available

Parameters (inferred)

objTooltip ❓ unknown
Parameter inferred from function signature
item ❓ unknown
Parameter inferred from function signature
panel ❓ unknown
Parameter inferred from function signature

FrameworkZ.Overrides.onChatWindowInit()

function undocumented
No documentation available

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.Overrides.onConfirmQuitToDesktop(target, button)

function undocumented
No documentation available

Parameters (inferred)

target ❓ unknown
Parameter inferred from function signature
button ❓ unknown
Parameter inferred from function signature

FrameworkZ.Overrides.onMenuItemMouseDownMainMenu(item, x, y)

function undocumented
No documentation available

Parameters (inferred)

item ❓ unknown
Parameter inferred from function signature
x ❓ unknown
Parameter inferred from function signature
y ❓ unknown
Parameter inferred from function signature

FrameworkZ.Overrides.WordWrapText(text)

function undocumented
No documentation available

Parameters (inferred)

text ❓ unknown
Parameter inferred from function signature

FrameworkZ.Overrides:Configure(foundation)

method undocumented
No documentation available

Parameters (inferred)

foundation ❓ unknown
Parameter inferred from function signature

FrameworkZ.Overrides:OnGameStart()

method undocumented
No documentation available

FrameworkZ.Players.LoadCharacter(_data, username, characterID)

function undocumented
No documentation available

Parameters (inferred)

_data ❓ unknown
Parameter inferred from function signature
username ❓ unknown
Parameter inferred from function signature
characterID ❓ unknown
Parameter inferred from function signature

FrameworkZ.Players.OnCreateCharacter(data, username, characterData)

function undocumented
No documentation available

Parameters (inferred)

data ❓ unknown
Parameter inferred from function signature
username ❓ unknown
Parameter inferred from function signature
characterData ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.Players.OnLoadCharacter(data, characterID)

function undocumented
No documentation available

Parameters (inferred)

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

FrameworkZ.Players:CreateCharacter(username, characterData, characterID)

method undocumented
No documentation available

Parameters (inferred)

username ❓ unknown
Parameter inferred from function signature
characterData ❓ unknown
Parameter inferred from function signature
characterID ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.Players:DeleteCharacter(username, character)

method undocumented
No documentation available

Parameters (inferred)

username ❓ unknown
Parameter inferred from function signature
character ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.Players:DeleteCharacterByID(username, characterID)

method undocumented
No documentation available

Parameters (inferred)

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

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.Players:Destroy(username, callback)

method undocumented
No documentation available

Parameters (inferred)

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

FrameworkZ.Players:LoadCharacter(username, characterData, survivorDescriptor, loadCharacterStartTime)

method undocumented
No documentation available

Parameters (inferred)

username ❓ unknown
Parameter inferred from function signature
characterData ❓ unknown
Parameter inferred from function signature
survivorDescriptor ❓ unknown
Parameter inferred from function signature
loadCharacterStartTime ❓ unknown
Parameter inferred from function signature

FrameworkZ.Players:LoadCharacterByID(username, characterID, callback)

method undocumented
No documentation available

Parameters (inferred)

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

FrameworkZ.Players:OnDisconnect()

method undocumented
No documentation available

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.Players:OnFillWorldObjectContextMenu(playerNumber, context, worldObjects, test)

method undocumented
No documentation available

Parameters (inferred)

playerNumber ❓ unknown
Parameter inferred from function signature
context ❓ unknown
Parameter inferred from function signature
worldObjects ❓ unknown
Parameter inferred from function signature
test ❓ unknown
Parameter inferred from function signature

FrameworkZ.Players:OnInitGlobalModData(isNewGame)

method undocumented
No documentation available

Parameters (inferred)

isNewGame ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.Players:OnLoadCharacter(username, characterID, callback)

method undocumented
No documentation available

Parameters (inferred)

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

FrameworkZ.Players:OnPostLoadCharacter(isoPlayer, player, character, characterData)

method undocumented
No documentation available

Parameters (inferred)

isoPlayer ❓ unknown
Parameter inferred from function signature
player ❓ unknown
Parameter inferred from function signature
character ❓ unknown
Parameter inferred from function signature
characterData ❓ unknown
Parameter inferred from function signature

FrameworkZ.Players:OnPreLoadCharacter(isoPlayer, player, character, characterData)

method undocumented
No documentation available

Parameters (inferred)

isoPlayer ❓ unknown
Parameter inferred from function signature
player ❓ unknown
Parameter inferred from function signature
character ❓ unknown
Parameter inferred from function signature
characterData ❓ unknown
Parameter inferred from function signature

FrameworkZ.Players:OnStorageSet(isoPlayer, command, namespace, keys, value)

method undocumented
No documentation available

Parameters (inferred)

isoPlayer ❓ unknown
Parameter inferred from function signature
command ❓ unknown
Parameter inferred from function signature
namespace ❓ unknown
Parameter inferred from function signature
keys ❓ unknown
Parameter inferred from function signature
value ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.Players:SaveCharacter(username, character)

method undocumented
No documentation available

Parameters (inferred)

username ❓ unknown
Parameter inferred from function signature
character ❓ unknown
Parameter inferred from function signature

FrameworkZ.Players:SaveCharacterByID(username, characterID)

method undocumented
No documentation available

Parameters (inferred)

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

FrameworkZ.Plugins:CreatePlugin(name)

method undocumented
No documentation available

Parameters (inferred)

name ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.Plugins:GetPlugin(pluginName)

method undocumented
No documentation available

Parameters (inferred)

pluginName ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Plugins:RegisterInterface(interfaceName, interfaceTable)

method undocumented
No documentation available

Parameters (inferred)

interfaceName ❓ unknown
Parameter inferred from function signature
interfaceTable ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.Security:CreateObject(name)

method undocumented
No documentation available

Parameters (inferred)

name ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.Security:GetAllObjectss()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Security:GetLoadedObject(objectName)

method undocumented
No documentation available

Parameters (inferred)

objectName ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Security:GetObject(objectName)

method undocumented
No documentation available

Parameters (inferred)

objectName ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Security:LoadLockedObject(objectName, lockedObject)

method undocumented
No documentation available

Parameters (inferred)

objectName ❓ unknown
Parameter inferred from function signature
lockedObject ❓ unknown
Parameter inferred from function signature

FrameworkZ.Security:LockAndLoadObject(object)

method undocumented
No documentation available

Parameters (inferred)

object ❓ unknown
Parameter inferred from function signature

FrameworkZ.Security:RegisterObject(object)

method undocumented
No documentation available

Parameters (inferred)

object ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.Security:UnloadObject(objectName)

method undocumented
No documentation available

Parameters (inferred)

objectName ❓ unknown
Parameter inferred from function signature

FrameworkZ.SubClasses:Initialize(id, object)

method undocumented
No documentation available

Parameters (inferred)

id ❓ unknown
Parameter inferred from function signature
object ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.SubClasses:New(name)

method undocumented
No documentation available

Parameters (inferred)

name ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.Themes:ApplyButtonTheme(button, theme)

method undocumented
No documentation available

Parameters (inferred)

button ❓ unknown
Parameter inferred from function signature
theme ❓ unknown
Parameter inferred from function signature

FrameworkZ.Themes:ApplyComboBoxTheme(combo, theme)

method undocumented
No documentation available

Parameters (inferred)

combo ❓ unknown
Parameter inferred from function signature
theme ❓ unknown
Parameter inferred from function signature

FrameworkZ.Themes:ApplyLabelTheme(label, theme)

method undocumented
No documentation available

Parameters (inferred)

label ❓ unknown
Parameter inferred from function signature
theme ❓ unknown
Parameter inferred from function signature

FrameworkZ.Themes:ApplyPanelTheme(panel, themeName)

method undocumented
No documentation available

Parameters (inferred)

panel ❓ unknown
Parameter inferred from function signature
themeName ❓ unknown
Parameter inferred from function signature

FrameworkZ.Themes:ApplySliderTheme(slider, theme)

method undocumented
No documentation available

Parameters (inferred)

slider ❓ unknown
Parameter inferred from function signature
theme ❓ unknown
Parameter inferred from function signature

FrameworkZ.Themes:ApplyTextEntryTheme(textEntry, theme)

method undocumented
No documentation available

Parameters (inferred)

textEntry ❓ unknown
Parameter inferred from function signature
theme ❓ unknown
Parameter inferred from function signature

FrameworkZ.Themes:ApplyTheme(element, elementType, theme)

method undocumented
No documentation available

Parameters (inferred)

element ❓ unknown
Parameter inferred from function signature
elementType ❓ unknown
Parameter inferred from function signature
theme ❓ unknown
Parameter inferred from function signature

FrameworkZ.Themes:GetFont(fontToken)

method undocumented
No documentation available

Parameters (inferred)

fontToken ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Timers:Create(name, delay, repetitions, func)

method undocumented
No documentation available

Parameters (inferred)

name ❓ unknown
Parameter inferred from function signature
delay ❓ unknown
Parameter inferred from function signature
repetitions ❓ unknown
Parameter inferred from function signature
func ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.Timers:Exists(name)

method undocumented
No documentation available

Parameters (inferred)

name ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.Timers:NextTimeLeft(name)

method undocumented
No documentation available

Parameters (inferred)

name ❓ unknown
Parameter inferred from function signature

FrameworkZ.Timers:Pause(name)

method undocumented
No documentation available

Parameters (inferred)

name ❓ unknown
Parameter inferred from function signature

FrameworkZ.Timers:Remove(name)

method undocumented
No documentation available

Parameters (inferred)

name ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.Timers:RepsLeft(name)

method undocumented
No documentation available

Parameters (inferred)

name ❓ unknown
Parameter inferred from function signature

FrameworkZ.Timers:Start(name)

method undocumented
No documentation available

Parameters (inferred)

name ❓ unknown
Parameter inferred from function signature

FrameworkZ.Timers:TimeLeft(name)

method undocumented
No documentation available

Parameters (inferred)

name ❓ unknown
Parameter inferred from function signature

FrameworkZ.Timers:Toggle(name)

method undocumented
No documentation available

Parameters (inferred)

name ❓ unknown
Parameter inferred from function signature

FrameworkZ.Timers:UnPause(name)

method undocumented
No documentation available

Parameters (inferred)

name ❓ unknown
Parameter inferred from function signature

FrameworkZ.Tooltips.DrawTooltip()

function undocumented
No documentation available

FrameworkZ.Tooltips.OnTick()

function undocumented
No documentation available

FrameworkZ.Tooltips.RequestCharacterData(data, localUsername, targetUsername, requestingPlayer)

function undocumented
No documentation available

Parameters (inferred)

data ❓ unknown
Parameter inferred from function signature
localUsername ❓ unknown
Parameter inferred from function signature
targetUsername ❓ unknown
Parameter inferred from function signature
requestingPlayer ❓ unknown
Parameter inferred from function signature

FrameworkZ.Tooltips:CalculateCharacterScore(localPlayer, targetPlayer, mouseX, mouseY)

method undocumented
No documentation available

Parameters (inferred)

localPlayer ❓ unknown
Parameter inferred from function signature
targetPlayer ❓ unknown
Parameter inferred from function signature
mouseX ❓ unknown
Parameter inferred from function signature
mouseY ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Tooltips:CalculateLineOfSight(localPlayer, targetPlayer, restrictive, adjacentRange)

method undocumented
No documentation available

Parameters (inferred)

localPlayer ❓ unknown
Parameter inferred from function signature
targetPlayer ❓ unknown
Parameter inferred from function signature
restrictive ❓ unknown
Parameter inferred from function signature
adjacentRange ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Tooltips:CalculatePlayerTargetAngle(player, targetX, targetY)

method undocumented
No documentation available

Parameters (inferred)

player ❓ unknown
Parameter inferred from function signature
targetX ❓ unknown
Parameter inferred from function signature
targetY ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Tooltips:CalculateTypewriterSpeed(localPlayer, targetPlayer)

method undocumented
No documentation available

Parameters (inferred)

localPlayer ❓ unknown
Parameter inferred from function signature
targetPlayer ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Tooltips:CheckAdjacentOpening(localSquare, targetSquare, dx, dy, restrictive)

method undocumented
No documentation available

Parameters (inferred)

localSquare ❓ unknown
Parameter inferred from function signature
targetSquare ❓ unknown
Parameter inferred from function signature
dx ❓ unknown
Parameter inferred from function signature
dy ❓ unknown
Parameter inferred from function signature
restrictive ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.Tooltips:CheckSquareObstructions(square, stepX, stepY, isTargetSquare, restrictive)

method undocumented
No documentation available

Parameters (inferred)

square ❓ unknown
Parameter inferred from function signature
stepX ❓ unknown
Parameter inferred from function signature
stepY ❓ unknown
Parameter inferred from function signature
isTargetSquare ❓ unknown
Parameter inferred from function signature
restrictive ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.Tooltips:CheckWallPassage(door, window, wall, restrictive)

method undocumented
No documentation available

Parameters (inferred)

door ❓ unknown
Parameter inferred from function signature
window ❓ unknown
Parameter inferred from function signature
wall ❓ unknown
Parameter inferred from function signature
restrictive ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.Tooltips:CleanupCaches()

method undocumented
No documentation available

FrameworkZ.Tooltips:DisableTooltip()

method undocumented
No documentation available

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.Tooltips:DoorHasWindow(door)

method undocumented
No documentation available

Parameters (inferred)

door ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.Tooltips:EnableTooltip()

method undocumented
No documentation available

FrameworkZ.Tooltips:GetDescriptionLines(desc)

method undocumented
No documentation available

Parameters (inferred)

desc ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Tooltips:GetDirectionVector(isoDirection)

method undocumented
No documentation available

Parameters (inferred)

isoDirection ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Tooltips:HasLineOfSight(localPlayer, targetPlayer)

method undocumented
No documentation available

Parameters (inferred)

localPlayer ❓ unknown
Parameter inferred from function signature
targetPlayer ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.Tooltips:HasLineOfSightForTypewriter(localPlayer, targetPlayer)

method undocumented
No documentation available

Parameters (inferred)

localPlayer ❓ unknown
Parameter inferred from function signature
targetPlayer ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.Tooltips:IsPlayerFacingTarget(player, targetX, targetY, fieldOfViewAngle)

method undocumented
No documentation available

Parameters (inferred)

player ❓ unknown
Parameter inferred from function signature
targetX ❓ unknown
Parameter inferred from function signature
targetY ❓ unknown
Parameter inferred from function signature
fieldOfViewAngle ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Tooltips:OnReceiveCharacterData(responseData)

method undocumented
No documentation available

Parameters (inferred)

responseData ❓ unknown
Parameter inferred from function signature

FrameworkZ.Tooltips:ResetTypewriterState()

method undocumented
No documentation available

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.Tooltips:UpdateTypewriterProgress()

method undocumented
No documentation available

FrameworkZ.UI.CharacterPreview:initialise()

method undocumented
No documentation available

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.UI.CharacterPreview:new(x, y, width, height, defaultAnimation, defaultDirection)

method undocumented
No documentation available

Parameters (inferred)

x ❓ unknown
Parameter inferred from function signature
y ❓ unknown
Parameter inferred from function signature
width ❓ unknown
Parameter inferred from function signature
height ❓ unknown
Parameter inferred from function signature
defaultAnimation ❓ unknown
Parameter inferred from function signature
defaultDirection ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.CharacterPreview:onAnimSelected(combo)

method undocumented
No documentation available

Parameters (inferred)

combo ❓ unknown
Parameter inferred from function signature

FrameworkZ.UI.CharacterPreview:onTurnChar(button, x, y)

method undocumented
No documentation available

Parameters (inferred)

button ❓ unknown
Parameter inferred from function signature
x ❓ unknown
Parameter inferred from function signature
y ❓ unknown
Parameter inferred from function signature

FrameworkZ.UI.CharacterPreview:prerender()

method undocumented
No documentation available

FrameworkZ.UI.CharacterPreview: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

FrameworkZ.UI.CharacterPreview:setSurvivorDesc(survivorDesc)

method undocumented
No documentation available

Parameters (inferred)

survivorDesc ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.UI.CharacterView:getDescriptionLines(description)

method undocumented
No documentation available

Parameters (inferred)

description ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.UI.CharacterView:initialise()

method undocumented
No documentation available

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.UI.CharacterView:new(x, y, width, height, isoPlayer, character, name, description, defaultDirection)

method undocumented
No documentation available

Parameters (inferred)

x ❓ unknown
Parameter inferred from function signature
y ❓ unknown
Parameter inferred from function signature
width ❓ unknown
Parameter inferred from function signature
height ❓ unknown
Parameter inferred from function signature
isoPlayer ❓ unknown
Parameter inferred from function signature
character ❓ unknown
Parameter inferred from function signature
name ❓ unknown
Parameter inferred from function signature
description ❓ unknown
Parameter inferred from function signature
defaultDirection ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.CharacterView:reinitialize(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

FrameworkZ.UI.CharacterView:render()

method undocumented
No documentation available

FrameworkZ.UI.CharacterView: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

FrameworkZ.UI.CharacterView:setDescription(description)

method undocumented
No documentation available

Parameters (inferred)

description ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.UI.CharacterView:setName(name)

method undocumented
No documentation available

Parameters (inferred)

name ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.UI.CharacterView:updateAppearance()

method undocumented
No documentation available

FrameworkZ.UI.CreateCharacterAppearance:addClothingOption(x, y, height, entryWidth, colorButtonWidth, labelText, clothingLocation, clothingTable, parentContainer)

method undocumented
No documentation available

Parameters (inferred)

x ❓ unknown
Parameter inferred from function signature
y ❓ unknown
Parameter inferred from function signature
height ❓ unknown
Parameter inferred from function signature
entryWidth ❓ unknown
Parameter inferred from function signature
colorButtonWidth ❓ unknown
Parameter inferred from function signature
labelText ❓ unknown
Parameter inferred from function signature
clothingLocation ❓ unknown
Parameter inferred from function signature
clothingTable ❓ unknown
Parameter inferred from function signature
parentContainer ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterAppearance:applyVisualSelectionsToItem(item, location)

method undocumented
No documentation available

Parameters (inferred)

item ❓ unknown
Parameter inferred from function signature
location ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterAppearance:getClothingColors()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterAppearance:getSelectedClothing()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterAppearance:hasClothingItems(clothingTable)

method undocumented
No documentation available

Parameters (inferred)

clothingTable ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterAppearance:initialise()

method undocumented
No documentation available

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterAppearance:new(parameters)

method undocumented
No documentation available

Parameters (inferred)

parameters ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterAppearance:onBeardChanged(dropdown)

method undocumented
No documentation available

Parameters (inferred)

dropdown ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterAppearance:onClearDecalClicked(button)

method undocumented
No documentation available

Parameters (inferred)

button ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterAppearance:onClothingButtonClicked(button)

method undocumented
No documentation available

Parameters (inferred)

button ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterAppearance:onClothingChanged(dropdown)

method undocumented
No documentation available

Parameters (inferred)

dropdown ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterAppearance:onClothingColorPicked(colorInfo, mouseUp, location)

method undocumented
No documentation available

Parameters (inferred)

colorInfo ❓ unknown
Parameter inferred from function signature
mouseUp ❓ unknown
Parameter inferred from function signature
location ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterAppearance:onClothingSelectionChanged(itemData)

method undocumented
No documentation available

Parameters (inferred)

itemData ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterAppearance:onColorButtonClicked(button)

method undocumented
No documentation available

Parameters (inferred)

button ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterAppearance:onDecalComboChanged(combo)

method undocumented
No documentation available

Parameters (inferred)

combo ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterAppearance:onHairChanged(dropdown)

method undocumented
No documentation available

Parameters (inferred)

dropdown ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterAppearance:populateDecalOptionsForLocation(location)

method undocumented
No documentation available

Parameters (inferred)

location ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterAppearance:refreshSlotCapabilities(location)

method undocumented
No documentation available

Parameters (inferred)

location ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterAppearance:render()

method undocumented
No documentation available

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterAppearance:resetBeardStyles()

method undocumented
No documentation available

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterAppearance:resetGender(newGender)

method undocumented
No documentation available

Parameters (inferred)

newGender ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterAppearance:resetHairColor()

method undocumented
No documentation available

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterAppearance:resetHairStyles()

method undocumented
No documentation available

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterAppearance:resetSkinColor()

method undocumented
No documentation available

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterAppearance:update()

method undocumented
No documentation available

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterFaction:createFactionCard(x, y, width, height, factionId, factionData)

method undocumented
No documentation available

Parameters (inferred)

x ❓ unknown
Parameter inferred from function signature
y ❓ unknown
Parameter inferred from function signature
width ❓ unknown
Parameter inferred from function signature
height ❓ unknown
Parameter inferred from function signature
factionId ❓ unknown
Parameter inferred from function signature
factionData ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterFaction:getFactionStatus(factionData)

method undocumented
No documentation available

Parameters (inferred)

factionData ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterFaction:initialise()

method undocumented
No documentation available

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterFaction:new(parameters)

method undocumented
No documentation available

Parameters (inferred)

parameters ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterFaction:onFactionSelected(dropdown)

method undocumented
No documentation available

Parameters (inferred)

dropdown ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterFaction:render()

method undocumented
No documentation available

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterFaction:selectFaction(factionId, factionData)

method undocumented
No documentation available

Parameters (inferred)

factionId ❓ unknown
Parameter inferred from function signature
factionData ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterFaction:update()

method undocumented
No documentation available

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterInfo:getCharacterData()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterInfo:initialise()

method undocumented
No documentation available

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterInfo:new(parameters)

method undocumented
No documentation available

Parameters (inferred)

parameters ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterInfo:onAgeChanged(newValue, slider)

method undocumented
No documentation available

Parameters (inferred)

newValue ❓ unknown
Parameter inferred from function signature
slider ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterInfo:onGenderChanged(dropdown)

method undocumented
No documentation available

Parameters (inferred)

dropdown ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterInfo:onHeightChanged(newValue, slider)

method undocumented
No documentation available

Parameters (inferred)

newValue ❓ unknown
Parameter inferred from function signature
slider ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterInfo:onWeightChanged(newValue, slider)

method undocumented
No documentation available

Parameters (inferred)

newValue ❓ unknown
Parameter inferred from function signature
slider ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterInfo:prerender()

method undocumented
No documentation available

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterInfo:update()

method undocumented
No documentation available

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterInfo:validateData()

method undocumented
No documentation available

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.Introduction:createMusicControls()

method undocumented
No documentation available

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.Introduction:initialise()

method undocumented
No documentation available

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.UI.Introduction:new(x, y, width, height, playerObject)

method undocumented
No documentation available

Parameters (inferred)

x ❓ unknown
Parameter inferred from function signature
y ❓ unknown
Parameter inferred from function signature
width ❓ unknown
Parameter inferred from function signature
height ❓ unknown
Parameter inferred from function signature
playerObject ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.Introduction:onMuteToggle()

method undocumented
No documentation available

FrameworkZ.UI.Introduction:onVolumeChanged(newValue, slider)

method undocumented
No documentation available

Parameters (inferred)

newValue ❓ unknown
Parameter inferred from function signature
slider ❓ unknown
Parameter inferred from function signature

FrameworkZ.UI.Introduction:update()

method undocumented
No documentation available

FrameworkZ.UI.LoadCharacterMenu:initialise()

method undocumented
No documentation available

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.UI.LoadCharacterMenu:new(x, y, width, height, player)

method undocumented
No documentation available

Parameters (inferred)

x ❓ unknown
Parameter inferred from function signature
y ❓ unknown
Parameter inferred from function signature
width ❓ unknown
Parameter inferred from function signature
height ❓ unknown
Parameter inferred from function signature
player ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.LoadCharacterMenu:onNext()

method undocumented
No documentation available

FrameworkZ.UI.LoadCharacterMenu:onPrevious()

method undocumented
No documentation available

FrameworkZ.UI.LoadCharacterMenu:prerender()

method undocumented
No documentation available

FrameworkZ.UI.LoadCharacterMenu:refreshCharacterList(keepSelection)

method undocumented
No documentation available

Parameters (inferred)

keepSelection ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.UI.LoadCharacterMenu:render()

method undocumented
No documentation available

FrameworkZ.UI.LoadCharacterMenu:updateCharacterPreview()

method undocumented
No documentation available

FrameworkZ.UI.MainMenu:fadeOutMainMenuMusic()

method undocumented
No documentation available

FrameworkZ.UI.MainMenu:getMainMenuMusicVolume()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.UI.MainMenu:getOriginalVolumeForUnmute()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.UI.MainMenu:hideStepControls(backButton, forwardButton)

method undocumented
No documentation available

Parameters (inferred)

backButton ❓ unknown
Parameter inferred from function signature
forwardButton ❓ unknown
Parameter inferred from function signature

FrameworkZ.UI.MainMenu:initialise()

method undocumented
No documentation available

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.UI.MainMenu:new(x, y, width, height, playerObject)

method undocumented
No documentation available

Parameters (inferred)

x ❓ unknown
Parameter inferred from function signature
y ❓ unknown
Parameter inferred from function signature
width ❓ unknown
Parameter inferred from function signature
height ❓ unknown
Parameter inferred from function signature
playerObject ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.MainMenu:onClose()

method undocumented
No documentation available

FrameworkZ.UI.MainMenu:onDisconnect()

method undocumented
No documentation available

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.UI.MainMenu:onEnterAppearanceMenu(menu)

method undocumented
No documentation available

Parameters (inferred)

menu ❓ unknown
Parameter inferred from function signature

FrameworkZ.UI.MainMenu:onEnterFactionMenu(menu)

method undocumented
No documentation available

Parameters (inferred)

menu ❓ unknown
Parameter inferred from function signature

FrameworkZ.UI.MainMenu:onEnterInfoMenu(menu)

method undocumented
No documentation available

Parameters (inferred)

menu ❓ unknown
Parameter inferred from function signature

FrameworkZ.UI.MainMenu:onEnterLoadCharacterMenu()

method undocumented
No documentation available

FrameworkZ.UI.MainMenu:onEnterMainMenu()

method undocumented
No documentation available

FrameworkZ.UI.MainMenu:onEnterMainMenuFromLoadCharacterMenu()

method undocumented
No documentation available

FrameworkZ.UI.MainMenu:onExitAppearanceMenu(menu)

method undocumented
No documentation available

Parameters (inferred)

menu ❓ unknown
Parameter inferred from function signature

FrameworkZ.UI.MainMenu:onExitFactionMenu(menu)

method undocumented
No documentation available

Parameters (inferred)

menu ❓ unknown
Parameter inferred from function signature

FrameworkZ.UI.MainMenu:onExitInfoMenu(menu, isForward)

method undocumented
No documentation available

Parameters (inferred)

menu ❓ unknown
Parameter inferred from function signature
isForward ❓ unknown
Parameter inferred from function signature

FrameworkZ.UI.MainMenu:onExitMainMenu()

method undocumented
No documentation available

FrameworkZ.UI.MainMenu:onFinalizeCharacter(menu)

method undocumented
No documentation available

Parameters (inferred)

menu ❓ unknown
Parameter inferred from function signature

FrameworkZ.UI.MainMenu:onLoadCharacter()

method undocumented
No documentation available

FrameworkZ.UI.MainMenu:prerender()

method undocumented
No documentation available

FrameworkZ.UI.MainMenu:setMainMenuMusicVolume(volume)

method undocumented
No documentation available

Parameters (inferred)

volume ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.UI.MainMenu:setOriginalVolumeForUnmute(originalVolume)

method undocumented
No documentation available

Parameters (inferred)

originalVolume ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.UI.MainMenu:showStepControls(menu, backButtonIndex, backButton, backButtonText, forwardButtonIndex, forwardButton, forwardButtonText)

method undocumented
No documentation available

Parameters (inferred)

menu ❓ unknown
Parameter inferred from function signature
backButtonIndex ❓ unknown
Parameter inferred from function signature
backButton ❓ unknown
Parameter inferred from function signature
backButtonText ❓ unknown
Parameter inferred from function signature
forwardButtonIndex ❓ unknown
Parameter inferred from function signature
forwardButton ❓ unknown
Parameter inferred from function signature
forwardButtonText ❓ unknown
Parameter inferred from function signature

FrameworkZ.UI.MainMenu:update()

method undocumented
No documentation available

FrameworkZ.UI.MusicControls:GetIntroMusicVolume()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.UI.MusicControls:GetMainMenuMusicVolume()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.UI.MusicControls:initialise()

method undocumented
No documentation available

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.UI.MusicControls:new(parameters)

method undocumented
No documentation available

Parameters (inferred)

parameters ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.MusicControls:onClose()

method undocumented
No documentation available

FrameworkZ.UI.MusicControls:onIntroVolumeChanged()

method undocumented
No documentation available

FrameworkZ.UI.MusicControls:onMenuVolumeChanged()

method undocumented
No documentation available

FrameworkZ.UI.MusicControls:onMuteToggle()

method undocumented
No documentation available

FrameworkZ.UI.MusicControls:onTestIntro()

method undocumented
No documentation available

FrameworkZ.UI.MusicControls:render()

method undocumented
No documentation available

FrameworkZ.UI.MusicControls:SetCurrentIntroSong(song)

method undocumented
No documentation available

Parameters (inferred)

song ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.UI.MusicControls:SetCurrentMainMenuSong(song)

method undocumented
No documentation available

Parameters (inferred)

song ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.UI.MusicControls:SetIntroMusicVolume(volume)

method undocumented
No documentation available

Parameters (inferred)

volume ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.UI.MusicControls:SetMainMenuMusicVolume(volume)

method undocumented
No documentation available

Parameters (inferred)

volume ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.UI.MusicControls:update()

method undocumented
No documentation available

FrameworkZ.UI.Notification:initialise()

method undocumented
No documentation available

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.UI.Notification:new(type, text, duration, playerObject)

method undocumented
No documentation available

Parameters (inferred)

type ❓ unknown
Parameter inferred from function signature
text ❓ unknown
Parameter inferred from function signature
duration ❓ unknown
Parameter inferred from function signature
playerObject ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.Notification:onMouseMove(x, y)

method undocumented
No documentation available

Parameters (inferred)

x ❓ unknown
Parameter inferred from function signature
y ❓ unknown
Parameter inferred from function signature

FrameworkZ.UI.Notification:onMouseMoveOutside(x, y)

method undocumented
No documentation available

Parameters (inferred)

x ❓ unknown
Parameter inferred from function signature
y ❓ unknown
Parameter inferred from function signature

FrameworkZ.UI.Notification:restartFadeOut()

method undocumented
No documentation available

FrameworkZ.UI.Notification:update()

method undocumented
No documentation available

FrameworkZ.UI.TabMenu:close()

method undocumented
No documentation available

FrameworkZ.UI.TabMenu:initialise()

method undocumented
No documentation available

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.UI.TabMenu:new(x, y, width, height, isoPlayer)

method undocumented
No documentation available

Parameters (inferred)

x ❓ unknown
Parameter inferred from function signature
y ❓ unknown
Parameter inferred from function signature
width ❓ unknown
Parameter inferred from function signature
height ❓ unknown
Parameter inferred from function signature
isoPlayer ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.TabMenu:onOptionMouseDown(button, x, y)

method undocumented
No documentation available

Parameters (inferred)

button ❓ unknown
Parameter inferred from function signature
x ❓ unknown
Parameter inferred from function signature
y ❓ unknown
Parameter inferred from function signature

FrameworkZ.UI.TabMenu:prerender()

method undocumented
No documentation available

FrameworkZ.UI.TabMenu:render()

method undocumented
No documentation available

FrameworkZ.UI.TabMenu:update()

method undocumented
No documentation available

FrameworkZ.UI.TabPanel:close()

method undocumented
No documentation available

FrameworkZ.UI.TabPanel:initialise()

method undocumented
No documentation available

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.UI.TabPanel:new(isoPlayer)

method undocumented
No documentation available

Parameters (inferred)

isoPlayer ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.TabPanel:onMenuSelect(button, x, y)

method undocumented
No documentation available

Parameters (inferred)

button ❓ unknown
Parameter inferred from function signature
x ❓ unknown
Parameter inferred from function signature
y ❓ unknown
Parameter inferred from function signature

FrameworkZ.UI.TabPanel:prerender()

method undocumented
No documentation available

FrameworkZ.UI.TabPanel:render()

method undocumented
No documentation available

FrameworkZ.UI.TabPanel:slideIn()

method undocumented
No documentation available

FrameworkZ.UI.TabPanel:slideOut()

method undocumented
No documentation available

FrameworkZ.UI.TabPanel:update()

method undocumented
No documentation available

FrameworkZ.UI.TabSession:close(button, x, y)

method undocumented
No documentation available

Parameters (inferred)

button ❓ unknown
Parameter inferred from function signature
x ❓ unknown
Parameter inferred from function signature
y ❓ unknown
Parameter inferred from function signature

FrameworkZ.UI.TabSession:getCharacterInfo(character)

method undocumented
No documentation available

Parameters (inferred)

character ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.UI.TabSession:initialise()

method undocumented
No documentation available

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.UI.TabSession:new(isoPlayer)

method undocumented
No documentation available

Parameters (inferred)

isoPlayer ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UI.TabSession:onClickButton(button, x, y)

method undocumented
No documentation available

Parameters (inferred)

button ❓ unknown
Parameter inferred from function signature
x ❓ unknown
Parameter inferred from function signature
y ❓ unknown
Parameter inferred from function signature

FrameworkZ.UI.TabSession:populatePlayerList()

method undocumented
No documentation available

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.UI.TabSession:prerender()

method undocumented
No documentation available

FrameworkZ.UI.TabSession:render()

method undocumented
No documentation available

FrameworkZ.UI.TabSession:updatePlayerList()

method undocumented
No documentation available

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.UpgradeSystem.applyUpgrade(character, faction, upgradeName)

function undocumented
No documentation available

Parameters (inferred)

character ❓ unknown
Parameter inferred from function signature
faction ❓ unknown
Parameter inferred from function signature
upgradeName ❓ unknown
Parameter inferred from function signature

FrameworkZ.UpgradeSystem.registerUpgrade(factionID, upgradeName, upgradeFunction)

function undocumented
No documentation available

Parameters (inferred)

factionID ❓ unknown
Parameter inferred from function signature
upgradeName ❓ unknown
Parameter inferred from function signature
upgradeFunction ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.UserInterfaces:AddButtonEffects(button)

method undocumented
No documentation available

Parameters (inferred)

button ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.UserInterfaces:CreateHugeButton(parent, x, y, text, target, onClick)

method undocumented
No documentation available

Parameters (inferred)

parent ❓ unknown
Parameter inferred from function signature
x ❓ unknown
Parameter inferred from function signature
y ❓ unknown
Parameter inferred from function signature
text ❓ unknown
Parameter inferred from function signature
target ❓ unknown
Parameter inferred from function signature
onClick ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.UserInterfaces:Initialize(uniqueID, userInterface)

method undocumented
No documentation available

Parameters (inferred)

uniqueID ❓ unknown
Parameter inferred from function signature
userInterface ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.UserInterfaces:New(uniqueID, parent)

method undocumented
No documentation available

Parameters (inferred)

uniqueID ❓ unknown
Parameter inferred from function signature
parent ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

GenerateEquipSubMenu(optionID, option, optionTarget, equipType)

function undocumented
No documentation available

Parameters (inferred)

optionID ❓ unknown
Parameter inferred from function signature
option ❓ unknown
Parameter inferred from function signature
optionTarget ❓ unknown
Parameter inferred from function signature
equipType ❓ unknown
Parameter inferred from function signature

GenerateUnequipSubMenu(optionID, option, optionTarget)

function undocumented
No documentation available

Parameters (inferred)

optionID ❓ unknown
Parameter inferred from function signature
option ❓ unknown
Parameter inferred from function signature
optionTarget ❓ unknown
Parameter inferred from function signature

getAdjacentSquare(cell, baseX, baseY, z, dx, dy)

function undocumented
No documentation available

Parameters (inferred)

cell ❓ unknown
Parameter inferred from function signature
baseX ❓ unknown
Parameter inferred from function signature
baseY ❓ unknown
Parameter inferred from function signature
z ❓ unknown
Parameter inferred from function signature
dx ❓ unknown
Parameter inferred from function signature
dy ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

getDistanceSquared(x1, y1, x2, y2)

function undocumented
No documentation available

Parameters (inferred)

x1 ❓ unknown
Parameter inferred from function signature
y1 ❓ unknown
Parameter inferred from function signature
x2 ❓ unknown
Parameter inferred from function signature
y2 ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

getPlayerGridCoords(player)

function undocumented
No documentation available

Parameters (inferred)

player ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

getScreenPositionCacheKey(playerId, x, y, z)

function undocumented
No documentation available

Parameters (inferred)

playerId ❓ unknown
Parameter inferred from function signature
x ❓ unknown
Parameter inferred from function signature
y ❓ unknown
Parameter inferred from function signature
z ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

gridContainer.hideTooltip(self2)

function undocumented
No documentation available

Parameters (inferred)

self2 ❓ unknown
Parameter inferred from function signature

gridContainer.onMouseMove(self2, dx, dy)

function undocumented
No documentation available

Parameters (inferred)

self2 ❓ unknown
Parameter inferred from function signature
dx ❓ unknown
Parameter inferred from function signature
dy ❓ unknown
Parameter inferred from function signature

gridContainer.onMouseMoveOutside(self2, dx, dy)

function undocumented
No documentation available

Parameters (inferred)

self2 ❓ unknown
Parameter inferred from function signature
dx ❓ unknown
Parameter inferred from function signature
dy ❓ unknown
Parameter inferred from function signature

gridContainer.onMouseUp(self2, x, y)

function undocumented
No documentation available

Parameters (inferred)

self2 ❓ unknown
Parameter inferred from function signature
x ❓ unknown
Parameter inferred from function signature
y ❓ unknown
Parameter inferred from function signature

gridContainer.render(self2)

function undocumented
No documentation available

Parameters (inferred)

self2 ❓ unknown
Parameter inferred from function signature

gridContainer.showTooltip(self2, text, mouseX, mouseY)

function undocumented
No documentation available

Parameters (inferred)

self2 ❓ unknown
Parameter inferred from function signature
text ❓ unknown
Parameter inferred from function signature
mouseX ❓ unknown
Parameter inferred from function signature
mouseY ❓ unknown
Parameter inferred from function signature

handler(...)

function undocumented
No documentation available

Parameters (inferred)

... ❓ unknown
Parameter inferred from function signature

hashObject(depth, object)

function undocumented
No documentation available

Parameters (inferred)

depth ❓ unknown
Parameter inferred from function signature
object ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

hashObject(object)

function undocumented
No documentation available

Parameters (inferred)

object ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

index(tbl, key)

function undocumented
No documentation available

Parameters (inferred)

tbl ❓ unknown
Parameter inferred from function signature
key ❓ unknown
Parameter inferred from function signature

index(tbl, key)

function undocumented
No documentation available

Parameters (inferred)

tbl ❓ unknown
Parameter inferred from function signature
key ❓ unknown
Parameter inferred from function signature

initializeFrameworkZItemLookup()

function undocumented
No documentation available

Returns (inferred)

⭕ void
Return type inferred from function name pattern

ipairs()

function undocumented
No documentation available

ipairs()

function undocumented
No documentation available

ISLockUnlockWindow.LockWindow(data, coordinates)

function undocumented
No documentation available

Parameters (inferred)

data ❓ unknown
Parameter inferred from function signature
coordinates ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

ISLockUnlockWindow.UnlockWindow(data, coordinates)

function undocumented
No documentation available

Parameters (inferred)

data ❓ unknown
Parameter inferred from function signature
coordinates ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

ISLockUnlockWindow:isValid()

method undocumented
No documentation available

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

ISLockUnlockWindow:new(character, window, shouldLock)

method undocumented
No documentation available

Parameters (inferred)

character ❓ unknown
Parameter inferred from function signature
window ❓ unknown
Parameter inferred from function signature
shouldLock ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

ISLockUnlockWindow:perform()

method undocumented
No documentation available

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

ISLockUnlockWindow:start()

method undocumented
No documentation available

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

ISLockUnlockWindow:stop()

method undocumented
No documentation available

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

ISLockUnlockWindow:update()

method undocumented
No documentation available

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

ISToolTipInv.render(self)

function undocumented
No documentation available

Parameters (inferred)

self ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

ITEM:CanContext(isoPlayer, worldItem)

method undocumented
No documentation available

Parameters (inferred)

isoPlayer ❓ unknown
Parameter inferred from function signature
worldItem ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

ITEM:CanDrop(isoPlayer, worldItem)

method undocumented
No documentation available

Parameters (inferred)

isoPlayer ❓ unknown
Parameter inferred from function signature
worldItem ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

ITEM:CanEquip(isoPlayer, worldItem, equipItems, equipType)

method undocumented
No documentation available

Parameters (inferred)

isoPlayer ❓ unknown
Parameter inferred from function signature
worldItem ❓ unknown
Parameter inferred from function signature
equipItems ❓ unknown
Parameter inferred from function signature
equipType ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

ITEM:CanUse(isoPlayer, worldItem)

method undocumented
No documentation available

Parameters (inferred)

isoPlayer ❓ unknown
Parameter inferred from function signature
worldItem ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

ITEM:GetName()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

ITEM:Initialize()

method undocumented
No documentation available

Returns (inferred)

⭕ void
Return type inferred from function name pattern

ITEM:OnContext(isoPlayer, worldItem, worldItems, menuManager, itemCount)

method undocumented
No documentation available

Parameters (inferred)

isoPlayer ❓ unknown
Parameter inferred from function signature
worldItem ❓ unknown
Parameter inferred from function signature
worldItems ❓ unknown
Parameter inferred from function signature
menuManager ❓ unknown
Parameter inferred from function signature
itemCount ❓ unknown
Parameter inferred from function signature

ITEM:OnEquip(isoPlayer, worldItem, equipItems, equipType)

method undocumented
No documentation available

Parameters (inferred)

isoPlayer ❓ unknown
Parameter inferred from function signature
worldItem ❓ unknown
Parameter inferred from function signature
equipItems ❓ unknown
Parameter inferred from function signature
equipType ❓ unknown
Parameter inferred from function signature

ITEM:OnInstanced(isoPlayer, worldItem)

method undocumented
No documentation available

Parameters (inferred)

isoPlayer ❓ unknown
Parameter inferred from function signature
worldItem ❓ unknown
Parameter inferred from function signature

ITEM:OnRemoved()

method undocumented
No documentation available

Returns (inferred)

⭕ void
Return type inferred from function name pattern

ITEM:OnUnequip(isoPlayer, worldItem, equipItems, equipType)

method undocumented
No documentation available

Parameters (inferred)

isoPlayer ❓ unknown
Parameter inferred from function signature
worldItem ❓ unknown
Parameter inferred from function signature
equipItems ❓ unknown
Parameter inferred from function signature
equipType ❓ unknown
Parameter inferred from function signature

ITEM:OnUse(isoPlayer, worldItem)

method undocumented
No documentation available

Parameters (inferred)

isoPlayer ❓ unknown
Parameter inferred from function signature
worldItem ❓ unknown
Parameter inferred from function signature

ITEM:Remove()

method undocumented
No documentation available

Returns (inferred)

⭕ void
Return type inferred from function name pattern

label.setName(lbl, newText)

function undocumented
No documentation available

Parameters (inferred)

lbl ❓ unknown
Parameter inferred from function signature
newText ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

len()

function undocumented
No documentation available

len()

function undocumented
No documentation available

loadCallback(loadedCharacter, message)

function undocumented
No documentation available

Parameters (inferred)

loadedCharacter ❓ unknown
Parameter inferred from function signature
message ❓ unknown
Parameter inferred from function signature

lockWindow()

function undocumented
No documentation available

mergeTables(t1, t2)

function undocumented
No documentation available

Parameters (inferred)

t1 ❓ unknown
Parameter inferred from function signature
t2 ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

newFrameworkZ()

function undocumented
No documentation available

Returns (inferred)

📦 object
Return type inferred from function name pattern

newindex(t, key, value)

function undocumented
No documentation available

Parameters (inferred)

t ❓ unknown
Parameter inferred from function signature
key ❓ unknown
Parameter inferred from function signature
value ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

newindex(tbl, key, value)

function undocumented
No documentation available

Parameters (inferred)

tbl ❓ unknown
Parameter inferred from function signature
key ❓ unknown
Parameter inferred from function signature
value ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

object.CreateObject(self, tbl, name)

function undocumented
No documentation available

Parameters (inferred)

self ❓ unknown
Parameter inferred from function signature
tbl ❓ unknown
Parameter inferred from function signature
name ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

Options:getAddOnTop()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

Options:getCallback()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

Options:getCallbackParameters()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

Options:getCount()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

Options:getTarget()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

Options:getText()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

Options:getUseMultiple()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

Options:setAddOnTop(addOnTop)

method undocumented
No documentation available

Parameters (inferred)

addOnTop ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

Options:setCallback(callback)

method undocumented
No documentation available

Parameters (inferred)

callback ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

Options:setCallbackParameters(callbackParameters)

method undocumented
No documentation available

Parameters (inferred)

callbackParameters ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

Options:setCount(count)

method undocumented
No documentation available

Parameters (inferred)

count ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

Options:setTarget(target)

method undocumented
No documentation available

Parameters (inferred)

target ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

Options:setText(text)

method undocumented
No documentation available

Parameters (inferred)

text ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

Options:setUseMultiple(useMultiple)

method undocumented
No documentation available

Parameters (inferred)

useMultiple ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

pairs()

function undocumented
No documentation available

pairs()

function undocumented
No documentation available

PLAYER:GenerateUID()

method undocumented
No documentation available

PLAYER:LoadCharacter(characterID, callback)

method undocumented
No documentation available

Parameters (inferred)

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

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:ValidatePlayerData()

method undocumented
No documentation available

rebuildAndInherit(item, definition)

function undocumented
No documentation available

Parameters (inferred)

item ❓ unknown
Parameter inferred from function signature
definition ❓ unknown
Parameter inferred from function signature

rebuildItem(item)

function undocumented
No documentation available

Parameters (inferred)

item ❓ unknown
Parameter inferred from function signature

roundFloats(t)

function undocumented
No documentation available

Parameters (inferred)

t ❓ unknown
Parameter inferred from function signature

safeGetWornItem(isoPlayer, slot)

function undocumented
No documentation available

Parameters (inferred)

isoPlayer ❓ unknown
Parameter inferred from function signature
slot ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

safeSetWornItem(isoPlayer, slot, item)

function undocumented
No documentation available

Parameters (inferred)

isoPlayer ❓ unknown
Parameter inferred from function signature
slot ❓ unknown
Parameter inferred from function signature
item ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

saveEquipmentSlot(slotName, slotEnum)

function undocumented
No documentation available

Parameters (inferred)

slotName ❓ unknown
Parameter inferred from function signature
slotEnum ❓ unknown
Parameter inferred from function signature

self.clothingScrollPanel.onMouseWheel(self2, del)

function undocumented
No documentation available

Parameters (inferred)

self2 ❓ unknown
Parameter inferred from function signature
del ❓ unknown
Parameter inferred from function signature

self.clothingScrollPanel.prerender(self2)

function undocumented
No documentation available

Parameters (inferred)

self2 ❓ unknown
Parameter inferred from function signature

self.clothingScrollPanel.render(self2)

function undocumented
No documentation available

Parameters (inferred)

self2 ❓ unknown
Parameter inferred from function signature

self.factionCardsContentPanel.onMouseWheel(panel, del)

function undocumented
No documentation available

Parameters (inferred)

panel ❓ unknown
Parameter inferred from function signature
del ❓ unknown
Parameter inferred from function signature

self.factionCardsContentPanel.prerender(panel)

function undocumented
No documentation available

Parameters (inferred)

panel ❓ unknown
Parameter inferred from function signature

self.factionCardsContentPanel.render(panel)

function undocumented
No documentation available

Parameters (inferred)

panel ❓ unknown
Parameter inferred from function signature

self.playerListPanel.onMouseWheel(self2, del)

function undocumented
No documentation available

Parameters (inferred)

self2 ❓ unknown
Parameter inferred from function signature
del ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

self.playerListPanel.prerender(self2)

function undocumented
No documentation available

Parameters (inferred)

self2 ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

self.playerListPanel.render(self2)

function undocumented
No documentation available

Parameters (inferred)

self2 ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

self.TickHandlers.OnPlayerMove(player)

function undocumented
No documentation available

Parameters (inferred)

player ❓ unknown
Parameter inferred from function signature

self.TickHandlers.OnPlayerUpdate(player)

function undocumented
No documentation available

Parameters (inferred)

player ❓ unknown
Parameter inferred from function signature

self.TickHandlers.OnTick()

function undocumented
No documentation available

self2.tooltipUI.render(tooltipSelf)

function undocumented
No documentation available

Parameters (inferred)

tooltipSelf ❓ unknown
Parameter inferred from function signature

SUBCLASS:Initialize()

method undocumented
No documentation available

Returns (inferred)

⭕ void
Return type inferred from function name pattern

tempHook(_isoPlayer, _command, _namespace, _keys, value)

function undocumented
No documentation available

Parameters (inferred)

_isoPlayer ❓ unknown
Parameter inferred from function signature
_command ❓ unknown
Parameter inferred from function signature
_namespace ❓ unknown
Parameter inferred from function signature
_keys ❓ unknown
Parameter inferred from function signature
value ❓ unknown
Parameter inferred from function signature

timerUpdate()

function undocumented
No documentation available

type(lol)

function undocumented
No documentation available

Parameters (inferred)

lol ❓ unknown
Parameter inferred from function signature

UI:Initialize()

method undocumented
No documentation available

Returns (inferred)

⭕ void
Return type inferred from function name pattern

UI:ShowNextStep()

method undocumented
No documentation available

UI:ShowPreviousStep()

method undocumented
No documentation available

unlockWindow()

function undocumented
No documentation available

valid(object)

function undocumented
No documentation available

Parameters (inferred)

object ❓ unknown
Parameter inferred from function signature

wrapFunctionsWithValidation(depth, tbl, object, visited)

function undocumented
No documentation available

Parameters (inferred)

depth ❓ unknown
Parameter inferred from function signature
tbl ❓ unknown
Parameter inferred from function signature
object ❓ unknown
Parameter inferred from function signature
visited ❓ unknown
Parameter inferred from function signature

wrapFunctionsWithValidation(tbl, object, visited)

function undocumented
No documentation available

Parameters (inferred)

tbl ❓ unknown
Parameter inferred from function signature
object ❓ unknown
Parameter inferred from function signature
visited ❓ unknown
Parameter inferred from function signature

wrappedFunc(...)

function undocumented
No documentation available

Parameters (inferred)

... ❓ unknown
Parameter inferred from function signature