CreateTextItem - Revision history

Lil Toady at 22:58, 25 April 2013

2013-04-25T22:58:32Z

← Older revision		Revision as of 22:58, 25 April 2013
Line 97:		Line 97:
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>



	* Author : '''Mr.Pres[T]ege'''. All Copy Rights Received To '''Multitheftauto''' .

	==See Also==		==See Also==

Imr-prestege: Example < >

2013-04-25T20:35:05Z

Example < >

Imr-prestege at 20:32, 25 April 2013

2013-04-25T20:32:07Z

← Older revision		Revision as of 20:32, 25 April 2013
Line 38:		Line 38:

	==Code==		==Code==
	<section name="Function source" class="~~both~~" show="true"><syntaxhighlight lang="lua">		<section name="Function source" class="server" show="true"><syntaxhighlight lang="lua">
	function CreateTextItem ( player, time, r, g, b, scale, text, x, y, alignX, alignY)		function CreateTextItem ( player, time, r, g, b, scale, text, x, y, alignX, alignY)
	if not player or not time or not text then return end		if not player or not time or not text then return end

Imr-prestege: Create a New Page

2013-04-25T20:31:12Z

Create a New Page

New page

<pageclass class="#228B22" subcaption="Useful Function"></pageclass>
<lowercasetitle/>

__NOTOC__
{{Useful Function}}
'''With this function you can create any text you want with any size color visible to who you want and this function server side only!'''
<br /><br />

==Syntax==
<syntaxhighlight lang="lua">
bool CreateTextItem ( player playerToAdd , time, int red = 255, int green = 255, int blue = 255, float scale = 1, string text, [ float x, float y, string alignX = "left", string alignY = "top"] )
</syntaxhighlight>

===Required Arguments===

* '''playerToAdd: The player that should observe the textdisplay.'''
* '''time: The number of times you want to the remove The textdisplay ,number of milliseconds (the minimum is 50)(1000 milliseconds = 1 second)'''
* '''red: A value between 0 and 255 indicating how red the text should be.'''
* '''green: A value between 0 and 255 indicating how green the text should be.'''
* '''blue: A value between 0 and 255 indicating how blue the text should be.'''
* '''scale: A floating point value indicating the scale of the text. The default is 1.0, which is around 12pt.'''
* '''text: A string of text you want to display'''

===Optional Arguments===

* x: A floating point number between 0.0 and 1.0 indicating how far across the screen the text should be shown, as a percentage of the width, from the left hand side.
* y: A floating point number between 0.0 and 1.0 indicating how far down the screen the text should be shown, as a percentage of the height, from the top.
* scale: A floating point value indicating the scale of the text. The default is 1.0, which is around 12pt.
* alignX: A string representing the X-alignment of the text. ("left", "center", "right")
* alignY: A string representing the Y-alignment of the text. ("top", "center", "bottom")

===Important Note===
* '''You can't use ''''getRootElement()'''' element you will get some errors you have to use getElementsByType to get All Players!'''

==Code==
<section name="Function source" class="both" show="true"><syntaxhighlight lang="lua">
function CreateTextItem ( player, time, r, g, b, scale, text, x, y, alignX, alignY)
if not player or not time or not text then return end
if not r and not g and not b then r, g, b = 255, 0, 0 end
if not scale then scale = 1 end
if ( isElement( player ) and type ( text ) == 'string' and tonumber( time) ) then
local Display = textCreateDisplay ()
local newtextItem = textCreateTextItem ( text, x or 0.5, y or 0.5, 2, r, g, b, 255, scale, alignX or "center", alignY or "center" )
textDisplayAddText ( Display, newtextItem )
textDisplayAddObserver ( Display, player )
setTimer(textDestroyTextItem, time, 1, newtextItem)
setTimer(textDestroyDisplay, time, 1, Display)
end
end
</syntaxhighlight></section>

==Example==
<section name="Server Example" class="server" show="true">
This Example creates a text item. A text item represents a single area of text, much like a label !
<syntaxhighlight lang="lua">
addCommandHandler("Create",
function ( element , cmd , item )
local Text = tostring ( item )
if ( Text ) then
CreateTextItem ( element, 5000, 255, 255, 0, 5,Text )
end
end
)</syntaxhighlight>
</section>

==Example==
<section name="Server Full Example" class="server" show="true">
This Example creates a text item. A text item represents a single area of text, much like a label !
<syntaxhighlight lang="lua">
function CreateTextItem ( player, time, r, g, b, scale, text, x, y, alignX, alignY)
if not player or not time or not text then return end
if not r and not g and not b then r, g, b = 255, 0, 0 end
if not scale then scale = 1 end
if ( isElement( player ) and type ( text ) == 'string' and tonumber( time) ) then
local Display = textCreateDisplay ()
local newtextItem = textCreateTextItem ( text, x or 0.5, y or 0.5, 2, r, g, b, 255, scale, alignX or "center", alignY or "center" )
textDisplayAddText ( Display, newtextItem )
textDisplayAddObserver ( Display, player )
setTimer(textDestroyTextItem, time, 1, newtextItem)
setTimer(textDestroyDisplay, time, 1, Display)
end
end

addCommandHandler("Test",
function ( )
for _,v in ipairs ( getElementsByType("player") ) do
CreateTextItem ( v, 5000, 255, 255, 0, 5,"Test Text" )
end
end
)
</syntaxhighlight>
</section>

* Author : '''Mr.Pres[T]ege'''. All Copy Rights Received To '''Multitheftauto''' .

==See Also==
{{Useful_Functions}}

[[Category:Useful Functions]]

← Older revision		Revision as of 20:35, 25 April 2013
Line 23:		Line 23:
	* '''scale: A floating point value indicating the scale of the text. The default is 1.0, which is around 12pt.'''		* '''scale: A floating point value indicating the scale of the text. The default is 1.0, which is around 12pt.'''
	* '''text: A string of text you want to display'''		* '''text: A string of text you want to display'''



Line 32:		Line 33:
	* alignX: A string representing the X-alignment of the text. ("left", "center", "right")		* alignX: A string representing the X-alignment of the text. ("left", "center", "right")
	* alignY: A string representing the Y-alignment of the text. ("top", "center", "bottom")		* alignY: A string representing the Y-alignment of the text. ("top", "center", "bottom")


	===Important Note===		===Important Note===
Line 40:		Line 42:
	<section name="Function source" class="server" show="true"><syntaxhighlight lang="lua">		<section name="Function source" class="server" show="true"><syntaxhighlight lang="lua">
	function CreateTextItem ( player, time, r, g, b, scale, text, x, y, alignX, alignY)		function CreateTextItem ( player, time, r, g, b, scale, text, x, y, alignX, alignY)
	if not player or not time or not text then return end		if not player or not time or not text then return end
	if not r and not g and not b then r, g, b = 255, 0, 0 end		if not tonumber(r) and not tonumber(g) and not tonumber(b) then r, g, b = 255, 0, 0 end
	if not scale then scale = 1 end		if not scale then scale = 1 end
	if ( isElement( player ) and type ( text ) == 'string' and tonumber( time) ) then		if ( isElement( player ) and type ( text ) == 'string' and tonumber( time) ) then
	local Display = textCreateDisplay ()		local Display = textCreateDisplay ()
	local newtextItem = textCreateTextItem ( text, x or 0.5, y or 0.5, 2, r, g, b, 255, scale, alignX or "center", alignY or "center" )		local newtextItem = textCreateTextItem ( text, x or 0.5, y or 0.5, 2, r, g, b, 255, scale, alignX or "center", alignY or "center" )
	textDisplayAddText ( Display, newtextItem )		textDisplayAddText ( Display, newtextItem )
	textDisplayAddObserver ( Display, player )		textDisplayAddObserver ( Display, player )
	setTimer(textDestroyTextItem, time, 1, newtextItem)		setTimer(textDestroyTextItem, time, 1, newtextItem)
	setTimer(textDestroyDisplay, time, 1, Display)		setTimer(textDestroyDisplay, time, 1, Display)
	end		end
	end		end
	</syntaxhighlight></section>		</syntaxhighlight></section>