FrameworkZ API - FrameworkZ.Interfaces

Home / FrameworkZ.Interfaces Module

FrameworkZ.Interfaces

module
1
Functions
13
Methods
1
Fields

📋 On This Page

Fields

1
FrameworkZ.Interfaces 📋 table
Initial value: {}

Methods

13

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

Functions

1

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.