Ui::setTextWrap: Difference between revisions

From RAGE Multiplayer Wiki
(yay)
 
No edit summary
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
It sets the text in a specified box and wraps the text if it exceeds the boundries. Both values are for X axis. Useful when positioning text set to center or aligned to the right.<br><br>start - left boundry on screen position (0.0 - 1.0)<br>end - right boundry on screen position (0.0 - 1.0)
It sets the text in a specified box and wraps the text if it exceeds the boundries. Both values are for X axis. Useful when positioning text set to center or aligned to the right.<br><br>start - left boundry on screen position (0.0 - 1.0)<br>end - right boundry on screen position (0.0 - 1.0)
==Syntax==
==Syntax==
<syntaxhighlight lang="javascript">ui.setTextWrap(start, end);</syntaxhighlight>
<syntaxhighlight lang="javascript">mp.game.ui.setTextWrap(start, end);</syntaxhighlight>
=== Required Arguments ===
=== Required Arguments ===
*'''start:''' float
*'''start:''' float
Line 9: Line 9:
==Example==
==Example==
<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">
todo
// todo
</syntaxhighlight>
</syntaxhighlight>
==See also==
==See also==
{{Ui_function_c}}
{{Ui_s_function_c}}
[[Category:Clientside API]]
[[Category:Clientside API]]
[[Category:UI API]]
[[Category:TODO: Example]]
[[Category:TODO: Example]]

Latest revision as of 14:54, 20 May 2017

It sets the text in a specified box and wraps the text if it exceeds the boundries. Both values are for X axis. Useful when positioning text set to center or aligned to the right.

start - left boundry on screen position (0.0 - 1.0)
end - right boundry on screen position (0.0 - 1.0)

Syntax

mp.game.ui.setTextWrap(start, end);

Required Arguments

  • start: float
  • end: float

Return value

  • Undefined

Example

// todo

See also