Modding:UI - Revision history

Game Hunter: revised with new templates

2012-03-25T00:15:01Z

revised with new templates

Shark20061: Another minor fix.

2012-03-24T04:58:01Z

Another minor fix.

Shark20061: Forgot a semicolon. D'oh.

2012-03-24T04:53:50Z

Forgot a semicolon. D'oh.

Shark20061: Creating page with what I have figured out. Warning, information is not guaranteed to be completely correct!

2012-03-24T04:51:54Z

Creating page with what I have figured out. Warning, information is not guaranteed to be completely correct!

New page

These functions provide access to functions that work with the user interface.

== API ==

{|class="wikitable" style="border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"
! colspan="3" style="background: darkred; color: yellow; font-size: 120%; text-align: center"|'''UI'''
{{Table2Col
|es=background: #333;
|c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 2px;
|c2=padding:0px 2px;
| '''void''' | ui.[[#msg|msg]]('''string''' message)
| '''void''' | ui.[[#msg_clear|msg_clear]]( )
| '''string''' | ui.[[#msg_history|msg_history]]('''integer''' numMessages)
| '''void''' | ui.[[#msg_enter|msg_enter]]('''string''' message)
| '''boolean''' | ui.[[#msg_confirm|msg_confirm]]('''string''' message, '''boolean''' warning)
| '''string''' | ui.[[#msg_choice|msg_choice]]('''string''' message, '''table''' choices)
| '''void''' | ui.[[#blood_slide|blood_slide]]( )
| '''void''' | ui.[[#blink|blink]]('''[[Modding:Constants#Colors|Color]]''' color, '''integer''' duration)
| '''void''' | ui.[[#set_hint|set_hint]]('''string''' hint_text)
| '''void''' | ui.[[#plot_screen|plot_screen]]('''string''' text)
|}}
|}
----
{{anchor|msg}}
;ui.msg('''string''' message)
:Prints ''message'' to the message area at the top of the screen.
----
{{anchor|msg_clear}}
;ui.msg_clear( )
:Adds two blank lines to the message area, clearing it out.
----
{{anchor|msg_history}}
;ui.msg_history('''integer''' numMessages) → '''string'''
:Returns the last ''numMessages'' messages from the message list. If 0 is entered, it will return only the most recent message.
----
{{anchor|msg_enter}}
;ui.msg_enter('''string''' message)
:Prints ''message'' to the message area at the top of the screen, followed by the text "Press Enter...", and then waits for an Enter press (or click in Graphics mode).
----
{{anchor|msg_confirm}}
;ui.msg_confirm('''string''' message, '''boolean''' warning) → '''boolean'''
:Prints ''message'' to the message area at the top of the screen, followed by "[y/n]", and waits for the user to hit the y or n key. Returns true if the y key was pressed, otherwise returns false. If ''warning'' is true, the confirm response is Shift-Y (similar to quitting and nuking) instead of just y.
----
{{anchor|msg_choice}}
;ui.msg_choice('''string''' message, '''table''' choices) &rarr '''string'''
:Prints ''message'' to the message area at the top of the screen, followed by the list of possible ''choices'', then waits for the user to make a selection or cancel. ''Choices'' must be a character array (i.e., a table of length 1 strings) which indicates the valid choices. The function returns a string containing the choice selected, or the empty string if they hit ESC instead.
----
{{anchor|blood_slide}}
;ui.blood_slide( )
:Creates the blood slide animation. Doesn't work in 0.9.9.6, but will in older versions.
----
{{anchor|blink}}
;ui.blink('''[[Modding:Constants#Colors|Color]]''' color, '''integer''' duration)
:Makes the screen flash ''color'' for ''duration'' milliseconds.
----
{{anchor|set_hint}}
;ui.set_hint('''string''' message)
:Displays ''message'' in the hint area, which is right-aligned and under the message area.
----
{{anchor|plot_screen}}
;ui.plot_screen('''string''' text)
:Creates a black screen that writes ''text'' one letter at a time, similar to the intro text. ''Text'' can be a multi line string, the newlines will be properly displayed.

← Older revision		Revision as of 04:58, 24 March 2012
Line 1:		Line 1:
−	~~These functions provide~~ access to functions that work with the user interface.	+	The UI table provides access to functions that work with the user interface.

	== API ==		== API ==

@@ Line 3: / Line 3: @@
 == API ==
-{|class="wikitable" style="border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"
+{{drltable|UI Interface|2|{{Table2Col
- ! colspan="3" style="background: darkred; color: yellow; font-size: 120%; text-align: center"|'''UI'''
- {{Table2Col
    |es=background: #333;
    |c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 2px;
    |c2=padding:0px 2px;
-   | '''void'''        | ui.[[#msg|msg]]('''string''' message)
+   |{{modarg|void}}   |{{moddef|list|msg|dot||string|message}}
-   | '''void'''        | ui.[[#msg_clear|msg_clear]]( )
+   |{{modarg|void}}   |{{moddef|list|msg_clear|dot}}
-   | '''string'''      | ui.[[#msg_history|msg_history]]('''integer''' numMessages)
+   |{{modarg|string}} |{{moddef|list|msg_history|dot||integer|numMessages}}
-   | '''void'''        | ui.[[#msg_enter|msg_enter]]('''string''' message)
+   |{{modarg|void}}   |{{moddef|list|msg_enter|dot||string|message}}
-   | '''boolean'''     | ui.[[#msg_confirm|msg_confirm]]('''string''' message, '''boolean''' warning)
+   |{{modarg|boolean}}|{{moddef|list|msg_confirm|dot||string|message|boolean|warning}}
-   | '''string'''      | ui.[[#msg_choice|msg_choice]]('''string''' message, '''table''' choices)
+   |{{modarg|string}} |{{moddef|list|msg_choice|dot||string|message|table|choices}}
-   | '''void'''        | ui.[[#blood_slide|blood_slide]]( )
+   |{{modarg|void}}   |{{moddef|list|blood_slide|dot}}
-   | '''void'''        | ui.[[#blink|blink]]('''[[Modding:Constants#Colors|Color]]''' color, '''integer''' duration)
+   |{{modarg|void}}   |{{moddef|list|blink|dot||Color|color|integer|duration}}
-   | '''void'''        | ui.[[#set_hint|set_hint]]('''string''' hint_text)
+   |{{modarg|void}}   |{{moddef|list|set_hint|dot||string|hint_text}}
-   | '''void'''        | ui.[[#plot_screen|plot_screen]]('''string''' text)
+   |{{modarg|void}}   |{{moddef|list|plot_screen|dot||string|text}}
    |}}
-|}
+}}
 ----
-{{anchor|msg}}
+{{moddef|desc|msg|dot||string|message}}
-;ui.msg('''string''' message)
 :Prints ''message'' to the message area at the top of the screen.
 ----
-{{anchor|msg_clear}}
+{{moddef|desc|msg_clear|dot}}
-;ui.msg_clear( )
 :Adds two blank lines to the message area, clearing it out.
 ----
-{{anchor|msg_history}}
+{{moddef|desc|msg_history|dot|string|integer|numMessages}}
-;ui.msg_history('''integer''' numMessages) &rarr; '''string'''
 :Returns the last ''numMessages'' messages from the message list.  If 0 is entered, it will return only the most recent message.
 ----
-{{anchor|msg_enter}}
+{{moddef|desc|msg_enter|dot||string|message}}
-;ui.msg_enter('''string''' message)
 :Prints ''message'' to the message area at the top of the screen, followed by the text "Press Enter...", and then waits for an Enter press (or click in Graphics mode).
 ----
-{{anchor|msg_confirm}}
+{{moddef|desc|msg_confirm|dot|boolean|string|message|boolean|warning}}
-;ui.msg_confirm('''string''' message, '''boolean''' warning) &rarr; '''boolean'''
 :Prints ''message'' to the message area at the top of the screen, followed by "[y/n]", and waits for the user to hit the y or n key.  Returns true if the y key was pressed, otherwise returns false.  If ''warning'' is true, the confirm response is Shift-Y (similar to quitting and nuking) instead of just y.
 ----
-{{anchor|msg_choice}}
+{{moddef|desc|msg_choice|dot|string|string|message|table|choices}}
-;ui.msg_choice('''string''' message, '''table''' choices) &rarr; '''string'''
 :Prints ''message'' to the message area at the top of the screen, followed by the list of possible ''choices'', then waits for the user to make a selection or cancel.  ''Choices'' must be a character array (i.e., a table of length 1 strings) which indicates the valid choices.  The function returns a string containing the choice selected, or the empty string if they hit ESC instead.
 ----
-{{anchor|blood_slide}}
+{{moddef|desc|blood_slide|dot}}
-;ui.blood_slide( )
 :Creates the blood slide animation.  Doesn't work in 0.9.9.6, but will in older versions.
 ----
-{{anchor|blink}}
+{{moddef|desc|blink|dot||Color|color|integer|duration}}
-;ui.blink('''[[Modding:Constants#Colors|Color]]''' color, '''integer''' duration)
 :Makes the screen flash ''color'' for ''duration'' milliseconds.
 ----
-{{anchor|set_hint}}
+{{moddef|desc|set_hint|dot||string|hint_text}}
-;ui.set_hint('''string''' message)
 :Displays ''message'' in the hint area, which is right-aligned and under the message area.
 ----
-{{anchor|plot_screen}}
+{{moddef|desc|plot_screen|dot||string|text}}
-;ui.plot_screen('''string''' text)
 :Creates a black screen that writes ''text'' one letter at a time, similar to the intro text.  ''Text'' can be a multi line string, the newlines will be properly displayed.