Resource:Custom billboards - Revision history

Fabervox: Undo revision 50133 by Marcin778 (talk)

2017-01-01T18:32:28Z

Undo revision 50133 by Marcin778 (talk)

Show changes

Marcin778 at 18:18, 1 January 2017

2017-01-01T18:18:41Z

Show changes

Renard712 at 21:21, 29 July 2015

2015-07-29T21:21:34Z

← Older revision		Revision as of 21:21, 29 July 2015
Line 160:		Line 160:
	[http://community.multitheftauto.com/index.php?p=resources&s=details&id=10156 Resource download link]		[http://community.multitheftauto.com/index.php?p=resources&s=details&id=10156 Resource download link]

	[~~http~~://www.~~solidfiles~~.com/d/~~07ea100174~~/custom_billboards_test.zip Test resource]		[https://www.dropbox.com/s/vvsvua1kmrpjxaz/custom_billboards_test.zip?dl=0 Test resource]

Renard712 at 00:35, 25 October 2014

2014-10-25T00:35:17Z

@@ Line 73: / Line 73: @@
 *'''element billboardElement:''' A previously declared billboard element.
 *'''float sizeX,sizeY:''' The width and height of the billboard.
 ===Returns===
 The function returns true if set successfully, false otherwise.
@@ Line 95: / Line 106: @@
 *'''int MaxEffectFade:''' Set the Max distance of the billboard to sync.(Must be greater than MinEffectFade).
 *'''int MinEffectFade:''' Set the distance on which the billboard starts to fade out.
 ===Returns===
 The function returns true if set successfully, false otherwise.

Renard712 at 21:04, 28 September 2014

2014-09-28T21:04:57Z

← Older revision		Revision as of 21:04, 28 September 2014
Line 1:		Line 1:
	{{Resource page}}		{{Resource page}}
	This resource lets You create billboards. ~~The billboard~~ is a quad that always faces the camera.		This resource lets You create billboards. Billboard is a quad that always faces the camera.
	In this case billboard Elements are created using dxDrawMaterialLine3d MTA function.		In this case billboard Elements are created using dxDrawMaterialLine3d MTA function.
	I have changed the behaviour of the material to act as cylindrical billboards do.		I have changed the behaviour of the material to act as cylindrical billboards do.
Line 15:		Line 15:
	<section name="Client" class="client" show="true">		<section name="Client" class="client" show="true">
	This function creates a shadered materialLine3d billboard.		This function creates a shadered materialLine3d billboard.
	<syntaxhighlight lang="lua">~~bool~~ exports.custom_billboards:createBillboard(float posX,posY,posZ,sizeX,sizeY,int colorR,colorG,colorB,colorA)</syntaxhighlight>		<syntaxhighlight lang="lua">billboardElement exports.custom_billboards:createBillboard(float posX,posY,posZ,sizeX,sizeY,int colorR,colorG,colorB,colorA)</syntaxhighlight>
	===Required Arguments===		===Required Arguments===
	*'''float posX, posY, posZ:''' Position in world space.		*'''float posX, posY, posZ:''' Position in world space.
Line 21:		Line 21:
	*'''int colorR,colorG,colorB,colorA:''' RGBA color (0 - 255).		*'''int colorR,colorG,colorB,colorA:''' RGBA color (0 - 255).
	===Returns===		===Returns===
	The function returns ~~true~~ if set successfully, false otherwise.		The function returns billboardElement if set successfully, false otherwise.
	</section>		</section>

Renard712 at 10:51, 27 September 2014

2014-09-27T10:51:45Z

← Older revision		Revision as of 10:51, 27 September 2014
Line 57:		Line 57:
	====setBillboardSize====		====setBillboardSize====
	<section name="Client" class="client" show="true">		<section name="Client" class="client" show="true">
	This function sets billboard ~~width and height~~.		This function sets billboard size.
	<syntaxhighlight lang="lua">bool exports.custom_billboards:setBillboardSize(element billboardElement,float size)</syntaxhighlight>		<syntaxhighlight lang="lua">bool exports.custom_billboards:setBillboardSize(element billboardElement,float size)</syntaxhighlight>
	===Required Arguments===		===Required Arguments===

Renard712 at 10:50, 27 September 2014

2014-09-27T10:50:51Z

← Older revision		Revision as of 10:50, 27 September 2014
Line 19:		Line 19:
	*'''float posX, posY, posZ:''' Position in world space.		*'''float posX, posY, posZ:''' Position in world space.
	*'''float sizeX, sizeY:''' Size of the billboard.		*'''float sizeX, sizeY:''' Size of the billboard.
	*'''int colorR,colorG,colorB,colorA:''' ~~Billboard~~ RGBA color ~~emitted by the billboard~~ (0 - 255).		*'''int colorR,colorG,colorB,colorA:''' RGBA color (0 - 255).
	===Returns===		===Returns===
	The function returns true if set successfully, false otherwise.		The function returns true if set successfully, false otherwise.
Line 83:		Line 83:
	===Required Arguments===		===Required Arguments===
	*'''element billboardElement:''' A previously declared billboard element.		*'''element billboardElement:''' A previously declared billboard element.
	*'''float colorR,colorG,colorB,colorA:''' ~~Billboard~~ RGBA color ~~emitted by the billboard~~ (0 - 255).		*'''float colorR,colorG,colorB,colorA:''' RGBA color (0 - 255).
	===Returns===		===Returns===
	The function returns true if set successfully, false otherwise.		The function returns true if set successfully, false otherwise.
Line 100:		Line 100:

	==Examples==		==Examples==
	<syntaxhighlight lang="lua">~~local corTable = {}~~		<syntaxhighlight lang="lua">local tex = dxCreateTexture("hello.jpg")
	local tex = dxCreateTexture("hello.jpg")
	function addStuff()		function addStuff()
	for i=1,30 do		for i=1,30 do
	for j=1,30 do		for j=1,30 do
	~~corTable[i] =~~ exports.custom_billboards:createBillboard(tex,i * 7,j * 7,10,4,4,math.random()255,math.random()255,math.random()255,1255)		exports.custom_billboards:createBillboard(tex,i * 7,j * 7,10,4,4,math.random()255,math.random()255,math.random()255,1255)
	end		end
	end		end

Renard712 at 23:54, 24 September 2014

2014-09-24T23:54:43Z

← Older revision		Revision as of 23:54, 24 September 2014
Line 105:		Line 105:
	for i=1,30 do		for i=1,30 do
	for j=1,30 do		for j=1,30 do
	corTable[i] = exports.custom_billboards:~~createbillboard~~(tex,i * 7,j * 7,10,4,4,math.random()255,math.random()255,math.random()255,1255)		corTable[i] = exports.custom_billboards:createBillboard(tex,i * 7,j * 7,10,4,4,math.random()255,math.random()255,math.random()255,1255)
	end		end
	end		end
Line 123:		Line 123:

	local tex = dxCreateTexture("hello.jpg")		local tex = dxCreateTexture("hello.jpg")
	local carLight = exports.custom_billboards:~~createbillboard~~(tex,0,0,0,4,4,math.random()255,math.random()255,math.random()255,1255)		local carLight = exports.custom_billboards:createBillboard(tex,0,0,0,4,4,math.random()255,math.random()255,math.random()255,1255)
	addEventHandler("onClientPreRender", root, function()		addEventHandler("onClientPreRender", root, function()
	if vehicle1 then		if vehicle1 then
	xxx1,yyy1,zzz1 = getElementPosition(vehicle1)		xxx1,yyy1,zzz1 = getElementPosition(vehicle1)
	exports.custom_billboards:~~setbillboardPosition~~(carLight,xxx1,yyy1,zzz1)		exports.custom_billboards:setBillboardPosition(carLight,xxx1,yyy1,zzz1)
	end		end
	end		end
Line 139:		Line 139:

	[http://community.multitheftauto.com/index.php?p=resources&s=details&id=10156 Resource download link]		[http://community.multitheftauto.com/index.php?p=resources&s=details&id=10156 Resource download link]

	[http://www.solidfiles.com/d/07ea100174/custom_billboards_test.zip Test resource]		[http://www.solidfiles.com/d/07ea100174/custom_billboards_test.zip Test resource]

Renard712: Created page with "{{Resource page}} This resource lets You create billboards. The billboard is a quad that always faces the camera. In this case billboard Elements are created using dxDrawMater..."

2014-09-24T23:52:43Z

Created page with "{{Resource page}} This resource lets You create billboards. The billboard is a quad that always faces the camera. In this case billboard Elements are created using dxDrawMater..."

New page

{{Resource page}}
This resource lets You create billboards. The billboard is a quad that always faces the camera.
In this case billboard Elements are created using dxDrawMaterialLine3d MTA function.
I have changed the behaviour of the material to act as cylindrical billboards do.
There are many possibilities to use this resource. But that's all up to you.

== Overview ==

It is easy to use, gives a few options to manage billboards.

The resource itself adds exported clientside functions:

==Exported functions==
====createBillboard====
<section name="Client" class="client" show="true">
This function creates a shadered materialLine3d billboard.
<syntaxhighlight lang="lua">bool exports.custom_billboards:createBillboard(float posX,posY,posZ,sizeX,sizeY,int colorR,colorG,colorB,colorA)</syntaxhighlight>
===Required Arguments===
*'''float posX, posY, posZ:''' Position in world space.
*'''float sizeX, sizeY:''' Size of the billboard.
*'''int colorR,colorG,colorB,colorA:''' Billboard RGBA color emitted by the billboard (0 - 255).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====destroyBillboard====
<section name="Client" class="client" show="true">
This function destroys a shadered materialLine3d billboard element.
<syntaxhighlight lang="lua">bool exports.custom_billboards:destroyBillboard(element billboardElement)</syntaxhighlight>
===Required Arguments===
*'''element billboardElement:''' A previously declared billboard element.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setBillboardMaterial====
<section name="Client" class="client" show="true">
This function sets the billboard material (ex. texture).
<syntaxhighlight lang="lua">bool exports.custom_billboards:setBillboardMaterial(element billboardElement)</syntaxhighlight>
===Required Arguments===
*'''element billboardElement:''' A previously declared billboard element.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setBillboardPosition====
<section name="Client" class="client" show="true">
This function sets billboard position.
<syntaxhighlight lang="lua">bool exports.custom_billboards:setbillboardPosition(element billboardElement,float posX,posY,posZ)</syntaxhighlight>
===Required Arguments===
*'''element billboardElement:''' A previously declared billboard element.
*'''float posX, posY, posZ:''' Position in world space.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setBillboardSize====
<section name="Client" class="client" show="true">
This function sets billboard width and height.
<syntaxhighlight lang="lua">bool exports.custom_billboards:setBillboardSize(element billboardElement,float size)</syntaxhighlight>
===Required Arguments===
*'''element billboardElement:''' A previously declared billboard element.
*'''float size:''' Size of the billboard.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setBillboardSizeXY====
<section name="Client" class="client" show="true">
This function sets billboard width and height.
<syntaxhighlight lang="lua">bool exports.custom_billboards:setBillboardSizeXY(element billboardElement,float sizeX,sizeY)</syntaxhighlight>
===Required Arguments===
*'''element billboardElement:''' A previously declared billboard element.
*'''float sizeX,sizeY:''' The width and height of the billboard.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setBillboardColor====
<section name="Client" class="client" show="true">
This function sets light color values.
<syntaxhighlight lang="lua">bool exports.custom_billboards:setbillboardColor(element billboardElement,float colorR,colorG,colorB,colorA)</syntaxhighlight>
===Required Arguments===
*'''element billboardElement:''' A previously declared billboard element.
*'''float colorR,colorG,colorB,colorA:''' Billboard RGBA color emitted by the billboard (0 - 255).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setBillboardsDistFade====
<section name="Client" class="client" show="true">
Set the Max distance of the billboard to sync and the distance on which the it starts to fade out.
<syntaxhighlight lang="lua">bool exports.custom_billboards:setBillboardsDistFade(int MaxEffectFade,int MinEffectFade)</syntaxhighlight>
===Required Arguments===
*'''int MaxEffectFade:''' Set the Max distance of the billboard to sync.(Must be greater than MinEffectFade).
*'''int MinEffectFade:''' Set the distance on which the billboard starts to fade out.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

==Examples==
<syntaxhighlight lang="lua">local corTable = {}
local tex = dxCreateTexture("hello.jpg")
function addStuff()
for i=1,30 do
for j=1,30 do
corTable[i] = exports.custom_billboards:createbillboard(tex,i * 7,j * 7,10,4,4,math.random()*255,math.random()*255,math.random()*255,1*255)
end
end
end

addEventHandler("onClientResourceStart", getResourceRootElement( getThisResource()), addStuff)</syntaxhighlight>
This creates 400 lovely billboards near position (0,0,0)

<syntaxhighlight lang="lua">local vehicle1 = nil
addEventHandler("onClientVehicleEnter", getRootElement(),
function(thePlayer, seat)
if thePlayer == getLocalPlayer() then
vehicle1 = source
end
end
)

local tex = dxCreateTexture("hello.jpg")
local carLight = exports.custom_billboards:createbillboard(tex,0,0,0,4,4,math.random()*255,math.random()*255,math.random()*255,1*255)
addEventHandler("onClientPreRender", root, function()
if vehicle1 then
xxx1,yyy1,zzz1 = getElementPosition(vehicle1)
exports.custom_billboards:setbillboardPosition(carLight,xxx1,yyy1,zzz1)
end
end
) </syntaxhighlight>
This creates a billboard and attaches it to a vehicle that the player enters.

Of course when you want to use these functions in your resources you have to include
the custom_billboards resource in meta.

==See Also==

[http://community.multitheftauto.com/index.php?p=resources&s=details&id=10156 Resource download link]
[http://www.solidfiles.com/d/07ea100174/custom_billboards_test.zip Test resource]