SDialogues
Index
void ColorPicker (string title, string okbutton, Action< SColor > onChange, Action< SColor > onSelect, Action onCancel, SColor defaultColor)
void YesNoInput (string title, string okbutton, string cancelButton, Action< bool > result)
void TextInput (string title, string okButton, Action< string > result)
void OpenURL (string url, bool newTab = true)
void SendLocalChat (string message, string from)
Functions
ColorPicker
Opens a color picker dialogue.
void ColorPicker(string title, string okbutton, Action< SColor > onChange, Action< SColor > onSelect, Action onCancel, SColor defaultColor)
title
string
The title of the color picker window. Choose something brief and appropriate like 'Select a wall color'.
okbutton
string
The title of the 'OK' button. Should indicate the action e.g. 'Adjust Wall'.
onChange
Action<SColor> or Closure
Any color change while the color picker is open will trigger onChange(SColor).
onSelect
Action<SColor> or Closure
Triggers onSelect(SColor) once the "ok" button is pressed.
onCancel
Action<SColor> or Closure
The title of the 'OK' button. Should indicate the action e.g. 'Adjust Wall'.
defaultColor
SColor
The color to open the colour picker with.
YesNoInput
Opens a simple Yes/No dialogue.
void YesNoInput(string title, string okbutton, string cancelButton, Action< bool > result)
title
string
The question to be asked of the user. Should be a simple statement, e.g. "Save room changes?"
okbutton
string
The text on the OK button, should indicate the action, e.g. "Save Room"
cancelButton
string
The text on the cancel button, should indicate the action, e.g. "Not now"
result
Action<bool>
Will fire a callback event depending on the status of the users actions
TextInput
Opens a text entry window with room for a single multi-line text field.
void TextInput ( string title, string okButton, Action< string > result)
title
string
The accompanying text. Should be something ala "Enter your username".
okButton
string
The text displayed on the OK button, should be descriptive, e.g. "Change Username".
result
Action< string >
Triggers result(string) once the "Ok" button is pressed.
OpenURL
Opens the specified URL in the in-app web browser, or the system web browser. In some environments the user may be prompted before this is opened.
void OpenURL ( string url, bool newTab = true )
url
string
The web address to open.
newTab
bool
Does the URL open in a new browser tab?
SendLocalChat
Sends a message into the 'Script' chat channel.
void SendLocalChat ( string message, string from )
message
string
The message to appear in the channel.
from
string
The 'from' username for the message.
Last updated