API Reference
Library Methods
:Register(delegate_name, delegate)
Registers a new dialog delegate.
Arguments
- delegate_name
- string - The name the delegate table will be registered under.
- delegate
- table - The delegate properties definition. (Delegate Reference.)
:Spawn(reference[, data])
Spawns a dialog from a delegate reference.
Arguments
- reference
- string or table - The delegate to be used for the spawned dialog. Can be either a string, in which case the delegate must be registered, or a delegate definition table.
- data
- variable - Additional data to be passed on to the resultant dialog.
:ActiveDialog(reference[, data])
Determines whether or not a specific dialog is currently active.
Arguments
- reference
- string or table - The delegate criteria for the dialog being targeted. Can be either a string, in which case the delegate must be registered, or a delegate definition table.
- data
- variable - Additional data to be used as further criteria to determine if the target dialog is active - this would be the same data used to spawn the dialog.
:Dismiss(reference[, data])
Dismisses a specific dialog.
Arguments
- reference
- string or table - The delegate criteria for the dialog being targeted. Can be either a string, in which case the delegate must be registered, or a delegate definition table.
- data
- variable - Additional data to be used as further criteria to identify the target dialog - this would be the same data used to spawn the dialog.
Dialog Methods
:Reset()
Resets the dialog to default settings.
:Resize()
Resizes the dialog according to its buttons and other widgets.