tes3ui.showMessageMenu.params.button⚓︎
Layout for the buttons table passed to tes3ui.showMessageMenu function.
Properties⚓︎
callback⚓︎
The function to call when this button is clicked. This function will be passed the callbackParams table that was provided in tes3ui.showMessageMenu.
Returns:
result(nil, fun(callbackParams: table))
enableRequirements⚓︎
Function that, if provided, determines whether the button will call the callback when clicked, or be disabled + greyed out. This function will be passed the callbackParams table that was provided in tes3ui.showMessageMenu.
Returns:
result(nil, fun(callbackParams: table): boolean, nil)
showRequirements⚓︎
If set, the button will only be visible if this function returns true. This function will be passed the callbackParams table that was provided in tes3ui.showMessageMenu.
Returns:
result(nil, fun(callbackParams: table): boolean, nil)
text⚓︎
Required. The label on the button.
Returns:
result(string)
tooltip⚓︎
A table with header and text that will display as a tooltip when an enabled button is hovered over. Can also be a function that returns a tes3ui.showMessageMenu.params.tooltip.
Returns:
result(nil, tes3ui.showMessageMenu.params.tooltip, fun(callbackParams: table): tes3ui.showMessageMenu.params.tooltip, nil)
tooltipDisabled⚓︎
The tooltip to show when the button is disabled. Can be a simple string or a table with header and text that will display as a tooltip when a disabled button is hovered over. Can also be a function that returns a tes3ui.showMessageMenu.params.tooltip.
Returns:
result(nil, string, tes3ui.showMessageMenu.params.tooltip, fun(callbackParams: table): tes3ui.showMessageMenu.params.tooltip, nil)