Resource:DxDraw3DText - Revision history

Pirulax: Grammar

2018-01-09T22:42:48Z

Grammar

← Older revision		Revision as of 22:42, 9 January 2018
Line 5:		Line 5:

	==How it works==		==How it works==
	You ~~only~~ need to use the exported function ~~from the resource~~ '''dxDraw3DText''' ~~and~~ draw the ~~text~~ . ( ~~To use~~ the exported function ~~use [[call]] function~~ ) .		You need to use the exported function called '''dxDraw3DText''' to draw a text in the 3D world. (Use the exported function like this: exports.3d_dx_texts:dxDraw3DText)


	==The dxDraw3DText function==		==The dxDraw3DText function==

Ceeser at 23:50, 6 January 2018

2018-01-06T23:50:39Z

← Older revision		Revision as of 23:50, 6 January 2018
Line 1:		Line 1:
	{{~~Resource page~~}}		{{Client function}}

	This resource ~~allowe~~ you to draw 3D-DX texts any where in the game. You need to add a Text to display only once.		This resource allow you to draw 3D-DX texts any where in the game. You need to add a Text to display only once.

Ceeser at 13:01, 28 October 2017

2017-10-28T13:01:24Z

← Older revision		Revision as of 13:01, 28 October 2017
Line 79:		Line 79:
	*'''colorCoded :''' Set to true to enable embedded #FFFFFF color codes. '''Note: clip and wordBreak are forced false if this is set.'''		*'''colorCoded :''' Set to true to enable embedded #FFFFFF color codes. '''Note: clip and wordBreak are forced false if this is set.'''

	==Code==		===Code===
	<section name="Client" class="client" show="true">		<section name="Client" class="client" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Ceeser at 13:00, 28 October 2017

2017-10-28T13:00:46Z

← Older revision		Revision as of 13:00, 28 October 2017
Line 58:		Line 58:


	===Alternative Function===		==Alternative Function==
	This alternative function is meant to be used directly with the eventHandler [[onClientRender]].		This alternative function is meant to be used directly with the eventHandler [[onClientRender]].

Ceeser: /* Code */

2017-10-26T22:06:00Z

Code

← Older revision		Revision as of 22:06, 26 October 2017
Line 84:		Line 84:
	function dxDraw3DText(text, x, y, z, scale, font, color, maxDistance, colorCoded)		function dxDraw3DText(text, x, y, z, scale, font, color, maxDistance, colorCoded)
	if not (x and y and z) then		if not (x and y and z) then
	outputDebugString("dxDraw3DText: One of the world coordinates is missing", 1)		outputDebugString("dxDraw3DText: One of the world coordinates is missing", 1);
	return false;		return false;
	end		end
Line 116:		Line 116:
	if (x and y) then		if (x and y) then
	dxDrawText( text, x, y, _, _, color, scale, font, "center", "center", false, false, false, colorCoded);		dxDrawText( text, x, y, _, _, color, scale, font, "center", "center", false, false, false, colorCoded);
			return true;
	end		end
	end		end

Ceeser at 22:04, 26 October 2017

2017-10-26T22:04:08Z

← Older revision		Revision as of 22:04, 26 October 2017
Line 58:		Line 58:


	==Alternative Function==		===Alternative Function===
	This alternative function is meant to be used directly with the eventHandler [[onClientRender]].		This alternative function is meant to be used directly with the eventHandler [[onClientRender]].

	===Syntax===		===Syntax===
	<syntaxhighlight lang="lua">~~element~~ dxDraw3DText( string text, int x, int y, int z [, int scale = 2, string font = "default", int color = white, int maxDistance = 12, bool colorCoded = false ] )</syntaxhighlight>		<syntaxhighlight lang="lua">bool dxDraw3DText( string text, int x, int y, int z [, int scale = 2, string font = "default", int color = white, int maxDistance = 12, bool colorCoded = false ] )</syntaxhighlight>

	===Returns===		===Returns===
	The function displays a ''text'' if ~~successfule~~, ''false'' otherwise.		The function return ''true'' and displays a ''text'' if successful, ''false'' otherwise.

	===Required Arguments===		===Required Arguments===

Ceeser at 22:00, 26 October 2017

2017-10-26T22:00:30Z

← Older revision		Revision as of 22:00, 26 October 2017
Line 54:		Line 54:
	==Download==		==Download==
	You can download the resource, comment about it, rate it and report any bugs at the community page : [https://community.multitheftauto.com/index.php?p=resources&s=details&id=7613]		You can download the resource, comment about it, rate it and report any bugs at the community page : [https://community.multitheftauto.com/index.php?p=resources&s=details&id=7613]



Line 119:		Line 120:
	end		end
	</syntaxhighlight>		</syntaxhighlight>
			By: Ceeser
	</section>		</section>
	~~<br />'''Author:''' Ceeser~~

Ceeser: Added clientside code for onClientRender function

2017-10-26T21:55:33Z

Added clientside code for onClientRender function

@@ Line 1: / Line 1: @@
 {{Resource page}}
-This resource allowe you to draw 3D-DX texts any where in the game .
+This resource allowe you to draw 3D-DX texts any where in the game. You need to add a Text to display only once.
@@ Line 31: / Line 31: @@
 ===Example===
-This example will draw a 3D text neer a player when the resource starts, And destroys it after 5 seconds .
+This example will draw a 3D text near a player when the resource starts, And destroys it after 5 seconds .
 <syntaxhighlight lang="lua">local dxDraw3DText = exports.3D_DX_Texts:dxDraw3DText -- define the function
@@ Line 54: / Line 54: @@
 ==Download==
 You can download the resource, comment about it, rate it and report any bugs at the community page : [https://community.multitheftauto.com/index.php?p=resources&s=details&id=7613]

LordHenry: /* Example */

2016-12-02T13:42:06Z

Example

← Older revision		Revision as of 13:42, 2 December 2016
Line 31:		Line 31:
	===Example===		===Example===

	This example will draw a 3D text neer a player when the resource starts, And destroys it after 5 ~~secinds~~ .		This example will draw a 3D text neer a player when the resource starts, And destroys it after 5 seconds .

	<syntaxhighlight lang="lua">local dxDraw3DText = exports.3D_DX_Texts:dxDraw3DText -- define the function		<syntaxhighlight lang="lua">local dxDraw3DText = exports.3D_DX_Texts:dxDraw3DText -- define the function
Line 45:		Line 45:
	end		end
	)</syntaxhighlight>		)</syntaxhighlight>


	==Notes==		==Notes==

OpenIDUser52: Created page with "{{Resource page}} This resource allowe you to draw 3D-DX texts any where in the game . ==How it works== You only need to use the exported function from the resource '''dxDraw3..."

2013-07-22T14:05:34Z

Created page with "{{Resource page}} This resource allowe you to draw 3D-DX texts any where in the game . ==How it works== You only need to use the exported function from the resource '''dxDraw3..."

New page

{{Resource page}}

This resource allowe you to draw 3D-DX texts any where in the game .

==How it works==
You only need to use the exported function from the resource '''dxDraw3DText''' and draw the text . ( To use the exported function use [[call]] function ) .

==The dxDraw3DText function==

===Syntax===
<syntaxhighlight lang="lua">element dxDraw3DText( string text, int x, int y, int z [, int scale = 2, string font = "default", int r = 255, int g = 255, int b = 255, int maxDistance = 12 ] )</syntaxhighlight>

===Required Arguments===
*'''text :''' A [[string]] representing the text you wish to draw .
*'''x, y, z :''' Three integers representing the world coordinates of where you want the text to be .

===Optional Arguments===
*'''scale :''' An [[int]] representing the size of the font .
*'''font :''' A [[string]] representing the font type, This CAN'T be a [[DX font]] element, It can ONLY be :
{{DxFonts}}
*'''r, g, b :''' Three integers representing the RGB Color codes for the text .
*''' maxDistance :''' An [[int]] representing the max distance the text will show in .

===Returns===

The function returns a ''text element'' if successfule, ''false'' otherwise .

===Example===

This example will draw a 3D text neer a player when the resource starts, And destroys it after 5 secinds .

<syntaxhighlight lang="lua">local dxDraw3DText = exports.3D_DX_Texts:dxDraw3DText -- define the function

addEventHandler( "onClientResourceStart", getResourceRootElement( getThisResource( ) ),
function( )
local x, y, z = getElementPosition( getLocalPlayer( ) ) -- getting the player coordinates
local playerName = getPlayerName( getLocalPlayer( ) ) -- getting the player name
local theText = dxDraw3DText( "Welcome " .. playerName, x, y, z ) -- dtawing the text
if theText then -- if it was drawn
setTimer( destroyElement, 5000, 1, theText ) -- set a time to destroy it after 5 seconds
end
end
)</syntaxhighlight>

==Notes==
* The ''dxDraw3DText'' function is client side only .
* The ''dxDraw3DText'' function doesn't need the [[onClientRender]] event to work .
* The ''dxDraw3DText'' function only creates a ''text element'', The drawing and stuff is done in the resource, So it MUST be running so the texts show .

==Download==
You can download the resource, comment about it, rate it and report any bugs at the community page : [https://community.multitheftauto.com/index.php?p=resources&s=details&id=7613]