View source for UI (functions)/Textbox

== WaitShowDialogue ==

Displays a dialogue box with text, waiting until the player completes it.
Takes a string as an argument.


=== Arguments ===
Argument order is <code>UI:WaitShowDialouge(text, callbacks)</code>
{| class="wikitable"
|-
! Name !! Type !! Technical Type !! Purpose !! Required
|-
| text || String || ? || The text to display with the textbox. || Yes
|-
| callbacks || Lua Table || ? || A table of callbacks to be called by the textbox for customization features. || No
|-
|}

=== Example ===

<pre>

UI:WaitShowDialogue("Hello World!")

</pre>

== WaitShowTimedDialogue ==


Displays a dialogue box with text, waiting until the specified time has expired.


=== Arguments ===
Argument order is <code>UI:WaitShowTimedDialouge(text, waitTime, callbacks)</code>
{| class="wikitable"
|-
! Name !! Type !! Technical Type !! Purpose !! Required
|-
| text || String || ? || The text to display with the textbox. || Yes
|-
| waitTime || Integer || ? || The time for the textbox to remain on screen. Pass -1 to wait for layer input. || Yes
|-
| callbacks || Lua Table || ? || A table of callbacks to be called by the textbox for customization features. || No
|-
|}

=== Example ===

<pre>

UI:WaitShowTimedDialogue("Hello World!", 120)

</pre>

== TextDialogue ==


Sets the current dialogue text to be shown. Requires WaitDialog to actually display.

=== Arguments ===
Argument order is <code>UI:TextDialogue(text, waitTime, callbacks)</code>
{| class="wikitable"
|-
! Name !! Type !! Technical Type !! Purpose !! Required
|-
| text || String || System.String || The text to display with the textbox. || Yes
|-
| waitTime || Integer || System.Int32 || The time for the textbox to remain on screen. Pass -1 to wait for layer input. || No
|-
| callbacks || Lua Table || NLua.LuaTable  || A table of callbacks to be called by the textbox for customization features. || No
|-
|}


== WaitShowVoiceOver ==


Displays a voice over, waiting until the player completes it.


=== Arguments ===
Argument order is <code>UI:WaitShowVoiceOver(text, expireTime, x, y, width, height, callbacks)</code>
{| class="wikitable"
|-
! Name !! Type !! Technical Type !! Purpose !! Required
|-
| text || String || System.String || The text to display with the textbox. || Yes
|-
| expireTime || Integer || System.Int32 || The time for the textbox to remain on screen. Pass -1 to wait for layer input. || No
|-
| x || Integer || System.Int32 || The starting X position of the box. || No
|-
| y || Integer || System.Int32 || The starting Y position of the box || No
|-
| width || Integer || System.Int32 || The width of the box. || No
|-
| height || Integer || System.Int32 || The height of the box. || No
|-
| callbacks || Lua Table || NLua.LuaTable  || A table of callbacks to be called by the textbox for customization features. || No
|-
|}

=== Example ===

<pre>

UI:WaitShowVoiceOver("Hello World!", 120)

</pre>

== TextVoiceOver ==


Sets the current voice-over text to be shown.  Requires WaitDialog to actually display.


=== Arguments ===
Argument order is <code>UI:TextVoiceOver(text, expireTime, x, y, width, height, callbacks)</code>
{| class="wikitable"
|-
! Name !! Type !! Technical Type !! Purpose !! Required
|-
| text || String || System.String || The text to display with the textbox. || Yes
|-
| expireTime || Integer || System.Int32 || The time for the textbox to remain on screen. Pass -1 to wait for layer input. || No
|-
| x || Integer || System.Int32 || The starting X position of the box. || No
|-
| y || Integer || System.Int32 || The starting Y position of the box || No
|-
| width || Integer || System.Int32 || The width of the box. || No
|-
| height || Integer || System.Int32 || The height of the box. || No
|-
| callbacks || Lua Table || NLua.LuaTable  || A table of callbacks to be called by the textbox for customization features. || No
|-
|}

== TextPopUp ==

Makes text pop up in the bottom-left corner by default. Displays concurrently with any other process.

=== Arguments ===
Argument order is <code>UI:TextPopUp(text, expireTime, x, y, width, height, callbacks)</code>
{| class="wikitable"
|-
! Name !! Type !! Technical Type !! Purpose !! Required
|-
| text || String || System.String || The text to display with the textbox. || Yes
|-
| expireTime || Integer || System.Int32 || The time for the textbox to remain on screen. Pass -1 to wait for layer input. || No
|-
| x || Integer || System.Int32 || The starting X position of the box. || No
|-
| y || Integer || System.Int32 || The starting Y position of the box || No
|-
| width || Integer || System.Int32 || The width of the box. || No
|-
| height || Integer || System.Int32 || The height of the box. || No
|-
| centerH || Boolean || System.Boolean  || True if the text should be centered horizontally. || No
|-
| centerV || Boolean || System.Boolean  || True if the text should be centered vertically. || No
|-
|}

== WaitShowTitle ==
Fades in a title text, waiting until the fade-in is complete.

=== Arguments ===
Argument order is <code>UI:WaitShowTitle(text, time)</code>
{| class="wikitable"
|-
! Name !! Type !! Technical Type !! Purpose !! Required
|-
| text || String || System.String || The text to display with the textbox. || Yes
|-
| time || Integer || System.Int32 || How long the text takes to fade in. || No
|}

=== Example ===
<pre>

UI:WaitShowTitle("Hello World!", 60)

</pre>

== TextShowTitle ==
Shows text in the format of a title drop.  Requires WaitDialog to actually display.

=== Arguments ===
{| class="wikitable"
{{ArgHeader}}
{{ArgRow
|name=text
|type=String
|techt=System.String
|purp=The text to display.
}}
{{ArgRow
|name=time
|type=Integer
|techt=System.Int32
|purp=The time for the text to fade in.
}}
|}

== WaitHideTitle ==

Fades out the currently displayed title, waiting until the fade-out is complete.

=== Arguments ===
{| class="wikitable"
{{ArgHeader}}
{{ArgRow
|name=time
|type=Integer
|techt=System.Int32
|purp=The time for the text to fade in.
}}
|}

=== Example ===

<pre>

UI:WaitHideTitle(60)

</pre>

== TextFadeTitle ==

Fades out the text set in a title drop.  Requires WaitDialog to actually fade.

=== Arguments ===
{| class="wikitable"
{{ArgHeader}}
{{ArgRow
|name=time
|type=Integer
|techt=System.Int32
|purp=The time for the text to fade in.
}}
|}

== WaitDialog ==

Displays the currently set dialogue box and waits for the player to complete it.

=== Example ===

<pre>

UI:WaitDialog()

</pre>

== UI:_DummyWait ==


Instantly break. Used as default/invalid value when returning a yieldable value.