FrameworkZ API - DATABASE

DATABASE

class

Database class for FrameworkZ.

0
Functions
13
Methods
1
Fields

Fields

1
DATABASE 📋 table
Database class for FrameworkZ.
Initial value: {}

Methods

13

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.

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