Multi Theft Auto: Wiki - User contributions [en]

Resource:Object preview

2015-08-22T22:57:53Z

Renard712:

{{Resource page}}
This resource lets you create an object that will be drawn on the screen
provided size and position - just like when drawing an image. This way it is easy to
create object preview on GUI (supports drawing in a separate render target).
Works with peds, world objects and vehicles.

== Overview ==

The resource itself adds exported client-side functions:

==Exported functions==
====createObjectPreview====
<section name="Client" class="client" show="true">
Creates the preview for provided world,ped or vehicle element.
<syntaxhighlight lang="lua">bool exports.object_preview:createObjectPreview(element object, float rotX rotY, rotZ, projPosX, projPosY, projSizeX, projSizeY [, bool isRelative = false, postGUI = false, isSecRT = true])</syntaxhighlight>
===Required Arguments===
*'''float rotX, rotY, rotZ:''' Object rotation in camera space.
*'''float projPosX, projPosY:''' Projector left corner on the screen.
*'''float projSizeX, projSizeY:''' Projector size.
===Optional Arguments===
*'''bool isRelative:''' Are the projector parameters relative.
*'''bool postGUI:''' Should the object be drawn before or after MTA GUI elements.
*'''isSecRT:''' Should the object be drawin to second render target.
===Returns===
The function returns the element if set successfully, 'false' otherwise.
</section>

====destroyObjectPreview====
<section name="Client" class="client" show="true">
Destroys previously created preview - without destroying the object it was applied to.
<syntaxhighlight lang="lua">bool exports.object_preview:destroyObjectPreview(element objectPreviewElement)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====saveRTToFile====
<section name="Client" class="client" show="true">
Save render target to png file. (Only when drawing to second render target is enabled)
<syntaxhighlight lang="lua">bool exports.object_preview:saveRTToFile(element objectPreviewElement, string path)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''string path:''' An exact client resource path the file is to be saved to.
===Returns===
The function returns true if set successfully, false otherwise. It saves the image in client resource path.
</section>

====setRotation====
<section name="Client" class="client" show="true">
This function sets object rotation.
<syntaxhighlight lang="lua">bool exports.object_preview:setRotation(element objectPreviewElement,float rotX, rotX, rotZ)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float rotX, rotX, rotZ:''' Object rotation in camera space.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setProjection====
<section name="Client" class="client" show="true">
This function sets object on screen position and size.
<syntaxhighlight lang="lua">bool exports.object_preview:setProjection(element objectPreviewElement, float projPosY, projSizeX, projSizeY [, bool isRelative = false])</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float projPosX, projPosY:''' Projector left corner on the screen.
*'''float projSizeX, projSizeY:''' Projector size.
===Optional Arguments===
*'''bool isRelative:''' Are the projector parameters relative.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setAlpha====
<section name="Client" class="client" show="true">
This function sets object alpha transparency.
<syntaxhighlight lang="lua">bool exports.object_preview:setAlpha(element objectPreviewElement,int alpha)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''int alpha:''' Object alpha (0 - 255).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====getRenderTarget====
<section name="Client" class="client" show="true">
This function returns a renderTarget (Only when drawing to second render target is enabled)
<syntaxhighlight lang="lua">bool exports.object_preview:getRenderTarget()</syntaxhighlight>
===Returns===
The function returns render target if set successfully, false otherwise.
</section>

====setDistanceSpread====
<section name="Client" class="client" show="true">
This function sets the difference between object to camera distance set by MTA and that set by shader.
<syntaxhighlight lang="lua">bool exports.object_preview:setDistanceSpread(element objectPreviewElement,float zSpread)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float zSpread:''' Object Distance spread.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setPositionOffsets====
<section name="Client" class="client" show="true">
This function sets object position to camera offsets (standard is 0,0,0)
<syntaxhighlight lang="lua">bool exports.object_preview:setPositionOffsets(element objectPreviewElement,float posX, posX, posX)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float posX, posX, posX:''' Object position to camera offsets.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setRotationOffsets====
<section name="Client" class="client" show="true">
This function sets object rotation centre offsets (standard is 0,0,0)
<syntaxhighlight lang="lua">bool exports.object_preview:setRotationOffsets(element objectPreviewElement,float posX, posX, posX)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float posX, posX, posX:''' Object rotation centre offsets.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

==Example==
<syntaxhighlight lang="lua">local scx, scy = guiGetScreenSize ()
local myObject,myElement, guiWindow = nil, nil, nil
local myRotation = {0,0,0}

addEventHandler("onClientResourceStart", getResourceRootElement( getThisResource()), function()
local x1, y1, z1 = getCameraMatrix()
myElement = createVehicle (429, x1, y1, z1)

myObject = exports.objectPreview:createObjectPreview(myElement,0, 0, 0, 0.5, 0.5, 1, 1, true, true, true)
guiWindow = guiCreateWindow((scx/2)-100,(scy/2) - 100,200,200, "Test area", false, false)
guiSetAlpha(guiWindow, 0.05 + 0.2)
local projPosX, projPosY = guiGetPosition(guiWindow,true)
local projSizeX, projSizeY = guiGetSize(guiWindow, true)
exports.object_preview:setProjection(myObject,projPosX, projPosY, projSizeX, projSizeY,true,true)
exports.object_preview:setRotation(myObject,myRotation[1], myRotation[2], myRotation[3])

bindKey ( "num_4", "down", function() myRotation[1] = myRotation[1] - 5 end)
bindKey ( "num_6", "down", function() myRotation[1] = myRotation[1] + 5 end)
bindKey ( "num_add", "down", function() myRotation[2] = myRotation[2] - 5 end)
bindKey ( "num_sub", "down", function() myRotation[2] = myRotation[2] + 5 end)
bindKey ( "num_2", "down", function() myRotation[3] = myRotation[3] - 5 end)
bindKey ( "num_8", "down", function() myRotation[3] = myRotation[3] + 5 end)
bindKey ( "o", "down", function() exports.object_preview:saveRTToFile(myObject,math.random(100)..".png") end)
end)

addEventHandler("onClientPreRender", root, function()
if not myElement or not myObject then return end
local projPosX, projPosY = guiGetPosition(guiWindow,true)
local projSizeX, projSizeY = guiGetSize(guiWindow, true)
exports.object_preview:setProjection(myObject,projPosX, projPosY, projSizeX, projSizeY, true, true)
end, true, "high" )

addEventHandler("onClientResourceStop", getResourceRootElement( getThisResource()), function()
exports.object_preview:destroyObjectPreview(myObject)
end
)
</syntaxhighlight>
This creates a vehicle, applies object preview and scales it using dimensions of a window element.

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

==See Also==

[https://community.multitheftauto.com/index.php?p=resources&s=details&id=11836 Object Preview resource on community]

Resource:Object preview

2015-07-30T10:54:29Z

Renard712:

{{Resource page}}
This resource lets you create an object that will be drawn on the screen
provided size and position - just like when drawing an image. This way it is easy to
create object preview on GUI (supports drawing in a separate render target).
Works with peds, world objects and vehicles.

== Overview ==

The resource itself adds exported client-side functions:

==Exported functions==
====createObjectPreview====
<section name="Client" class="client" show="true">
Creates the preview for provided world,ped or vehicle element.
<syntaxhighlight lang="lua">bool exports.object_preview:createObjectPreview(element object, float rotX rotY, rotZ, projPosX, projPosY, projSizeX, projSizeY [, bool isRelative = false, postGUI = false, isSecRT = true])</syntaxhighlight>
===Required Arguments===
*'''float rotX, rotY, rotZ:''' Object rotation in camera space.
*'''float projPosX, projPosY:''' Projector left corner on the screen.
*'''float projSizeX, projSizeY:''' Projector size.
===Optional Arguments===
*'''bool isRelative:''' Are the projector parameters relative.
*'''bool postGUI:''' Should the object be drawn before or after MTA GUI elements.
*'''isSecRT:''' Should the object be drawin to second render target.
===Returns===
The function returns the element if set successfully, 'false' otherwise.
</section>

====destroyObjectPreview====
<section name="Client" class="client" show="true">
Destroys previously created preview - without destroying the object it was applied to.
<syntaxhighlight lang="lua">bool exports.object_preview:destroyObjectPreview(element objectPreviewElement)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====saveRTToFile====
<section name="Client" class="client" show="true">
Save render target to png file. (Only when drawing to second render target is enabled)
<syntaxhighlight lang="lua">bool exports.object_preview:saveRTToFile(element objectPreviewElement, string path)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''string path:''' An exact client resource path the file is to be saved to.
===Returns===
The function returns true if set successfully, false otherwise. It saves the image in client resource path.
</section>

====setRotation====
<section name="Client" class="client" show="true">
This function sets object rotation.
<syntaxhighlight lang="lua">bool exports.object_preview:setRotation(element objectPreviewElement,float rotX, rotX, rotZ)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float rotX, rotX, rotZ:''' Object rotation in camera space.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setProjection====
<section name="Client" class="client" show="true">
This function sets object on screen position and size.
<syntaxhighlight lang="lua">bool exports.object_preview:setProjection(element objectPreviewElement, float projPosY, projSizeX, projSizeY [, bool isRelative = false])</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float projPosX, projPosY:''' Projector left corner on the screen.
*'''float projSizeX, projSizeY:''' Projector size.
===Optional Arguments===
*'''bool isRelative:''' Are the projector parameters relative.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setAlpha====
<section name="Client" class="client" show="true">
This function sets object alpha transparency.
<syntaxhighlight lang="lua">bool exports.object_preview:setAlpha(element objectPreviewElement,int alpha)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''int alpha:''' Object alpha (0 - 255).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====getRenderTarget====
<section name="Client" class="client" show="true">
This function returns a renderTarget (Only when drawing to second render target is enabled)
<syntaxhighlight lang="lua">bool exports.object_preview:getRenderTarget(element objectPreviewElement)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
===Returns===
The function returns render target if set successfully, false otherwise.
</section>

====setDistanceSpread====
<section name="Client" class="client" show="true">
This function sets the difference between object to camera distance set by MTA and that set by shader.
<syntaxhighlight lang="lua">bool exports.object_preview:setDistanceSpread(element objectPreviewElement,float zSpread)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float zSpread:''' Object Distance spread.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setPositionOffsets====
<section name="Client" class="client" show="true">
This function sets object position to camera offsets (standard is 0,0,0)
<syntaxhighlight lang="lua">bool exports.object_preview:setPositionOffsets(element objectPreviewElement,float posX, posX, posX)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float posX, posX, posX:''' Object position to camera offsets.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setRotationOffsets====
<section name="Client" class="client" show="true">
This function sets object rotation centre offsets (standard is 0,0,0)
<syntaxhighlight lang="lua">bool exports.object_preview:setRotationOffsets(element objectPreviewElement,float posX, posX, posX)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float posX, posX, posX:''' Object rotation centre offsets.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

==Example==
<syntaxhighlight lang="lua">local scx, scy = guiGetScreenSize ()
local myObject,myElement, guiWindow = nil, nil, nil
local myRotation = {0,0,0}

addEventHandler("onClientResourceStart", getResourceRootElement( getThisResource()), function()
local x1, y1, z1 = getCameraMatrix()
myElement = createVehicle (429, x1, y1, z1)

myObject = exports.objectPreview:createObjectPreview(myElement,0, 0, 0, 0.5, 0.5, 1, 1, true, true, true)
guiWindow = guiCreateWindow((scx/2)-100,(scy/2) - 100,200,200, "Test area", false, false)
guiSetAlpha(guiWindow, 0.05 + 0.2)
local projPosX, projPosY = guiGetPosition(guiWindow,true)
local projSizeX, projSizeY = guiGetSize(guiWindow, true)
exports.object_preview:setProjection(myObject,projPosX, projPosY, projSizeX, projSizeY,true,true)
exports.object_preview:setRotation(myObject,myRotation[1], myRotation[2], myRotation[3])

bindKey ( "num_4", "down", function() myRotation[1] = myRotation[1] - 5 end)
bindKey ( "num_6", "down", function() myRotation[1] = myRotation[1] + 5 end)
bindKey ( "num_add", "down", function() myRotation[2] = myRotation[2] - 5 end)
bindKey ( "num_sub", "down", function() myRotation[2] = myRotation[2] + 5 end)
bindKey ( "num_2", "down", function() myRotation[3] = myRotation[3] - 5 end)
bindKey ( "num_8", "down", function() myRotation[3] = myRotation[3] + 5 end)
bindKey ( "o", "down", function() exports.object_preview:saveRTToFile(myObject,math.random(100)..".png") end)
end)

addEventHandler("onClientPreRender", root, function()
if not myElement or not myObject then return end
local projPosX, projPosY = guiGetPosition(guiWindow,true)
local projSizeX, projSizeY = guiGetSize(guiWindow, true)
exports.object_preview:setProjection(myObject,projPosX, projPosY, projSizeX, projSizeY, true, true)
end, true, "high" )

addEventHandler("onClientResourceStop", getResourceRootElement( getThisResource()), function()
exports.object_preview:destroyObjectPreview(myObject)
end
)
</syntaxhighlight>
This creates a vehicle, applies object preview and scales it using dimensions of a window element.

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

==See Also==

[https://community.multitheftauto.com/index.php?p=resources&s=details&id=11836 Object Preview resource on community]

Resource:Custom billboards

2015-07-29T21:21:34Z

Renard712:

{{Resource page}}
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.
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">billboardElement 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:''' RGBA color (0 - 255).
===Returns===
The function returns billboardElement 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 size.
<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>

====setBillboardDepthBias====
<section name="Client" class="client" show="true">
On createBillboard the depthBias is set properly (0-1). You can however set other value depending on your needs. To see the results you'll need to set enableDepthBiasScale to true.
<syntaxhighlight lang="lua">bool exports.custom_billboards:setBillboardDepthBias(element billboardElement,float depthBiasValue)</syntaxhighlight>
===Required Arguments===
*'''element billboardElement:''' A previously declared billboard element.
*'''float depthBiasValue:''' depthBias value.
===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:''' RGBA color (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>

====enableDepthBiasScale====
<section name="Client" class="client" show="true">
Standard depthBias for GTASA coronas is about 1 unit, despite the corona scale. This function elables depthBias scaling.
<syntaxhighlight lang="lua">bool exports.custom_billboards:enableDepthBiasScale(bool isDepthScaleEnabled)</syntaxhighlight>
===Required Arguments===
*'''bool isDepthScaleEnabled:''' Enable/disable depthBias scaling.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

==Examples==
<syntaxhighlight lang="lua">local tex = dxCreateTexture("hello.jpg")
function addStuff()
for i=1,30 do
for j=1,30 do
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]

[https://www.dropbox.com/s/vvsvua1kmrpjxaz/custom_billboards_test.zip?dl=0 Test resource]

Resource:Dynamic lighting

2015-07-29T21:19:06Z

Renard712:

{{Resource page}}
This resource lets You create dynamic lights in MTA. It gives you a list of exported functions that You can use to create per pixel pointlights and spotlights. It should be considered a preview of what [https://wiki.multitheftauto.com/wiki/MTA:Eir MTA:Eir] will offer. The future solution should be more FPS friendly. Yet i see that resource as an example of what the future holds.

== Overview ==

It is easy to use, gives a few options to create per pixel lights in gtasa.

The resource itself adds exported clientside functions:

==Exported functions==
====createPointLight====
<section name="Client" class="client" show="true">
This function creates a pixel shader pointlight.
<syntaxhighlight lang="lua">lightElement exports.dynamic_lighting:createPointLight(float posX,posY,posZ,colorR,colorG,colorB,colorA,attenuation,[bool normalShadow = true])</syntaxhighlight>
===Required Arguments===
*'''float posX, posY, posZ:''' Light position in world.
*'''float colorR,colorG,colorB,colorA:''' RGBA color emitted by the light (0 - 1 instead of 0-255).
*'''float attenuation:''' Value specifying how the light intensity changes over distance.
===Optional Arguments===
*'''bool normalShadow:''' Determine if the light source should be obscured when lighting a surface on opposite angles.
===Returns===
The function returns lightElement if set successfully, false otherwise.
</section>
====createSpotLight====
<section name="Client" class="client" show="true">
This function creates a pixel shader spotlight.
<syntaxhighlight lang="lua">lightElement exports.dynamic_lighting:createSpotLight(float posX,posY,posZ,colorR,colorG,colorB,colorA,dirX,dirY,dirZ, bool isEuler,float falloff,theta,phi,attenuation,[bool normalShadowing = true])</syntaxhighlight>
===Required Arguments===
*'''float posX, posY, posZ:''' Light position in world space.
*'''float colorR,colorG,colorB,colorA:''' RGBA color emitted by the light (0 - 1 instead of 0-255).
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
*'''bool isEuler:''' Is the angle set as an "ZXY" euler andgle or a vector.
*'''float falloff:''' Decrease in illumination between a spotlight's inner cone (the angle specified by Theta) and the outer edge of the outer cone (the angle specified by Phi).
*'''float theta: (radians)''' Angle, in radians, of a spotlight's inner cone - that is, the fully illuminated spotlight cone. This value must be in the range from 0 through the value specified by Phi.
*'''float phi: (radians)''' Angle, in radians, defining the outer edge of the spotlight's outer cone. Points outside this cone are not lit by the spotlight. This value must be between 0 and pi.
*'''float attenuation:''' Value specifying how the light intensity changes over distance.
===Optional Arguments===
*'''bool normalShadow:''' Determine if the light source should be obscured when lighting a surface on opposite angles.
===Returns===
The function returns lightElement if set successfully, false otherwise.
</section>

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

====setLightDirection====
<section name="Client" class="client" show="true">
This function setd light direction values for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightDirection(element lightElement,float dirX,dirY,dirZ,[bool isEuler = false])</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
===Optional Arguments===
*'''bool isEuler:'''Is the angle set as an "ZXY" euler andgle or a vector.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightPosition====
<section name="Client" class="client" show="true">
This function sets light position values for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightPosition(element lightElement,float posX,posY,posZ)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float posX, posY, posZ:''' Light position in world space.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightColor====
<section name="Client" class="client" show="true">
This function sets light color values for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightColor(element lightElement,float colorR,colorG,colorB,colorA)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float colorR,colorG,colorB,colorA:''' RGBA color emitted by the light (0 - 1 instead of 0-255).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightAttenuation====
<section name="Client" class="client" show="true">
This function sets setLightAttenuation value for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightAttenuation(element lightElement,float attenuation)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float attenuation:''' Value specifying how the light intensity changes over distance.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightFalloff====
<section name="Client" class="client" show="true">
This function sets falloff value for a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightFalloff(element lightElement,float falloff)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float falloff (radians):''' Decrease in illumination between a spotlight's inner cone (the angle specified by Theta) and the outer edge of the outer cone (the angle specified by Phi).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightTheta====
<section name="Client" class="client" show="true">
This function sets theta value for a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightTheta(element lightElement,float theta)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float theta (radians):''' Angle, in radians, of a spotlight's inner cone - that is, the fully illuminated spotlight cone. This value must be in the range from 0 through the value specified by Phi.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightPhi====
<section name="Client" class="client" show="true">
This function sets phi value for a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightPhi(element lightElement,float phi)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float phi (radians):''' Angle, in radians, defining the outer edge of the spotlight's outer cone. Points outside this cone are not lit by the spotlight. This value must be between 0 and pi.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightNormalShadowing====
<section name="Client" class="client" show="true">
Determine if the light source should be obscured when lighting a surface on opposite angles.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightNormalShadowing(element lightElement,bool normalShadow)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''bool normalShadow:''' Determine if the light source should be obscured when lighting a surface on opposite angles.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShadersLayered====
<section name="Client" class="client" show="true">
Should the main shader effects be created in a separate render pass ? As default only the vehicle effect is layered.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShadersLayered(bool isWorld, isVeh, isPed)</syntaxhighlight>
===Required Arguments===
*'''bool isWorld, isVeh, isPed:''' Should the shader effects be created in a separate render pass.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setGenerateBumpNormals====
<section name="Client" class="client" show="true">
Should the shader effect generate bump normals from texture0. Doesn't work when normal shadowing is set to false.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setGenerateBumpNormals(bool isTrue,[int textureSize = 512, float normalStrength.x = 1, float normalStrength.y = 1, float normalStrength.z = 1])</syntaxhighlight>
===Required Arguments===
*'''bool isTrue:''' Turn on or off bump mapping.
===Optional Arguments===
*'''int textureSize:''' The size of the input texture.
*'''float normalStrength.xyz:''' How bumpy should the surface be ?
===Returns===
The function returns true if set successfully, false otherwise.
</section>

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

====setLightsEffectRange====
<section name="Client" class="client" show="true">
Set the Max distance from the camera the shader effects are applied to.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightsEffectRange(int maxEffectRange)</syntaxhighlight>
===Required Arguments===
*'''int maxEffectRange:''' If non-zero, the shaders will be applied to textures nearer than maxDistance only.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderForcedOn====
<section name="Client" class="client" show="true">
Should the shader effect turn off when no lightsources.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderForcedOn(bool isShaderForcedOn)</syntaxhighlight>
===Required Arguments===
*'''bool isShaderForcedOn:''' Should the shader effect turn off when no lightsources.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderTimeOut====
<section name="Client" class="client" show="true">
Should the shader effect turn off after number of seconds (when no lightsources)
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderTimeOut(int timeOut)</syntaxhighlight>
===Required Arguments===
*'''int timeOut:''' Should the shader effect turn off after number of seconds (when no lightsources)
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderNightMod====
<section name="Client" class="client" show="true">
Enable nightMod effect - requires proper manipulation of setTextureBrightness and SetShaderDayTime, also some additional shaders.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderNightMod(bool enable)</syntaxhighlight>
===Required Arguments===
*'''bool enable:''' Enable or disable nightMod effect
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderDayTime====
<section name="Client" class="client" show="true">
Another additional variable to control texture colors - requires setShaderNightMod(true)
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderDayTime(float dayTime)</syntaxhighlight>
===Required Arguments===
*'''float dayTime:''' Another additional variable to control texture colors - requires setShaderNightMod(true) set 1 as default
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderPedDiffuse====
<section name="Client" class="client" show="true">
Enable or disable gta directional lights for ped.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderPedDiffuse(bool enable)</syntaxhighlight>
===Required Arguments===
*'''bool enable:''' Enable or disable gta directional lights for ped (enabled as default)
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setDirLightEnable====
<section name="Client" class="client" show="true">
This function creates a vertex shader directional light. NOTE: Forcing the effects on or using any other lights is required for directional light to work.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setDirLightEnable(bool enable = false)</syntaxhighlight>
===Required Arguments===
*'''bool enable:''' Enable or disable the directional light.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setDirLightDirection====
<section name="Client" class="client" show="true">
This function sets the directional light direction.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setDirLightDirection(float dirX,dirY,dirZ,[bool isEuler = false])</syntaxhighlight>
===Required Arguments===
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
===Optional Arguments===
*'''bool isEuler:'''Is the angle set as an "ZXY" euler andgle or a vector.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setDirLightColor====
<section name="Client" class="client" show="true">
This function sets the directional light color value.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setDirLightColor(float colorR,colorG,colorB,colorA)</syntaxhighlight>
===Required Arguments===
*'''float colorR,colorG,colorB,colorA:''' RGBA color emitted by the light (0 - 1 instead of 0-255).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

==Examples==
<syntaxhighlight lang="lua">exports.dynamic_lighting:createPointLight(0,0,5,1,0,0,1,15)</syntaxhighlight>
This creates a red pointlight in world position (0,0,5)

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

==See Also==
[http://community.multitheftauto.com/index.php?p=resources&s=details&id=9398 Dynamic Lighting resource on MTA Community]

[http://msdn.microsoft.com/en-us/library/windows/desktop/bb174697%28v=vs.85%29.aspx Light Types (Direct3D 9)]

[http://www.youtube.com/watch?v=2t_bje_XjUY Vehicle lights video]

Resource:Blur box

2015-07-29T21:15:21Z

Renard712:

{{Resource page}}
This resource lets You create simple gaussian blur boxes onClientRender.
Using that - You can make your game GUI a bit more fancy.

== Overview ==

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

The resource itself adds exported clientside functions:

==Exported functions==
====createBlurBox====
<section name="Client" class="client" show="true">
This function creates a blur box.
<syntaxhighlight lang="lua">bool exports.blur_box:createBlurBox(float posX,posY,sizeX,sizeY,int colorR,colorG,colorB,colorA,postGUI)</syntaxhighlight>
===Required Arguments===
*'''float posX, posY:''' Position in screen space.
*'''float sizeX, sizeY:''' Size of the box.
*'''int colorR,colorG,colorB,colorA:''' RGBA color (0 - 255).
*'''bool postGUI:''' Should the box be drawn before or after MTA GUI elements.
===Returns===
The function returns the element if set successfully, 'false' otherwise.
</section>

====destroyBlurBox====
<section name="Client" class="client" show="true">
This function destroys a blur box element.
<syntaxhighlight lang="lua">bool exports.blur_box:destroyBlurBox(element blurBoxElement)</syntaxhighlight>
===Required Arguments===
*'''element blurBoxElement:''' A previously declared blur box element.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setBlurBoxEnabled====
<section name="Client" class="client" show="true">
This function enables or disables a created blur box element.
<syntaxhighlight lang="lua">bool exports.blur_box:setBlurBoxEnabled(element blurBoxElement, bool isEnabled)</syntaxhighlight>
===Required Arguments===
*'''element blurBoxElement:''' A previously declared blur box element.
*'''bool isEnabled:''' Enable/Disable the blur box element.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setBlurBoxPosition====
<section name="Client" class="client" show="true">
This function sets blur box position.
<syntaxhighlight lang="lua">bool exports.blur_box:setBlurBoxPosition(element blurBoxElement,float posX,posY)</syntaxhighlight>
===Required Arguments===
*'''element blurBoxElement:''' A previously declared blur box element.
*'''float posX, posY:''' Position in screen space.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

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

====setBlurBoxColor====
<section name="Client" class="client" show="true">
This function sets blur box color values.
<syntaxhighlight lang="lua">bool exports.blur_box:setBlurBoxColor(element blurBoxElement,float colorR,colorG,colorB,colorA)</syntaxhighlight>
===Required Arguments===
*'''element blurBoxElement:''' A previously declared blur box element.
*'''float colorR,colorG,colorB,colorA:''' RGBA color (0 - 255).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setBlurIntensity====
<section name="Client" class="client" show="true">
This function sets blur amount for all the blur boxes
<syntaxhighlight lang="lua">bool exports.blur_box:setBlurIntensity(float blurFactor)</syntaxhighlight>
===Required Arguments===
*'''float blurFactor:''' Set blur amount for all the blur boxes. (default 0.6)
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setScreenResolutionMultiplier====
<section name="Client" class="client" show="true">
This function sets screen relative resolution multiplier for the screenSource
<syntaxhighlight lang="lua">bool exports.blur_box:setScreenResolutionMultiplier(element blurBoxElement, float x,y)</syntaxhighlight>
===Required Arguments===
*'''element blurBoxElement:''' A previously declared blurBox element.
*'''float x,y:''' Set sampled screen relative resolution multiplier (0-1)
===Returns===
The function returns true if set successfully, false otherwise.
</section>

==Examples==
<syntaxhighlight lang="lua">local scx, scy = guiGetScreenSize()
local guiWindowElement = nil
local blurBoxElement = nil

addEventHandler( "onClientPreRender", root,
function()
if guiWindowElement and blurBoxElement then
local xPos, yPos = guiGetPosition ( guiWindowElement , false )
local xSize, ySize = guiGetSize ( guiWindowElement , false )
exports.blur_box:setBlurBoxPosition( blurBoxElement, xPos, yPos )
exports.blur_box:setBlurBoxSize( blurBoxElement, xSize, ySize )
end
end
,true ,"high-3" )

addEventHandler( "onClientResourceStart", getResourceRootElement( getThisResource()),
function()
guiWindowElement = guiCreateWindow ( scx/2-scy/4, scy/2 - scy/4, scy/2, scy/2, "BlurBox test", false )
guiWindowSetMovable ( guiWindowElement, true )
guiWindowSetSizable ( guiWindowElement, true )
guiSetAlpha ( guiWindowElement, 0.3 )
blurBoxElement = exports.blur_box:createBlurBox( scx/2-scy/4, scy/2 - scy/4, scy/2, scy/2, 255, 255, 255, 255, false )
--exports.blur_box:setBlurBoxColor( blurBoxElement, 255, 100, 100, 255)
exports.blur_box:setScreenResolutionMultiplier( 0.5, 0.5 )
end
)

addEventHandler( "onClientResourceStop", getResourceRootElement( getThisResource()),
function()
destroyElement( guiWindowElement )
blurBoxElement = not exports.blur_box:destroyBlurBox( blurBoxElement )
end
)
</syntaxhighlight>
This creates a blur box and attaches it to a created window element.

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

==See Also==

[http://community.multitheftauto.com/index.php?p=resources&s=details&id=10163 Community resource]

[https://www.dropbox.com/s/db13n4l62k21x19/blurBox_test.zip?dl=0 Test resource]

Resource:Blur box

2015-07-29T21:14:14Z

Renard712:

{{Resource page}}
This resource lets You create simple gaussian blur boxes onClientRender.
Using that - You can make your game GUI a bit more fancy.

== Overview ==

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

The resource itself adds exported clientside functions:

==Exported functions==
====createBlurBox====
<section name="Client" class="client" show="true">
This function creates a blur box.
<syntaxhighlight lang="lua">bool exports.blur_box:createBlurBox(float posX,posY,sizeX,sizeY,int colorR,colorG,colorB,colorA,postGUI)</syntaxhighlight>
===Required Arguments===
*'''float posX, posY:''' Position in screen space.
*'''float sizeX, sizeY:''' Size of the box.
*'''int colorR,colorG,colorB,colorA:''' RGBA color (0 - 255).
*'''bool postGUI:''' Should the box be drawn before or after MTA GUI elements.
===Returns===
The function returns the element if set successfully, 'false' otherwise.
</section>

====destroyBlurBox====
<section name="Client" class="client" show="true">
This function destroys a blur box element.
<syntaxhighlight lang="lua">bool exports.blur_box:destroyBlurBox(element blurBoxElement)</syntaxhighlight>
===Required Arguments===
*'''element blurBoxElement:''' A previously declared blur box element.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setBlurBoxEnabled====
<section name="Client" class="client" show="true">
This function enables or disables a created blur box element.
<syntaxhighlight lang="lua">bool exports.blur_box:setBlurBoxEnabled(element blurBoxElement, bool isEnabled)</syntaxhighlight>
===Required Arguments===
*'''element blurBoxElement:''' A previously declared blur box element.
*'''bool isEnabled:''' Enable/Disable the blur box element.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setBlurBoxPosition====
<section name="Client" class="client" show="true">
This function sets blur box position.
<syntaxhighlight lang="lua">bool exports.blur_box:setBlurBoxPosition(element blurBoxElement,float posX,posY)</syntaxhighlight>
===Required Arguments===
*'''element blurBoxElement:''' A previously declared blur box element.
*'''float posX, posY:''' Position in screen space.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

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

====setBlurBoxColor====
<section name="Client" class="client" show="true">
This function sets blur box color values.
<syntaxhighlight lang="lua">bool exports.blur_box:setBlurBoxColor(element blurBoxElement,float colorR,colorG,colorB,colorA)</syntaxhighlight>
===Required Arguments===
*'''element blurBoxElement:''' A previously declared blur box element.
*'''float colorR,colorG,colorB,colorA:''' RGBA color (0 - 255).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setBlurIntensity====
<section name="Client" class="client" show="true">
This function sets blur amount for all the blur boxes
<syntaxhighlight lang="lua">bool exports.blur_box:setBlurIntensity(float blurFactor)</syntaxhighlight>
===Required Arguments===
*'''float blurFactor:''' Set blur amount for all the blur boxes. (default 0.6)
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setScreenResolutionMultiplier====
<section name="Client" class="client" show="true">
This function sets screen relative resolution multiplier for the screenSource
<syntaxhighlight lang="lua">bool exports.blur_box:setScreenResolutionMultiplier(element blurBoxElement, float x,y)</syntaxhighlight>
===Required Arguments===
*'''element blurBoxElement:''' A previously declared blurBox element.
*'''float x,y:''' Set sampled screen relative resolution multiplier (0-1)
===Returns===
The function returns true if set successfully, false otherwise.
</section>

==Examples==
<syntaxhighlight lang="lua">local scx, scy = guiGetScreenSize()
local guiWindowElement = nil
local blurBoxElement = nil

addEventHandler( "onClientHUDRender", root,
function()
if guiWindowElement and blurBoxElement then
local xPos, yPos = guiGetPosition ( guiWindowElement , false )
local xSize, ySize = guiGetSize ( guiWindowElement , false )
exports.blur_box:setBlurBoxPosition( blurBoxElement, xPos, yPos )
exports.blur_box:setBlurBoxSize( blurBoxElement, xSize, ySize )
end
end
,true ,"high-3" )

addEventHandler( "onClientResourceStart", getResourceRootElement( getThisResource()),
function()
guiWindowElement = guiCreateWindow ( scx/2-scy/4, scy/2 - scy/4, scy/2, scy/2, "BlurBox test", false )
guiWindowSetMovable ( guiWindowElement, true )
guiWindowSetSizable ( guiWindowElement, true )
guiSetAlpha ( guiWindowElement, 0.3 )
blurBoxElement = exports.blur_box:createBlurBox( scx/2-scy/4, scy/2 - scy/4, scy/2, scy/2, 255, 255, 255, 255, false )
--exports.blur_box:setBlurBoxColor( blurBoxElement, 255, 100, 100, 255)
exports.blur_box:setScreenResolutionMultiplier( 0.5, 0.5 )
end
)

addEventHandler( "onClientResourceStop", getResourceRootElement( getThisResource()),
function()
destroyElement( guiWindowElement )
blurBoxElement = not exports.blur_box:destroyBlurBox( blurBoxElement )
end
)
</syntaxhighlight>
This creates a blur box and attaches it to a created window element.

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

==See Also==

[http://community.multitheftauto.com/index.php?p=resources&s=details&id=10163 Community resource]

[https://www.dropbox.com/s/db13n4l62k21x19/blurBox_test.zip?dl=0 Test resource]

Resource:Blur box

2015-07-29T21:13:05Z

Renard712:

{{Resource page}}
This resource lets You create simple gaussian blur boxes onClientRender.
Using that - You can make your game GUI a bit more fancy.

== Overview ==

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

The resource itself adds exported clientside functions:

==Exported functions==
====createBlurBox====
<section name="Client" class="client" show="true">
This function creates a blur box.
<syntaxhighlight lang="lua">bool exports.blur_box:createBlurBox(float posX,posY,sizeX,sizeY,int colorR,colorG,colorB,colorA,postGUI)</syntaxhighlight>
===Required Arguments===
*'''float posX, posY:''' Position in screen space.
*'''float sizeX, sizeY:''' Size of the box.
*'''int colorR,colorG,colorB,colorA:''' RGBA color (0 - 255).
*'''bool postGUI:''' Should the box be drawn before or after MTA GUI elements.
===Returns===
The function returns the element if set successfully, 'false' otherwise.
</section>

====destroyBlurBox====
<section name="Client" class="client" show="true">
This function destroys a blur box element.
<syntaxhighlight lang="lua">bool exports.blur_box:destroyBlurBox(element blurBoxElement)</syntaxhighlight>
===Required Arguments===
*'''element blurBoxElement:''' A previously declared blur box element.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setBlurBoxEnabled====
<section name="Client" class="client" show="true">
This function enables or disables a created blur box element.
<syntaxhighlight lang="lua">bool exports.blur_box:setBlurBoxEnabled(element blurBoxElement, bool isEnabled)</syntaxhighlight>
===Required Arguments===
*'''element blurBoxElement:''' A previously declared blur box element.
*'''bool isEnabled:''' Enable/Disable the blur box element.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setBlurBoxPosition====
<section name="Client" class="client" show="true">
This function sets blur box position.
<syntaxhighlight lang="lua">bool exports.blur_box:setBlurBoxPosition(element blurBoxElement,float posX,posY)</syntaxhighlight>
===Required Arguments===
*'''element blurBoxElement:''' A previously declared blur box element.
*'''float posX, posY:''' Position in screen space.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

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

====setBlurBoxColor====
<section name="Client" class="client" show="true">
This function sets blur box color values.
<syntaxhighlight lang="lua">bool exports.blur_box:setBlurBoxColor(element billboardElement,float colorR,colorG,colorB,colorA)</syntaxhighlight>
===Required Arguments===
*'''element blurBoxElement:''' A previously declared blur box element.
*'''float colorR,colorG,colorB,colorA:''' RGBA color (0 - 255).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setBlurIntensity====
<section name="Client" class="client" show="true">
This function sets blur amount for all the blur boxes
<syntaxhighlight lang="lua">bool exports.blur_box:setBlurIntensity(float blurFactor)</syntaxhighlight>
===Required Arguments===
*'''float blurFactor:''' Set blur amount for all the blur boxes. (default 0.6)
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setScreenResolutionMultiplier====
<section name="Client" class="client" show="true">
This function sets screen relative resolution multiplier for the screenSource
<syntaxhighlight lang="lua">bool exports.blur_box:setScreenResolutionMultiplier(element blurBoxElement, float x,y)</syntaxhighlight>
===Required Arguments===
*'''element blurBoxElement:''' A previously declared blurBox element.
*'''float x,y:''' Set sampled screen relative resolution multiplier (0-1)
===Returns===
The function returns true if set successfully, false otherwise.
</section>

==Examples==
<syntaxhighlight lang="lua">local scx, scy = guiGetScreenSize()
local guiWindowElement = nil
local blurBoxElement = nil

addEventHandler( "onClientHUDRender", root,
function()
if guiWindowElement and blurBoxElement then
local xPos, yPos = guiGetPosition ( guiWindowElement , false )
local xSize, ySize = guiGetSize ( guiWindowElement , false )
exports.blur_box:setBlurBoxPosition( blurBoxElement, xPos, yPos )
exports.blur_box:setBlurBoxSize( blurBoxElement, xSize, ySize )
end
end
,true ,"high-3" )

addEventHandler( "onClientResourceStart", getResourceRootElement( getThisResource()),
function()
guiWindowElement = guiCreateWindow ( scx/2-scy/4, scy/2 - scy/4, scy/2, scy/2, "BlurBox test", false )
guiWindowSetMovable ( guiWindowElement, true )
guiWindowSetSizable ( guiWindowElement, true )
guiSetAlpha ( guiWindowElement, 0.3 )
blurBoxElement = exports.blur_box:createBlurBox( scx/2-scy/4, scy/2 - scy/4, scy/2, scy/2, 255, 255, 255, 255, false )
--exports.blur_box:setBlurBoxColor( blurBoxElement, 255, 100, 100, 255)
exports.blur_box:setScreenResolutionMultiplier( 0.5, 0.5 )
end
)

addEventHandler( "onClientResourceStop", getResourceRootElement( getThisResource()),
function()
destroyElement( guiWindowElement )
blurBoxElement = not exports.blur_box:destroyBlurBox( blurBoxElement )
end
)
</syntaxhighlight>
This creates a blur box and attaches it to a created window element.

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

==See Also==

[http://community.multitheftauto.com/index.php?p=resources&s=details&id=10163 Community resource]

[https://www.dropbox.com/s/db13n4l62k21x19/blurBox_test.zip?dl=0 Test resource]

Resource:Blur box

2015-07-29T21:12:44Z

Renard712:

{{Resource page}}
This resource lets You create simple gaussian blur boxes onClientRender.
Using that - You can make your game GUI a bit more fancy.

== Overview ==

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

The resource itself adds exported clientside functions:

==Exported functions==
====createBlurBox====
<section name="Client" class="client" show="true">
This function creates a blur box.
<syntaxhighlight lang="lua">bool exports.blur_box:createBlurBox(float posX,posY,sizeX,sizeY,int colorR,colorG,colorB,colorA,postGUI)</syntaxhighlight>
===Required Arguments===
*'''float posX, posY:''' Position in screen space.
*'''float sizeX, sizeY:''' Size of the box.
*'''int colorR,colorG,colorB,colorA:''' RGBA color (0 - 255).
*'''bool postGUI:''' Should the box be drawn before or after MTA GUI elements.
===Returns===
The function returns the element if set successfully, 'false' otherwise.
</section>

====destroyBlurBox====
<section name="Client" class="client" show="true">
This function destroys a blur box element.
<syntaxhighlight lang="lua">bool exports.blur_box:destroyBlurBox(element blurBoxElement)</syntaxhighlight>
===Required Arguments===
*'''element blurBoxElement:''' A previously declared blur box element.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setBlurBoxEnabled====
<section name="Client" class="client" show="true">
This function enables or disables a created blur box element.
<syntaxhighlight lang="lua">bool exports.blur_box:setBlurBoxEnabled(element blurBoxElement, bool isEnabled)</syntaxhighlight>
===Required Arguments===
*'''element blurBoxElement:''' A previously declared blur box element.
*'''bool isEnabled:''' Enable/Disable the blur box element.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setBlurBoxPosition====
<section name="Client" class="client" show="true">
This function sets blur box position.
<syntaxhighlight lang="lua">bool exports.blur_box:setBlurBoxPosition(element blurBoxElement,float posX,posY)</syntaxhighlight>
===Required Arguments===
*'''element blurBoxElement:''' A previously declared blur box element.
*'''float posX, posY:''' Position in screen space.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

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

====setBlurBoxColor====
<section name="Client" class="client" show="true">
This function sets blur box color values.
<syntaxhighlight lang="lua">bool exports.blur_box:setBlurBoxColor(element billboardElement,float colorR,colorG,colorB,colorA)</syntaxhighlight>
===Required Arguments===
*'''element blurBoxElement:''' A previously declared blur box element.
*'''float colorR,colorG,colorB,colorA:''' RGBA color (0 - 255).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setBlurIntensity====
<section name="Client" class="client" show="true">
This function sets blur amount for all the blur boxes
<syntaxhighlight lang="lua">bool exports.blur_box:setBlurIntensity(float blurFactor)</syntaxhighlight>
===Required Arguments===
*'''float blurFactor:''' Set blur amount for all the blur boxes. (default 0.6)
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setScreenResolutionMultiplier====
<section name="Client" class="client" show="true">
This function sets screen relative resolution multiplier for the screenSource
<syntaxhighlight lang="lua">bool exports.blur_box:setScreenResolutionMultiplier(element blurBoxElement, float x,y)</syntaxhighlight>
===Required Arguments===
*'''element blurBoxElement:''' A previously declared blurBox element.
*'''float x,y:''' Set sampled screen relative resolution multiplier (0-1)
===Returns===
The function returns true if set successfully, false otherwise.
</section>

==Examples==
<syntaxhighlight lang="lua">local scx, scy = guiGetScreenSize()
local guiWindowElement = nil
local blurBoxElement = nil

addEventHandler( "onClientRender", root,
function()
if guiWindowElement and blurBoxElement then
local xPos, yPos = guiGetPosition ( guiWindowElement , false )
local xSize, ySize = guiGetSize ( guiWindowElement , false )
exports.blur_box:setBlurBoxPosition( blurBoxElement, xPos, yPos )
exports.blur_box:setBlurBoxSize( blurBoxElement, xSize, ySize )
end
end
,true ,"high-3" )

addEventHandler( "onClientResourceStart", getResourceRootElement( getThisResource()),
function()
guiWindowElement = guiCreateWindow ( scx/2-scy/4, scy/2 - scy/4, scy/2, scy/2, "BlurBox test", false )
guiWindowSetMovable ( guiWindowElement, true )
guiWindowSetSizable ( guiWindowElement, true )
guiSetAlpha ( guiWindowElement, 0.3 )
blurBoxElement = exports.blur_box:createBlurBox( scx/2-scy/4, scy/2 - scy/4, scy/2, scy/2, 255, 255, 255, 255, false )
--exports.blur_box:setBlurBoxColor( blurBoxElement, 255, 100, 100, 255)
exports.blur_box:setScreenResolutionMultiplier( 0.5, 0.5 )
end
)

addEventHandler( "onClientResourceStop", getResourceRootElement( getThisResource()),
function()
destroyElement( guiWindowElement )
blurBoxElement = not exports.blur_box:destroyBlurBox( blurBoxElement )
end
)
</syntaxhighlight>
This creates a blur box and attaches it to a created window element.

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

==See Also==

[http://community.multitheftauto.com/index.php?p=resources&s=details&id=10163 Community resource]

[https://www.dropbox.com/s/db13n4l62k21x19/blurBox_test.zip?dl=0 Test resource]

Resource:Object preview

2015-07-29T21:07:30Z

Renard712:

{{Resource page}}
This resource lets you create an object that will be drawn on the screen
provided size and position - just like when drawing an image. This way it is easy to
create object preview on GUI (supports drawing in a separate render target).
Works with peds, world objects and vehicles.

== Overview ==

The resource itself adds exported client-side functions:

==Exported functions==
====createObjectPreview====
<section name="Client" class="client" show="true">
Creates the preview for provided world,ped or vehicle element.
<syntaxhighlight lang="lua">bool exports.object_preview:createObjectPreview(element object, float rotX rotY, rotZ, projPosX, projPosY, projSizeX, projSizeY [, bool isRelative = false, postGUI = false, isSecRT = true])</syntaxhighlight>
===Required Arguments===
*'''float rotX, rotY, rotZ:''' Object rotation in camera space.
*'''float projPosX, projPosY:''' Projector left corner on the screen.
*'''float projSizeX, projSizeY:''' Projector size.
===Optional Arguments===
*'''bool isRelative:''' Are the projector parameters relative.
*'''bool postGUI:''' Should the box be drawn before or after MTA GUI elements.
*'''isSecRT:''' Should drawing to second render target is enabled.
===Returns===
The function returns the element if set successfully, 'false' otherwise.
</section>

====destroyObjectPreview====
<section name="Client" class="client" show="true">
Destroys previously created preview - without destroying the object it was applied to.
<syntaxhighlight lang="lua">bool exports.object_preview:destroyObjectPreview(element objectPreviewElement)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====saveRTToFile====
<section name="Client" class="client" show="true">
Save render target to png file. (Only when drawing to second render target is enabled)
<syntaxhighlight lang="lua">bool exports.object_preview:saveRTToFile(element objectPreviewElement, string path)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''string path:''' An exact client resource path the file is to be saved to.
===Returns===
The function returns true if set successfully, false otherwise. It saves the image in client resource path.
</section>

====setRotation====
<section name="Client" class="client" show="true">
This function sets object rotation.
<syntaxhighlight lang="lua">bool exports.object_preview:setRotation(element objectPreviewElement,float rotX, rotX, rotZ)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float rotX, rotX, rotZ:''' Object rotation in camera space.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setProjection====
<section name="Client" class="client" show="true">
This function sets object on screen position and size.
<syntaxhighlight lang="lua">bool exports.object_preview:setProjection(element objectPreviewElement, float projPosY, projSizeX, projSizeY [, bool isRelative = false])</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float projPosX, projPosY:''' Projector left corner on the screen.
*'''float projSizeX, projSizeY:''' Projector size.
===Optional Arguments===
*'''bool isRelative:''' Are the projector parameters relative.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setAlpha====
<section name="Client" class="client" show="true">
This function sets object alpha transparency.
<syntaxhighlight lang="lua">bool exports.object_preview:setAlpha(element objectPreviewElement,int alpha)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''int alpha:''' Object alpha (0 - 255).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====getRenderTarget====
<section name="Client" class="client" show="true">
This function returns a renderTarget (Only when drawing to second render target is enabled)
<syntaxhighlight lang="lua">bool exports.object_preview:getRenderTarget(element objectPreviewElement)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
===Returns===
The function returns render target if set successfully, false otherwise.
</section>

====setDistanceSpread====
<section name="Client" class="client" show="true">
This function sets the difference between object to camera distance set by MTA and that set by shader.
<syntaxhighlight lang="lua">bool exports.object_preview:setDistanceSpread(element objectPreviewElement,float zSpread)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float zSpread:''' Object Distance spread.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setPositionOffsets====
<section name="Client" class="client" show="true">
This function sets object position to camera offsets (standard is 0,0,0)
<syntaxhighlight lang="lua">bool exports.object_preview:setPositionOffsets(element objectPreviewElement,float posX, posX, posX)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float posX, posX, posX:''' Object position to camera offsets.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setRotationOffsets====
<section name="Client" class="client" show="true">
This function sets object rotation centre offsets (standard is 0,0,0)
<syntaxhighlight lang="lua">bool exports.object_preview:setRotationOffsets(element objectPreviewElement,float posX, posX, posX)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float posX, posX, posX:''' Object rotation centre offsets.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

==Examples==
<syntaxhighlight lang="lua">local scx, scy = guiGetScreenSize ()
local myObject,myElement, guiWindow = nil, nil, nil
local myRotation = {0,0,0}

addEventHandler("onClientResourceStart", getResourceRootElement( getThisResource()), function()
local x1, y1, z1 = getCameraMatrix()
myElement = createVehicle (429, x1, y1, z1)

myObject = exports.objectPreview:createObjectPreview(myElement,0, 0, 0, 0.5, 0.5, 1, 1, true, true)
guiWindow = guiCreateWindow((scx/2)-100,(scy/2) - 100,200,200, "Test area", false, false)
guiSetAlpha(guiWindow, 0.05 + 0.2)
local projPosX, projPosY = guiGetPosition(guiWindow,true)
local projSizeX, projSizeY = guiGetSize(guiWindow, true)
exports.object_preview:setProjection(myObject,projPosX, projPosY, projSizeX, projSizeY,true,true)
exports.object_preview:setRotation(myObject,myRotation[1], myRotation[2], myRotation[3])

bindKey ( "num_4", "down", function() myRotation[1] = myRotation[1] - 5 end)
bindKey ( "num_6", "down", function() myRotation[1] = myRotation[1] + 5 end)
bindKey ( "num_add", "down", function() myRotation[2] = myRotation[2] - 5 end)
bindKey ( "num_sub", "down", function() myRotation[2] = myRotation[2] + 5 end)
bindKey ( "num_2", "down", function() myRotation[3] = myRotation[3] - 5 end)
bindKey ( "num_8", "down", function() myRotation[3] = myRotation[3] + 5 end)
bindKey ( "o", "down", function() exports.object_preview:saveRTToFile(myObject,math.random(100)..".png") end)
end)

addEventHandler("onClientPreRender", root, function()
if not myElement or not myObject then return end
local projPosX, projPosY = guiGetPosition(guiWindow,true)
local projSizeX, projSizeY = guiGetSize(guiWindow, true)
exports.object_preview:setProjection(myObject,projPosX, projPosY, projSizeX, projSizeY, true, true)
end, true, "high" )

addEventHandler("onClientResourceStop", getResourceRootElement( getThisResource()), function()
exports.object_preview:destroyObjectPreview(myObject)
end
)
</syntaxhighlight>
This creates a vehicle, applies object preview and scales it using dimensions of a window element.

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

==See Also==

[https://community.multitheftauto.com/index.php?p=resources&s=details&id=11836 Community resource]

Resource:Object preview

2015-07-29T20:46:52Z

Renard712:

{{Resource page}}
This resource lets you create an object that will be drawn on the screen
provided size and position - just like when drawing an image. This way it is easy to
create object preview on GUI (supports drawing in a separate render target).
Works with peds, world objects and vehicles.

== Overview ==

The resource itself adds exported client-side functions:

==Exported functions==
====createObjectPreview====
<section name="Client" class="client" show="true">
Creates the preview for provided world,ped or vehicle element.
<syntaxhighlight lang="lua">bool exports.object_preview:createObjectPreview(element object, float rotX rotY, rotZ, projPosX, projPosY, projSizeX, projSizeY [, bool isRelative = false, postGUI = false, isSecRT = true])</syntaxhighlight>
===Required Arguments===
*'''float rotX, rotY, rotZ:''' Object rotation in camera space.
*'''float projPosX, projPosY:''' Projector left corner on the screen.
*'''float projSizeX, projSizeY:''' Projector size.
===Optional Arguments===
*'''bool isRelative:''' Are the projector parameters relative.
*'''bool postGUI:''' Should the box be drawn before or after MTA GUI elements.
*'''isSecRT:''' Should drawing to second render target is enabled.
===Returns===
The function returns the element if set successfully, 'false' otherwise.
</section>

====destroyObjectPreview====
<section name="Client" class="client" show="true">
Destroys previously created preview - without destroying the object it was applied to.
<syntaxhighlight lang="lua">bool exports.object_preview:destroyObjectPreview(element objectPreviewElement)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====saveRTToFile====
<section name="Client" class="client" show="true">
Save render target to png file. (Only when drawing to second render target is enabled)
<syntaxhighlight lang="lua">bool exports.object_preview:saveRTToFile(element objectPreviewElement, string path)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''string path:''' An exact client resource path the file is to be saved to.
===Returns===
The function returns true if set successfully, false otherwise. It saves the image in client resource path.
</section>

====setRotation====
<section name="Client" class="client" show="true">
This function sets object rotation.
<syntaxhighlight lang="lua">bool exports.object_preview:setRotation(element objectPreviewElement,float rotX, rotX, rotZ)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float rotX, rotX, rotZ:''' Object rotation in camera space.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setProjection====
<section name="Client" class="client" show="true">
This function sets object on screen position and size.
<syntaxhighlight lang="lua">bool exports.object_preview:setProjection(element objectPreviewElement, float projPosY, projSizeX, projSizeY [, bool isRelative = false])</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float projPosX, projPosY:''' Projector left corner on the screen.
*'''float projSizeX, projSizeY:''' Projector size.
===Optional Arguments===
*'''bool isRelative:''' Are the projector parameters relative.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setAlpha====
<section name="Client" class="client" show="true">
This function sets object alpha transparency.
<syntaxhighlight lang="lua">bool exports.object_preview:setAlpha(element objectPreviewElement,int alpha)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''int alpha:''' Object alpha (0 - 255).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====getRenderTarget====
<section name="Client" class="client" show="true">
This function returns a renderTarget (Only when drawing to second render target is enabled)
<syntaxhighlight lang="lua">bool exports.object_preview:getRenderTarget(element objectPreviewElement)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
===Returns===
The function returns render target if set successfully, false otherwise.
</section>

====setDistanceSpread====
<section name="Client" class="client" show="true">
This function sets the difference between object to camera distance set by MTA and that set by shader.
<syntaxhighlight lang="lua">bool exports.object_preview:setDistanceSpread(element objectPreviewElement,float zSpread)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float zSpread:''' Object Distance spread.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setPositionOffsets====
<section name="Client" class="client" show="true">
This function sets object position to camera offsets (standard is 0,0,0)
<syntaxhighlight lang="lua">bool exports.object_preview:setPositionOffsets(element objectPreviewElement,float posX, posX, posX)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float posX, posX, posX:''' Object position to camera offsets.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setRotationOffsets====
<section name="Client" class="client" show="true">
This function sets object rotation centre offsets (standard is 0,0,0)
<syntaxhighlight lang="lua">bool exports.object_preview:setRotationOffsets(element objectPreviewElement,float posX, posX, posX)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float posX, posX, posX:''' Object rotation centre offsets.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

==Examples==
<syntaxhighlight lang="lua">local scx, scy = guiGetScreenSize ()
local myObject,myElement, guiWindow = nil, nil, nil
local myRotation = {0,0,0}

addEventHandler("onClientResourceStart", getResourceRootElement( getThisResource()), function()
local x1, y1, z1 = getCameraMatrix()
myElement = createVehicle (429, x1, y1, z1)

myObject = exports.objectPreview:createObjectPreview(myElement,0, 0, 0, 0.5, 0.5, 1, 1, true, true)
guiWindow = guiCreateWindow((scx/2)-100,(scy/2) - 100,200,200, "Test area", false, false)
guiSetAlpha(guiWindow, 0.05 + 0.2)
local projPosX, projPosY = guiGetPosition(guiWindow,true)
local projSizeX, projSizeY = guiGetSize(guiWindow, true)
exports.object_preview:setProjection(myObject,projPosX, projPosY, projSizeX, projSizeY,true,true)
exports.object_preview:setRotation(myObject,myRotation[1], myRotation[2], myRotation[3])

bindKey ( "num_4", "down", function() myRotation[1] = myRotation[1] - 5 end)
bindKey ( "num_6", "down", function() myRotation[1] = myRotation[1] + 5 end)
bindKey ( "num_add", "down", function() myRotation[2] = myRotation[2] - 5 end)
bindKey ( "num_sub", "down", function() myRotation[2] = myRotation[2] + 5 end)
bindKey ( "num_2", "down", function() myRotation[3] = myRotation[3] - 5 end)
bindKey ( "num_8", "down", function() myRotation[3] = myRotation[3] + 5 end)
bindKey ( "o", "down", function() exports.object_preview:saveRTToFile(myObject,math.random(100)..".png") end)
end)

addEventHandler("onClientPreRender", root, function()
if not myElement or not myObject then return end
local projPosX, projPosY = guiGetPosition(guiWindow,true)
local projSizeX, projSizeY = guiGetSize(guiWindow, true)
exports.object_preview:setProjection(myObject,projPosX, projPosY, projSizeX, projSizeY, true, true)
end, true, "high" )

addEventHandler("onClientResourceStop", getResourceRootElement( getThisResource()), function()
exports.object_preview:destroyObjectPreview(myObject)
end
)
</syntaxhighlight>
This creates a vehicle, applies object preview and scales it using dimensions of a window element.

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

Resource:Object preview

2015-07-29T20:44:30Z

Renard712: Created page with "{{Resource page}} This resource lets you create an object that will be drawn on the screen provided size and position - just like when drawing an image. This way it is easy t..."

{{Resource page}}
This resource lets you create an object that will be drawn on the screen
provided size and position - just like when drawing an image. This way it is easy to
create object preview on GUI (supports drawing in a separate render target).
Works with peds, world objects and vehicles.

== Overview ==

The resource itself adds exported client-side functions:

==Exported functions==
====createObjectPreview====
<section name="Client" class="client" show="true">
Creates the preview for provided world,ped or vehicle element.
<syntaxhighlight lang="lua">bool exports.object_preview:createObjectPreview(element object, float rotX rotY, rotZ, projPosX, projPosY, projSizeX, projSizeY [, bool isRelative = false, postGUI = false, isSecRT = true])</syntaxhighlight>
===Required Arguments===
*'''float rotX, rotY, rotZ:''' Object rotation in camera space.
*'''float projPosX, projPosY:''' Projector left corner on the screen.
*'''float projSizeX, projSizeY:''' Projector size.
===Optional Arguments===
*'''bool isRelative:''' Are the projector parameters relative.
*'''bool postGUI:''' Should the box be drawn before or after MTA GUI elements.
*'''isSecRT:''' Should drawing to second render target is enabled.
===Returns===
The function returns the element if set successfully, 'false' otherwise.
</section>

====destroyObjectPreview====
<section name="Client" class="client" show="true">
Destroys previously created preview - without destroying the object it was applied to.
<syntaxhighlight lang="lua">bool exports.object_preview:destroyObjectPreview(element objectPreviewElement)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====saveRTToFile====
<section name="Client" class="client" show="true">
Save render target to png file. (Only when drawing to second render target is enabled)
<syntaxhighlight lang="lua">bool exports.object_preview:saveRTToFile(element objectPreviewElement, string path)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''string path:''' An exact client resource path the file is to be saved to.
===Returns===
The function returns true if set successfully, false otherwise. It saves the image in client resource path.
</section>

====setRotation====
<section name="Client" class="client" show="true">
This function sets object rotation.
<syntaxhighlight lang="lua">bool exports.object_preview:setRotation(element objectPreviewElement,float rotX, rotX, rotZ)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float rotX, rotX, rotZ:''' Object rotation in camera space.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setProjection====
<section name="Client" class="client" show="true">
This function sets object on screen position and size.
<syntaxhighlight lang="lua">bool exports.object_preview:setProjection(element objectPreviewElement, float projPosY, projSizeX, projSizeY [, bool isRelative = false])</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float projPosX, projPosY:''' Projector left corner on the screen.
*'''float projSizeX, projSizeY:''' Projector size.
===Optional Arguments===
*'''bool isRelative:''' Are the projector parameters relative.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setAlpha====
<section name="Client" class="client" show="true">
This function sets object alpha transparency.
<syntaxhighlight lang="lua">bool exports.object_preview:setAlpha(element objectPreviewElement,int alpha)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''int alpha:''' Object alpha (0 - 255).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====getRenderTarget====
<section name="Client" class="client" show="true">
This function returns a renderTarget (Only when drawing to second render target is enabled)
<syntaxhighlight lang="lua">bool exports.object_preview:getRenderTarget(element objectPreviewElement)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
===Returns===
The function returns render target if set successfully, false otherwise.
</section>

====setDistanceSpread====
<section name="Client" class="client" show="true">
This function sets the difference between object to camera distance set by MTA and that set by shader.
<syntaxhighlight lang="lua">bool exports.object_preview:setDistanceSpread(element objectPreviewElement,float zSpread)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float zSpread:''' Object Distance spread.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setPositionOffsets====
<section name="Client" class="client" show="true">
This function sets object position to camera offsets (standard is 0,0,0)
<syntaxhighlight lang="lua">bool exports.object_preview:setPositionOffsets(element objectPreviewElement,float posX, posX, posX)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float posX, posX, posX:''' Object position to camera offsets.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setRotationOffsets====
<section name="Client" class="client" show="true">
This function sets object rotation centre offsets (standard is 0,0,0)
<syntaxhighlight lang="lua">bool exports.object_preview:setRotationOffsets(element objectPreviewElement,float posX, posX, posX)</syntaxhighlight>
===Required Arguments===
*'''element objectPreviewElement:''' A previously declared preview element.
*'''float posX, posX, posX:''' Object rotation centre offsets.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

==Examples==
<syntaxhighlight lang="lua">local scx, scy = guiGetScreenSize ()
local myObject,myElement, guiWindow = nil, nil, nil
local myRotation = {0,0,0}

addEventHandler("onClientResourceStart", getResourceRootElement( getThisResource()), function()
local x1, y1, z1 = getCameraMatrix()
myElement = createVehicle (429, x1, y1, z1)

myObject = exports.objectPreview:createObjectPreview(myElement,0, 0, 0, 0.5, 0.5, 1, 1, true, true)
guiWindow = guiCreateWindow((scx/2)-100,(scy/2) - 100,200,200, "Test area", false, false)
guiSetAlpha(guiWindow, 0.05 + 0.2)
local projPosX, projPosY = guiGetPosition(guiWindow,true)
local projSizeX, projSizeY = guiGetSize(guiWindow, true)
exports.objectPreview:setProjection(myObject,projPosX, projPosY, projSizeX, projSizeY,true,true)
exports.objectPreview:setRotation(myObject,myRotation[1], myRotation[2], myRotation[3])

bindKey ( "num_4", "down", function() myRotation[1] = myRotation[1] - 5 end)
bindKey ( "num_6", "down", function() myRotation[1] = myRotation[1] + 5 end)
bindKey ( "num_add", "down", function() myRotation[2] = myRotation[2] - 5 end)
bindKey ( "num_sub", "down", function() myRotation[2] = myRotation[2] + 5 end)
bindKey ( "num_2", "down", function() myRotation[3] = myRotation[3] - 5 end)
bindKey ( "num_8", "down", function() myRotation[3] = myRotation[3] + 5 end)
bindKey ( "o", "down", function() exports.objectPreview:saveRTToFile(myObject,math.random(100)..".png") end)
end)

addEventHandler("onClientPreRender", root, function()
if not myElement or not myObject then return end
local projPosX, projPosY = guiGetPosition(guiWindow,true)
local projSizeX, projSizeY = guiGetSize(guiWindow, true)
exports.objectPreview:setProjection(myObject,projPosX, projPosY, projSizeX, projSizeY, true, true)
end, true, "high" )

addEventHandler("onClientResourceStop", getResourceRootElement( getThisResource()), function()
exports.objectPreview:destroyObjectPreview(myObject)
end
)
</syntaxhighlight>
This creates a vehicle, applies object preview and scales it using dimensions of a window element.

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

Resource:Dynamic lighting

2014-11-04T15:49:04Z

Renard712:

{{Resource page}}
This resource lets You create dynamic lights in MTA. It gives you a list of exported functions that You can use to create per pixel pointlights and spotlights. It should be considered a preview of what [https://wiki.multitheftauto.com/wiki/MTA:Eir MTA:Eir] will offer. The future solution should be more FPS friendly. Yet i see that resource as an example of what the future holds.

== Overview ==

It is easy to use, gives a few options to create per pixel lights in gtasa.

The resource itself adds exported clientside functions:

==Exported functions==
====createPointLight====
<section name="Client" class="client" show="true">
This function creates a pixel shader pointlight.
<syntaxhighlight lang="lua">lightElement exports.dynamic_lighting:createPointLight(float posX,posY,posZ,colorR,colorG,colorB,colorA,attenuation,[bool normalShadow = true])</syntaxhighlight>
===Required Arguments===
*'''float posX, posY, posZ:''' Light position in world.
*'''float colorR,colorG,colorB,colorA:''' RGBA color emitted by the light (0 - 1 instead of 0-255).
*'''float attenuation:''' Value specifying how the light intensity changes over distance.
===Optional Arguments===
*'''bool normalShadow:''' Determine if the light source should be obscured when lighting a surface on opposite angles.
===Returns===
The function returns lightElement if set successfully, false otherwise.
</section>
====createSpotLight====
<section name="Client" class="client" show="true">
This function creates a pixel shader spotlight.
<syntaxhighlight lang="lua">lightElement exports.dynamic_lighting:createSpottLight(float posX,posY,posZ,colorR,colorG,colorB,colorA,dirX,dirY,dirZ, bool isEuler,float falloff,theta,phi,attenuation,[bool normalShadowing = true])</syntaxhighlight>
===Required Arguments===
*'''float posX, posY, posZ:''' Light position in world space.
*'''float colorR,colorG,colorB,colorA:''' RGBA color emitted by the light (0 - 1 instead of 0-255).
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
*'''bool isEuler:''' Is the angle set as an "ZXY" euler andgle or a vector.
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
*'''float falloff:''' Decrease in illumination between a spotlight's inner cone (the angle specified by Theta) and the outer edge of the outer cone (the angle specified by Phi).
*'''float theta: (radians)''' Angle, in radians, of a spotlight's inner cone - that is, the fully illuminated spotlight cone. This value must be in the range from 0 through the value specified by Phi.
*'''float phi: (radians)''' Angle, in radians, defining the outer edge of the spotlight's outer cone. Points outside this cone are not lit by the spotlight. This value must be between 0 and pi.
*'''float attenuation:''' Value specifying how the light intensity changes over distance.
===Optional Arguments===
*'''bool normalShadow:''' Determine if the light source should be obscured when lighting a surface on opposite angles.
===Returns===
The function returns lightElement if set successfully, false otherwise.
</section>

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

====setLightDirection====
<section name="Client" class="client" show="true">
This function setd light direction values for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightDirection(element lightElement,float dirX,dirY,dirZ,[bool isEuler = false])</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
===Optional Arguments===
*'''bool isEuler:'''Is the angle set as an "ZXY" euler andgle or a vector.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightPosition====
<section name="Client" class="client" show="true">
This function sets light position values for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightPosition(element lightElement,float posX,posY,posZ)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float posX, posY, posZ:''' Light position in world space.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightColor====
<section name="Client" class="client" show="true">
This function sets light color values for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightColor(element lightElement,float colorR,colorG,colorB,colorA)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float colorR,colorG,colorB,colorA:''' RGBA color emitted by the light (0 - 1 instead of 0-255).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightAttenuation====
<section name="Client" class="client" show="true">
This function sets setLightAttenuation value for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightAttenuation(element lightElement,float attenuation)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float attenuation:''' Value specifying how the light intensity changes over distance.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightFalloff====
<section name="Client" class="client" show="true">
This function sets falloff value for a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightFalloff(element lightElement,float falloff)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float falloff (radians):''' Decrease in illumination between a spotlight's inner cone (the angle specified by Theta) and the outer edge of the outer cone (the angle specified by Phi).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightTheta====
<section name="Client" class="client" show="true">
This function sets theta value for a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightTheta(element lightElement,float theta)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float theta (radians):''' Angle, in radians, of a spotlight's inner cone - that is, the fully illuminated spotlight cone. This value must be in the range from 0 through the value specified by Phi.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightPhi====
<section name="Client" class="client" show="true">
This function sets phi value for a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightPhi(element lightElement,float phi)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float phi (radians):''' Angle, in radians, defining the outer edge of the spotlight's outer cone. Points outside this cone are not lit by the spotlight. This value must be between 0 and pi.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightNormalShadowing====
<section name="Client" class="client" show="true">
Determine if the light source should be obscured when lighting a surface on opposite angles.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightNormalShadowing(element lightElement,bool normalShadow)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''bool normalShadow:''' Determine if the light source should be obscured when lighting a surface on opposite angles.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShadersLayered====
<section name="Client" class="client" show="true">
Should the main shader effects be created in a separate render pass ? As default only the vehicle effect is layered.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShadersLayered(bool isWorld, isVeh, isPed)</syntaxhighlight>
===Required Arguments===
*'''bool isWorld, isVeh, isPed:''' Should the shader effects be created in a separate render pass.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setGenerateBumpNormals====
<section name="Client" class="client" show="true">
Should the shader effect generate bump normals from texture0. Doesn't work when normal shadowing is set to false.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setGenerateBumpNormals(bool isTrue,[int textureSize = 512, float normalStrength.x = 1, float normalStrength.y = 1])</syntaxhighlight>
===Required Arguments===
*'''bool isTrue:''' Turn on or off bump mapping.
===Optional Arguments===
*'''int textureSize:''' The size of the input texture.
*'''float normalStrength.xy:''' How bumpy should the surface be ?
===Returns===
The function returns true if set successfully, false otherwise.
</section>

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

====setLightsEffectRange====
<section name="Client" class="client" show="true">
Set the Max distance from the camera the shader effects are applied to.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightsEffectRange(int maxEffectRange)</syntaxhighlight>
===Required Arguments===
*'''int maxEffectRange:''' If non-zero, the shaders will be applied to textures nearer than maxDistance only.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderForcedOn====
<section name="Client" class="client" show="true">
Should the shader effect turn off when no lightsources.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderForcedOn(bool isShaderForcedOn)</syntaxhighlight>
===Required Arguments===
*'''bool isShaderForcedOn:''' Should the shader effect turn off when no lightsources.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderTimeOut====
<section name="Client" class="client" show="true">
Should the shader effect turn off after number of seconds (when no lightsources)
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderTimeOut(int timeOut)</syntaxhighlight>
===Required Arguments===
*'''int timeOut:''' Should the shader effect turn off after number of seconds (when no lightsources)
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderNightMod====
<section name="Client" class="client" show="true">
Enable nightMod effect - requires proper manipulation of setTextureBrightness and SetShaderDayTime, also some additional shaders.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderNightMod(bool enable)</syntaxhighlight>
===Required Arguments===
*'''bool enable:''' Enable or disable nightMod effect
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderDayTime====
<section name="Client" class="client" show="true">
Another additional variable to control texture colors - requires setShaderNightMod(true)
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderDayTime(float dayTime)</syntaxhighlight>
===Required Arguments===
*'''float dayTime:''' Another additional variable to control texture colors - requires setShaderNightMod(true) set 1 as default
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderPedDiffuse====
<section name="Client" class="client" show="true">
Enable or disable gta directional lights for ped.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderPedDiffuse(bool enable)</syntaxhighlight>
===Required Arguments===
*'''bool enable:''' Enable or disable gta directional lights for ped (enabled as default)
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setDirLightEnable====
<section name="Client" class="client" show="true">
This function creates a vertex shader directional light. NOTE: Forcing the effects on or using any other lights is required for directional light to work.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setDirLightEnable(bool enable = false)</syntaxhighlight>
===Required Arguments===
*'''bool enable:''' Enable or disable the directional light.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setDirLightDirection====
<section name="Client" class="client" show="true">
This function sets the directional light direction.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setDirLightDirection(float dirX,dirY,dirZ,[bool isEuler = false])</syntaxhighlight>
===Required Arguments===
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
===Optional Arguments===
*'''bool isEuler:'''Is the angle set as an "ZXY" euler andgle or a vector.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setDirLightColor====
<section name="Client" class="client" show="true">
This function sets the directional light color value.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setDirLightColor(float colorR,colorG,colorB,colorA)</syntaxhighlight>
===Required Arguments===
*'''float colorR,colorG,colorB,colorA:''' RGBA color emitted by the light (0 - 1 instead of 0-255).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

==Examples==
<syntaxhighlight lang="lua">exports.dynamic_lighting:createPointLight(0,0,5,1,0,0,1,15)</syntaxhighlight>
This creates a red pointlight in world position (0,0,5)

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

==See Also==
[http://community.multitheftauto.com/index.php?p=resources&s=details&id=9398 Dynamic Lighting resource on MTA Community]

[http://msdn.microsoft.com/en-us/library/windows/desktop/bb174697%28v=vs.85%29.aspx Light Types (Direct3D 9)]

[http://www.youtube.com/watch?v=2t_bje_XjUY Vehicle lights video]

Resource:Dynamic lighting

2014-11-03T02:55:50Z

Renard712:

{{Resource page}}
This resource lets You create dynamic lights in MTA. It gives you a list of exported functions that You can use to create per pixel pointlights and spotlights. It should be considered a preview of what [https://wiki.multitheftauto.com/wiki/MTA:Eir MTA:Eir] will offer. The future solution should be more FPS friendly. Yet i see that resource as an example of what the future holds.

== Overview ==

It is easy to use, gives a few options to create per pixel lights in gtasa.

The resource itself adds exported clientside functions:

==Exported functions==
====createPointLight====
<section name="Client" class="client" show="true">
This function creates a pixel shader pointlight.
<syntaxhighlight lang="lua">lightElement exports.dynamic_lighting:createPointLight(float posX,posY,posZ,colorR,colorG,colorB,colorA,attenuation,[bool normalShadow = true])</syntaxhighlight>
===Required Arguments===
*'''float posX, posY, posZ:''' Light position in world.
*'''float colorR,colorG,colorB,colorA:''' RGBA color emitted by the light (0 - 1 instead of 0-255).
*'''float attenuation:''' Value specifying how the light intensity changes over distance.
===Optional Arguments===
*'''bool normalShadow:''' Determine if the light source should be obscured when lighting a surface on opposite angles.
===Returns===
The function returns lightElement if set successfully, false otherwise.
</section>
====createSpotLight====
<section name="Client" class="client" show="true">
This function creates a pixel shader spotlight.
<syntaxhighlight lang="lua">lightElement exports.dynamic_lighting:createSpottLight(float posX,posY,posZ,colorR,colorG,colorB,colorA,dirX,dirY,dirZ, bool isEuler,float falloff,theta,phi,attenuation,[bool normalShadowing = true])</syntaxhighlight>
===Required Arguments===
*'''float posX, posY, posZ:''' Light position in world space.
*'''float colorR,colorG,colorB,colorA:''' RGBA color emitted by the light (0 - 1 instead of 0-255).
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
*'''bool isEuler:''' Is the angle set as an "ZXY" euler andgle or a vector.
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
*'''float falloff:''' Decrease in illumination between a spotlight's inner cone (the angle specified by Theta) and the outer edge of the outer cone (the angle specified by Phi).
*'''float theta: (radians)''' Angle, in radians, of a spotlight's inner cone - that is, the fully illuminated spotlight cone. This value must be in the range from 0 through the value specified by Phi.
*'''float phi: (radians)''' Angle, in radians, defining the outer edge of the spotlight's outer cone. Points outside this cone are not lit by the spotlight. This value must be between 0 and pi.
*'''float attenuation:''' Value specifying how the light intensity changes over distance.
===Optional Arguments===
*'''bool normalShadow:''' Determine if the light source should be obscured when lighting a surface on opposite angles.
===Returns===
The function returns lightElement if set successfully, false otherwise.
</section>

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

====setLightDirection====
<section name="Client" class="client" show="true">
This function setd light direction values for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightDirection(element lightElement,float dirX,dirY,dirZ,[bool isEuler = false])</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
===Optional Arguments===
*'''bool isEuler:'''Is the angle set as an "ZXY" euler andgle or a vector.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightPosition====
<section name="Client" class="client" show="true">
This function sets light position values for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightPosition(element lightElement,float posX,posY,posZ)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float posX, posY, posZ:''' Light position in world space.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightColor====
<section name="Client" class="client" show="true">
This function sets light color values for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightColor(element lightElement,float colorR,colorG,colorB,colorA)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float colorR,colorG,colorB,colorA:''' RGBA color emitted by the light (0 - 1 instead of 0-255).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightAttenuation====
<section name="Client" class="client" show="true">
This function sets setLightAttenuation value for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightAttenuation(element lightElement,float attenuation)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float attenuation:''' Value specifying how the light intensity changes over distance.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightFalloff====
<section name="Client" class="client" show="true">
This function sets falloff value for a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightFalloff(element lightElement,float falloff)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float falloff (radians):''' Decrease in illumination between a spotlight's inner cone (the angle specified by Theta) and the outer edge of the outer cone (the angle specified by Phi).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightTheta====
<section name="Client" class="client" show="true">
This function sets theta value for a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightTheta(element lightElement,float theta)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float theta (radians):''' Angle, in radians, of a spotlight's inner cone - that is, the fully illuminated spotlight cone. This value must be in the range from 0 through the value specified by Phi.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightPhi====
<section name="Client" class="client" show="true">
This function sets phi value for a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightPhi(element lightElement,float phi)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float phi (radians):''' Angle, in radians, defining the outer edge of the spotlight's outer cone. Points outside this cone are not lit by the spotlight. This value must be between 0 and pi.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightNormalShadowing====
<section name="Client" class="client" show="true">
Determine if the light source should be obscured when lighting a surface on opposite angles.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightNormalShadowing(element lightElement,bool normalShadow)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''bool normalShadow:''' Determine if the light source should be obscured when lighting a surface on opposite angles.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setGenerateBumpNormals====
<section name="Client" class="client" show="true">
Should the shader effect generate bump normals from texture0. Doesn't work when normal shadowing is set to false.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setGenerateBumpNormals(bool isTrue,[int textureSize = 512, float normalStrength.x = 1, float normalStrength.y = 1])</syntaxhighlight>
===Required Arguments===
*'''bool isTrue:''' Turn on or off bump mapping.
===Optional Arguments===
*'''int textureSize:''' The size of the input texture.
*'''float normalStrength.xy:''' How bumpy should the surface be ?
===Returns===
The function returns true if set successfully, false otherwise.
</section>

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

====setLightsEffectRange====
<section name="Client" class="client" show="true">
Set the Max distance from the camera the shader effects are applied to.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightsEffectRange(int maxEffectRange)</syntaxhighlight>
===Required Arguments===
*'''int maxEffectRange:''' If non-zero, the shaders will be applied to textures nearer than maxDistance only.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderForcedOn====
<section name="Client" class="client" show="true">
Should the shader effect turn off when no lightsources.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderForcedOn(bool isShaderForcedOn)</syntaxhighlight>
===Required Arguments===
*'''bool isShaderForcedOn:''' Should the shader effect turn off when no lightsources.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderTimeOut====
<section name="Client" class="client" show="true">
Should the shader effect turn off after number of seconds (when no lightsources)
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderTimeOut(int timeOut)</syntaxhighlight>
===Required Arguments===
*'''int timeOut:''' Should the shader effect turn off after number of seconds (when no lightsources)
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderNightMod====
<section name="Client" class="client" show="true">
Enable nightMod effect - requires proper manipulation of setTextureBrightness and SetShaderDayTime, also some additional shaders.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderNightMod(bool enable)</syntaxhighlight>
===Required Arguments===
*'''bool enable:''' Enable or disable nightMod effect
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderDayTime====
<section name="Client" class="client" show="true">
Another additional variable to control texture colors - requires setShaderNightMod(true)
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderDayTime(float dayTime)</syntaxhighlight>
===Required Arguments===
*'''float dayTime:''' Another additional variable to control texture colors - requires setShaderNightMod(true) set 1 as default
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderPedDiffuse====
<section name="Client" class="client" show="true">
Enable or disable gta directional lights for ped.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderPedDiffuse(bool enable)</syntaxhighlight>
===Required Arguments===
*'''bool enable:''' Enable or disable gta directional lights for ped (enabled as default)
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setDirLightEnable====
<section name="Client" class="client" show="true">
This function creates a vertex shader directional light. NOTE: Forcing the effects on or using any other lights is required for directional light to work.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setDirLightEnable(bool enable = false)</syntaxhighlight>
===Required Arguments===
*'''bool enable:''' Enable or disable the directional light.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setDirLightDirection====
<section name="Client" class="client" show="true">
This function sets the directional light direction.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setDirLightDirection(float dirX,dirY,dirZ,[bool isEuler = false])</syntaxhighlight>
===Required Arguments===
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
===Optional Arguments===
*'''bool isEuler:'''Is the angle set as an "ZXY" euler andgle or a vector.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setDirLightColor====
<section name="Client" class="client" show="true">
This function sets the directional light color value.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setDirLightColor(float colorR,colorG,colorB,colorA)</syntaxhighlight>
===Required Arguments===
*'''float colorR,colorG,colorB,colorA:''' RGBA color emitted by the light (0 - 1 instead of 0-255).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

==Examples==
<syntaxhighlight lang="lua">exports.dynamic_lighting:createPointLight(0,0,5,1,0,0,1,15)</syntaxhighlight>
This creates a red pointlight in world position (0,0,5)

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

==See Also==
[http://community.multitheftauto.com/index.php?p=resources&s=details&id=9398 Dynamic Lighting resource on MTA Community]

[http://msdn.microsoft.com/en-us/library/windows/desktop/bb174697%28v=vs.85%29.aspx Light Types (Direct3D 9)]

[http://www.youtube.com/watch?v=2t_bje_XjUY Vehicle lights video]

Resource:Custom coronas

2014-10-25T00:38:33Z

Renard712:

{{Resource page}}
This resource lets You create some coronas. Not just your typical gtasa coronas
that often times fail to appear. Since in this case corona Elements are created using
dxDrawMaterialLine3d MTA function. I have changed the behaviour of the material
to act as cylindrical billboards do.

== Overview ==

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

The resource itself adds exported clientside functions:

==Exported functions==
====createCorona====
<section name="Client" class="client" show="true">
This function creates a shadered materialLine3d Corona.
<syntaxhighlight lang="lua">coronaElement exports.custom_coronas:createCorona(float posX,posY,posZ,size,int colorR,colorG,colorB,colorA,[bool isSoftParticle = false])</syntaxhighlight>
===Required Arguments===
*'''float posX, posY, posZ:''' Position in world space.
*'''float size:''' Size of the corona.
*'''int colorR,colorG,colorB,colorA:''' RGBA color (0 - 255).
===Optional Arguments===
*'''bool isSoftParticle:''' The aim with soft particles is to remove the ugly artifact that appears when the particle quad intersects the scene. The option requires DepthBuffer access.
===Returns===
The function returns coronaElement if set successfully, false otherwise.
</section>

====createMaterialCorona====
<section name="Client" class="client" show="true">
This function creates a shadered materialLine3d Corona with a custom material.
<syntaxhighlight lang="lua">coronaElement exports.custom_coronas:createMaterialCorona(element material,float posX,posY,posZ,size,int colorR,colorG,colorB,colorA,[bool isSoftParticle = false])</syntaxhighlight>
===Required Arguments===
*'''element material:''' Material to replace the standard corona texture with.
*'''float posX, posY, posZ:''' Position in world space.
*'''float size:''' Size of the corona.
*'''int colorR,colorG,colorB,colorA:''' RGBA color (0 - 255).
===Optional Arguments===
*'''bool isSoftParticle:''' The aim with soft particles is to remove the ugly artifact that appears when the particle quad intersects the scene. The option requires DepthBuffer access.
===Returns===
The function returns coronaElement if set successfully, false otherwise.
</section>

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

====setCoronaMaterial====
<section name="Client" class="client" show="true">
This function sets custom material for the corona.
<syntaxhighlight lang="lua">bool exports.custom_coronas:setCoronaMaterial(element coronaElement,element material)</syntaxhighlight>
===Required Arguments===
*'''element coronaElement:''' A previously declared corona element.
*'''element material:''' Material to replace the standard corona texture with.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

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

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

====setCoronaDepthBias====
<section name="Client" class="client" show="true">
On createCorona the depthBias is set properly (0-1). You can however set other value depending on your needs. To see the results you'll need to set enableDepthBiasScale to true.
<syntaxhighlight lang="lua">bool exports.custom_coronas:setCoronaDepthBias(element coronaElement,float depthBiasValue)</syntaxhighlight>
===Required Arguments===
*'''element coronaElement:''' A previously declared corona element.
*'''float depthBiasValue:''' depthBias value.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

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

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

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

====enableDepthBiasScale====
<section name="Client" class="client" show="true">
Standard depthBias for GTASA coronas is about 1 unit, despite the corona scale. This function elables depthBias scaling.
<syntaxhighlight lang="lua">bool exports.custom_coronas:enableDepthBiasScale(bool isDepthScaleEnabled)</syntaxhighlight>
===Required Arguments===
*'''bool isDepthScaleEnabled:''' Enable/disable depthBias scaling.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

==Examples==
<syntaxhighlight lang="lua">function addStuff()
for i=1,30 do
for j=1,30 do
exports.custom_coronas:createCorona(i * 7,j * 7,10,4,math.random()*255,math.random()*255,math.random()*255,1*255,false)
end
end
end

addEventHandler("onClientResourceStart", getResourceRootElement( getThisResource()), addStuff)</syntaxhighlight>
This creates a 400 coronas 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 carLight = exports.custom_coronas:createCorona(0,0,0,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_coronas:setCoronaPosition(carLight,xxx1,yyy1,zzz1)
end
end
) </syntaxhighlight>
This creates a corona 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_coronas resource in meta.

==See Also==
[http://www.youtube.com/watch?v=5lruyY1fviQ A youtube video]

[http://community.multitheftauto.com/index.php?p=resources&s=details&id=9558 Custom Coronas resource on MTA Community]

[http://www.html5rocks.com/en/tutorials/webgl/webgl_orthographic_3d WebGL Orthographic 3D]

Resource:Custom billboards

2014-10-25T00:35:17Z

Renard712:

{{Resource page}}
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.
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">billboardElement 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:''' RGBA color (0 - 255).
===Returns===
The function returns billboardElement 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 size.
<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>

====setBillboardDepthBias====
<section name="Client" class="client" show="true">
On createBillboard the depthBias is set properly (0-1). You can however set other value depending on your needs. To see the results you'll need to set enableDepthBiasScale to true.
<syntaxhighlight lang="lua">bool exports.custom_billboards:setBillboardDepthBias(element billboardElement,float depthBiasValue)</syntaxhighlight>
===Required Arguments===
*'''element billboardElement:''' A previously declared billboard element.
*'''float depthBiasValue:''' depthBias value.
===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:''' RGBA color (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>

====enableDepthBiasScale====
<section name="Client" class="client" show="true">
Standard depthBias for GTASA coronas is about 1 unit, despite the corona scale. This function elables depthBias scaling.
<syntaxhighlight lang="lua">bool exports.custom_billboards:enableDepthBiasScale(bool isDepthScaleEnabled)</syntaxhighlight>
===Required Arguments===
*'''bool isDepthScaleEnabled:''' Enable/disable depthBias scaling.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

==Examples==
<syntaxhighlight lang="lua">local tex = dxCreateTexture("hello.jpg")
function addStuff()
for i=1,30 do
for j=1,30 do
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]

Resource:Custom coronas

2014-10-24T15:20:51Z

Renard712: /* enableDepthBiasScale */

{{Resource page}}
This resource lets You create some coronas. Not just your typical gtasa coronas
that often times fail to appear. Since in this case corona Elements are created using
dxDrawMaterialLine3d MTA function. I have changed the behaviour of the material
to act as cylindrical billboards do.

== Overview ==

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

The resource itself adds exported clientside functions:

==Exported functions==
====createCorona====
<section name="Client" class="client" show="true">
This function creates a shadered materialLine3d Corona.
<syntaxhighlight lang="lua">coronaElement exports.custom_coronas:createCorona(float posX,posY,posZ,size,int colorR,colorG,colorB,colorA,[bool isSoftParticle = false])</syntaxhighlight>
===Required Arguments===
*'''float posX, posY, posZ:''' Position in world space.
*'''float size:''' Size of the corona.
*'''int colorR,colorG,colorB,colorA:''' RGBA color (0 - 255).
===Optional Arguments===
*'''bool isSoftParticle:''' The aim with soft particles is to remove the ugly artifact that appears when the particle quad intersects the scene. The option requires DepthBuffer access.
===Returns===
The function returns coronaElement if set successfully, false otherwise.
</section>

====createMaterialCorona====
<section name="Client" class="client" show="true">
This function creates a shadered materialLine3d Corona with a custom material.
<syntaxhighlight lang="lua">coronaElement exports.custom_coronas:createMaterialCorona(element material,float posX,posY,posZ,size,int colorR,colorG,colorB,colorA,[bool isSoftParticle = false])</syntaxhighlight>
===Required Arguments===
*'''element material:''' Material to replace the standard corona texture with.
*'''float posX, posY, posZ:''' Position in world space.
*'''float size:''' Size of the corona.
*'''int colorR,colorG,colorB,colorA:''' RGBA color (0 - 255).
===Optional Arguments===
*'''bool isSoftParticle:''' The aim with soft particles is to remove the ugly artifact that appears when the particle quad intersects the scene. The option requires DepthBuffer access.
===Returns===
The function returns coronaElement if set successfully, false otherwise.
</section>

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

====setCoronaMaterial====
<section name="Client" class="client" show="true">
This function sets custom material for the corona.
<syntaxhighlight lang="lua">bool exports.custom_billboards:setCoronaMaterial(element coronaElement,element material)</syntaxhighlight>
===Required Arguments===
*'''element coronaElement:''' A previously declared corona element.
*'''element material:''' Material to replace the standard corona texture with.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

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

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

====setCoronaDepthBias====
<section name="Client" class="client" show="true">
On createCorona the depthBias is set properly (0-1). You can however set other value depending on your needs. To see the results you'll need to set enableDepthBiasScale to true.
<syntaxhighlight lang="lua">bool exports.custom_billboards:setCoronaDepthBias(element coronaElement,float depthBiasValue)</syntaxhighlight>
===Required Arguments===
*'''element coronaElement:''' A previously declared corona element.
*'''float depthBiasValue:''' Size of the corona.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

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

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

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

====enableDepthBiasScale====
<section name="Client" class="client" show="true">
Standard depthBias for GTASA coronas is about 1 unit, despite the corona scale. This function elables depthBias scaling.
<syntaxhighlight lang="lua">bool exports.custom_coronas:enableDepthBiasScale(bool isDepthScaleEnabled)</syntaxhighlight>
===Required Arguments===
*'''bool isDepthScaleEnabled:''' Enable/disable depthBias scaling.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

==Examples==
<syntaxhighlight lang="lua">function addStuff()
for i=1,30 do
for j=1,30 do
exports.custom_coronas:createCorona(i * 7,j * 7,10,4,math.random()*255,math.random()*255,math.random()*255,1*255,false)
end
end
end

addEventHandler("onClientResourceStart", getResourceRootElement( getThisResource()), addStuff)</syntaxhighlight>
This creates a 400 coronas 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 carLight = exports.custom_coronas:createCorona(0,0,0,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_coronas:setCoronaPosition(carLight,xxx1,yyy1,zzz1)
end
end
) </syntaxhighlight>
This creates a corona 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_coronas resource in meta.

==See Also==
[http://www.youtube.com/watch?v=5lruyY1fviQ A youtube video]

[http://community.multitheftauto.com/index.php?p=resources&s=details&id=9558 Custom Coronas resource on MTA Community]

[http://www.html5rocks.com/en/tutorials/webgl/webgl_orthographic_3d WebGL Orthographic 3D]

Resource:Custom coronas

2014-10-24T15:19:47Z

Renard712:

{{Resource page}}
This resource lets You create some coronas. Not just your typical gtasa coronas
that often times fail to appear. Since in this case corona Elements are created using
dxDrawMaterialLine3d MTA function. I have changed the behaviour of the material
to act as cylindrical billboards do.

== Overview ==

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

The resource itself adds exported clientside functions:

==Exported functions==
====createCorona====
<section name="Client" class="client" show="true">
This function creates a shadered materialLine3d Corona.
<syntaxhighlight lang="lua">coronaElement exports.custom_coronas:createCorona(float posX,posY,posZ,size,int colorR,colorG,colorB,colorA,[bool isSoftParticle = false])</syntaxhighlight>
===Required Arguments===
*'''float posX, posY, posZ:''' Position in world space.
*'''float size:''' Size of the corona.
*'''int colorR,colorG,colorB,colorA:''' RGBA color (0 - 255).
===Optional Arguments===
*'''bool isSoftParticle:''' The aim with soft particles is to remove the ugly artifact that appears when the particle quad intersects the scene. The option requires DepthBuffer access.
===Returns===
The function returns coronaElement if set successfully, false otherwise.
</section>

====createMaterialCorona====
<section name="Client" class="client" show="true">
This function creates a shadered materialLine3d Corona with a custom material.
<syntaxhighlight lang="lua">coronaElement exports.custom_coronas:createMaterialCorona(element material,float posX,posY,posZ,size,int colorR,colorG,colorB,colorA,[bool isSoftParticle = false])</syntaxhighlight>
===Required Arguments===
*'''element material:''' Material to replace the standard corona texture with.
*'''float posX, posY, posZ:''' Position in world space.
*'''float size:''' Size of the corona.
*'''int colorR,colorG,colorB,colorA:''' RGBA color (0 - 255).
===Optional Arguments===
*'''bool isSoftParticle:''' The aim with soft particles is to remove the ugly artifact that appears when the particle quad intersects the scene. The option requires DepthBuffer access.
===Returns===
The function returns coronaElement if set successfully, false otherwise.
</section>

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

====setCoronaMaterial====
<section name="Client" class="client" show="true">
This function sets custom material for the corona.
<syntaxhighlight lang="lua">bool exports.custom_billboards:setCoronaMaterial(element coronaElement,element material)</syntaxhighlight>
===Required Arguments===
*'''element coronaElement:''' A previously declared corona element.
*'''element material:''' Material to replace the standard corona texture with.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

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

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

====setCoronaDepthBias====
<section name="Client" class="client" show="true">
On createCorona the depthBias is set properly (0-1). You can however set other value depending on your needs. To see the results you'll need to set enableDepthBiasScale to true.
<syntaxhighlight lang="lua">bool exports.custom_billboards:setCoronaDepthBias(element coronaElement,float depthBiasValue)</syntaxhighlight>
===Required Arguments===
*'''element coronaElement:''' A previously declared corona element.
*'''float depthBiasValue:''' Size of the corona.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

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

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

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

====enableDepthBiasScale====
<section name="Client" class="client" show="true">
Standard depthBias for GTASA coronas is about 1 unit, despise the corona scale. This function elables depthBias scaling.
<syntaxhighlight lang="lua">bool exports.custom_coronas:enableDepthBiasScale(bool isDepthScaleEnabled)</syntaxhighlight>
===Required Arguments===
*'''bool isDepthScaleEnabled:''' Enable/disable depthBias scaling.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

==Examples==
<syntaxhighlight lang="lua">function addStuff()
for i=1,30 do
for j=1,30 do
exports.custom_coronas:createCorona(i * 7,j * 7,10,4,math.random()*255,math.random()*255,math.random()*255,1*255,false)
end
end
end

addEventHandler("onClientResourceStart", getResourceRootElement( getThisResource()), addStuff)</syntaxhighlight>
This creates a 400 coronas 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 carLight = exports.custom_coronas:createCorona(0,0,0,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_coronas:setCoronaPosition(carLight,xxx1,yyy1,zzz1)
end
end
) </syntaxhighlight>
This creates a corona 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_coronas resource in meta.

==See Also==
[http://www.youtube.com/watch?v=5lruyY1fviQ A youtube video]

[http://community.multitheftauto.com/index.php?p=resources&s=details&id=9558 Custom Coronas resource on MTA Community]

[http://www.html5rocks.com/en/tutorials/webgl/webgl_orthographic_3d WebGL Orthographic 3D]

Resource:Dynamic lighting

2014-09-28T21:08:21Z

Renard712:

{{Resource page}}
This resource lets You create dynamic lights in MTA. It gives you a list of exported functions that You can use to create per pixel pointlights and spotlights. It should be considered a preview of what [https://wiki.multitheftauto.com/wiki/MTA:Eir MTA:Eir] will offer. The future solution should be more FPS friendly. Yet i see that resource as an example of what the future holds.

== Overview ==

It is easy to use, gives a few options to create per pixel lights in gtasa.

The resource itself adds exported clientside functions:

==Exported functions==
====createPointLight====
<section name="Client" class="client" show="true">
This function creates a pixel shader pointlight.
<syntaxhighlight lang="lua">lightElement exports.dynamic_lighting:createPointLight(float posX,posY,posZ,colorR,colorG,colorB,colorA,attenuation,[bool normalShadow = true])</syntaxhighlight>
===Required Arguments===
*'''float posX, posY, posZ:''' Light position in world.
*'''float colorR,colorG,colorB,colorA:''' RGBA color emitted by the light (0 - 1 instead of 0-255).
*'''float attenuation:''' Value specifying how the light intensity changes over distance.
===Optional Arguments===
*'''bool normalShadow:''' Determine if the light source should be obscured when lighting a surface on opposite angles.
===Returns===
The function returns lightElement if set successfully, false otherwise.
</section>
====createSpotLight====
<section name="Client" class="client" show="true">
This function creates a pixel shader spotlight.
<syntaxhighlight lang="lua">lightElement exports.dynamic_lighting:createSpottLight(float posX,posY,posZ,colorR,colorG,colorB,colorA,dirX,dirY,dirZ, bool isEuler,float falloff,theta,phi,attenuation,[bool normalShadowing = true])</syntaxhighlight>
===Required Arguments===
*'''float posX, posY, posZ:''' Light position in world space.
*'''float colorR,colorG,colorB,colorA:''' RGBA color emitted by the light (0 - 1 instead of 0-255).
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
*'''bool isEuler:''' Is the angle set as an "ZXY" euler andgle or a vector.
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
*'''float falloff:''' Decrease in illumination between a spotlight's inner cone (the angle specified by Theta) and the outer edge of the outer cone (the angle specified by Phi).
*'''float theta: (radians)''' Angle, in radians, of a spotlight's inner cone - that is, the fully illuminated spotlight cone. This value must be in the range from 0 through the value specified by Phi.
*'''float phi: (radians)''' Angle, in radians, defining the outer edge of the spotlight's outer cone. Points outside this cone are not lit by the spotlight. This value must be between 0 and pi.
*'''float attenuation:''' Value specifying how the light intensity changes over distance.
===Optional Arguments===
*'''bool normalShadow:''' Determine if the light source should be obscured when lighting a surface on opposite angles.
===Returns===
The function returns lightElement if set successfully, false otherwise.
</section>

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

====setLightDirection====
<section name="Client" class="client" show="true">
This function setd light direction values for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightDirection(element lightElement,float dirX,dirY,dirZ,[bool isEuler = false])</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
===Optional Arguments===
*'''bool isEuler:'''Is the angle set as an "ZXY" euler andgle or a vector.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightPosition====
<section name="Client" class="client" show="true">
This function sets light position values for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightPosition(element lightElement,float posX,posY,posZ)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float posX, posY, posZ:''' Light position in world space.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightColor====
<section name="Client" class="client" show="true">
This function sets light color values for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightColor(element lightElement,float colorR,colorG,colorB,colorA)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float colorR,colorG,colorB,colorA:''' RGBA color emitted by the light (0 - 1 instead of 0-255).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightAttenuation====
<section name="Client" class="client" show="true">
This function sets setLightAttenuation value for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightAttenuation(element lightElement,float attenuation)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float attenuation:''' Value specifying how the light intensity changes over distance.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightFalloff====
<section name="Client" class="client" show="true">
This function sets falloff value for a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightFalloff(element lightElement,float falloff)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float falloff (radians):''' Decrease in illumination between a spotlight's inner cone (the angle specified by Theta) and the outer edge of the outer cone (the angle specified by Phi).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightTheta====
<section name="Client" class="client" show="true">
This function sets theta value for a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightTheta(element lightElement,float theta)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float theta (radians):''' Angle, in radians, of a spotlight's inner cone - that is, the fully illuminated spotlight cone. This value must be in the range from 0 through the value specified by Phi.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightPhi====
<section name="Client" class="client" show="true">
This function sets phi value for a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightPhi(element lightElement,float phi)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float phi (radians):''' Angle, in radians, defining the outer edge of the spotlight's outer cone. Points outside this cone are not lit by the spotlight. This value must be between 0 and pi.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightNormalShadowing====
<section name="Client" class="client" show="true">
Determine if the light source should be obscured when lighting a surface on opposite angles.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightNormalShadowing(element lightElement,bool normalShadow)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''bool normalShadow:''' Determine if the light source should be obscured when lighting a surface on opposite angles.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setNormalShadowingAmount====
<section name="Client" class="client" show="true">
Determine global shadowing value ( for all lights).
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setNormalShadowingAmount(element lightElement,float normalShadowAmmount)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float normalShadowAmmount:''' Determine global shadowing value (1-full 0-nil).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setGenerateBumpNormals====
<section name="Client" class="client" show="true">
Should the shader effect generate bump normals from texture0. Doesn't work when normal shadowing is set to false.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setGenerateBumpNormals(bool isTrue,[int textureSize = 512, float normalStrength.x = 1, float normalStrength.y = 1])</syntaxhighlight>
===Required Arguments===
*'''bool isTrue:''' Turn on or off bump mapping.
===Optional Arguments===
*'''int textureSize:''' The size of the input texture.
*'''float normalStrength.xy:''' How bumpy should the surface be ?
===Returns===
The function returns true if set successfully, false otherwise.
</section>

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

====setLightsEffectRange====
<section name="Client" class="client" show="true">
Set the Max distance from the camera the shader effects are applied to.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightsEffectRange(int maxEffectRange)</syntaxhighlight>
===Required Arguments===
*'''int maxEffectRange:''' If non-zero, the shaders will be applied to textures nearer than maxDistance only.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderForcedOn====
<section name="Client" class="client" show="true">
Should the shader effect turn off when no lightsources.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderForcedOn(bool isShaderForcedOn)</syntaxhighlight>
===Required Arguments===
*'''bool isShaderForcedOn:''' Should the shader effect turn off when no lightsources.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderTimeOut====
<section name="Client" class="client" show="true">
Should the shader effect turn off after number of seconds (when no lightsources)
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderTimeOut(int timeOut)</syntaxhighlight>
===Required Arguments===
*'''int timeOut:''' Should the shader effect turn off after number of seconds (when no lightsources)
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderNightMod====
<section name="Client" class="client" show="true">
Enable nightMod effect - requires proper manipulation of setTextureBrightness and SetShaderDayTime, also some additional shaders.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderNightMod(bool enable)</syntaxhighlight>
===Required Arguments===
*'''bool enable:''' Enable or disable nightMod effect
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderDayTime====
<section name="Client" class="client" show="true">
Another additional variable to control texture colors - requires setShaderNightMod(true)
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderDayTime(float dayTime)</syntaxhighlight>
===Required Arguments===
*'''float dayTime:''' Another additional variable to control texture colors - requires setShaderNightMod(true) set 1 as default
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderPedDiffuse====
<section name="Client" class="client" show="true">
Enable or disable gta directional lights for ped.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderPedDiffuse(bool enable)</syntaxhighlight>
===Required Arguments===
*'''bool enable:''' Enable or disable gta directional lights for ped (enabled as default)
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setDirLightEnable====
<section name="Client" class="client" show="true">
This function creates a vertex shader directional light. NOTE: Forcing the effects on or using any other lights is required for directional light to work.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setDirLightEnable(bool enable = false)</syntaxhighlight>
===Required Arguments===
*'''bool enable:''' Enable or disable the directional light.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setDirLightDirection====
<section name="Client" class="client" show="true">
This function sets the directional light direction.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setDirLightDirection(float dirX,dirY,dirZ,[bool isEuler = false])</syntaxhighlight>
===Required Arguments===
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
===Optional Arguments===
*'''bool isEuler:'''Is the angle set as an "ZXY" euler andgle or a vector.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setDirLightColor====
<section name="Client" class="client" show="true">
This function sets the directional light color value.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setDirLightColor(float colorR,colorG,colorB,colorA)</syntaxhighlight>
===Required Arguments===
*'''float colorR,colorG,colorB,colorA:''' RGBA color emitted by the light (0 - 1 instead of 0-255).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

==Examples==
<syntaxhighlight lang="lua">exports.dynamic_lighting:createPointLight(0,0,5,1,0,0,1,15)</syntaxhighlight>
This creates a red pointlight in world position (0,0,5)

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

==See Also==
[http://community.multitheftauto.com/index.php?p=resources&s=details&id=9398 Dynamic Lighting resource on MTA Community]

[http://msdn.microsoft.com/en-us/library/windows/desktop/bb174697%28v=vs.85%29.aspx Light Types (Direct3D 9)]

[http://www.youtube.com/watch?v=2t_bje_XjUY Vehicle lights video]

Resource:Custom coronas

2014-09-28T21:06:33Z

Renard712:

{{Resource page}}
This resource lets You create some coronas. Not just your typical gtasa coronas
that often times fail to appear. Since in this case corona Elements are created using
dxDrawMaterialLine3d MTA function. I have changed the behaviour of the material
to act as cylindrical billboards do.

== Overview ==

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

The resource itself adds exported clientside functions:

==Exported functions==
====createCorona====
<section name="Client" class="client" show="true">
This function creates a shadered materialLine3d Corona.
<syntaxhighlight lang="lua">coronaElement exports.custom_coronas:createCorona(float posX,posY,posZ,size,int colorR,colorG,colorB,colorA,[bool isSoftParticle = false])</syntaxhighlight>
===Required Arguments===
*'''float posX, posY, posZ:''' Position in world space.
*'''float size:''' Size of the corona.
*'''int colorR,colorG,colorB,colorA:''' RGBA color (0 - 255).
===Optional Arguments===
*'''bool isSoftParticle:''' The aim with soft particles is to remove the ugly artifact that appears when the particle quad intersects the scene. The option requires DepthBuffer access.
===Returns===
The function returns coronaElement if set successfully, false otherwise.
</section>

====createMaterialCorona====
<section name="Client" class="client" show="true">
This function creates a shadered materialLine3d Corona with a custom material.
<syntaxhighlight lang="lua">coronaElement exports.custom_coronas:createMaterialCorona(element material,float posX,posY,posZ,size,int colorR,colorG,colorB,colorA,[bool isSoftParticle = false])</syntaxhighlight>
===Required Arguments===
*'''element material:''' Material to replace the standard corona texture with.
*'''float posX, posY, posZ:''' Position in world space.
*'''float size:''' Size of the corona.
*'''int colorR,colorG,colorB,colorA:''' RGBA color (0 - 255).
===Optional Arguments===
*'''bool isSoftParticle:''' The aim with soft particles is to remove the ugly artifact that appears when the particle quad intersects the scene. The option requires DepthBuffer access.
===Returns===
The function returns coronaElement if set successfully, false otherwise.
</section>

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

====setCoronaMaterial====
<section name="Client" class="client" show="true">
This function sets custom material for the corona.
<syntaxhighlight lang="lua">bool exports.custom_billboards:setCoronaMaterial(element coronaElement,element material)</syntaxhighlight>
===Required Arguments===
*'''element coronaElement:''' A previously declared corona element.
*'''element material:''' Material to replace the standard corona texture with.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

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

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

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

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

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

==Examples==
<syntaxhighlight lang="lua">function addStuff()
for i=1,30 do
for j=1,30 do
exports.custom_coronas:createCorona(i * 7,j * 7,10,4,math.random()*255,math.random()*255,math.random()*255,1*255,false)
end
end
end

addEventHandler("onClientResourceStart", getResourceRootElement( getThisResource()), addStuff)</syntaxhighlight>
This creates a 400 coronas 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 carLight = exports.custom_coronas:createCorona(0,0,0,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_coronas:setCoronaPosition(carLight,xxx1,yyy1,zzz1)
end
end
) </syntaxhighlight>
This creates a corona 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_coronas resource in meta.

==See Also==
[http://www.youtube.com/watch?v=5lruyY1fviQ A youtube video]

[http://community.multitheftauto.com/index.php?p=resources&s=details&id=9558 Custom Coronas resource on MTA Community]

[http://www.html5rocks.com/en/tutorials/webgl/webgl_orthographic_3d WebGL Orthographic 3D]

Resource:Custom billboards

2014-09-28T21:04:57Z

Renard712:

{{Resource page}}
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.
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">billboardElement 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:''' RGBA color (0 - 255).
===Returns===
The function returns billboardElement 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 size.
<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:''' RGBA color (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 tex = dxCreateTexture("hello.jpg")
function addStuff()
for i=1,30 do
for j=1,30 do
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]

Resource:Dynamic lighting

2014-09-27T10:58:33Z

Renard712:

{{Resource page}}
This resource lets You create dynamic lights in MTA. It gives you a list of exported functions that You can use to create per pixel pointlights and spotlights. It should be considered a preview of what [https://wiki.multitheftauto.com/wiki/MTA:Eir MTA:Eir] will offer. The future solution should be more FPS friendly. Yet i see that resource as an example of what the future holds.

== Overview ==

It is easy to use, gives a few options to create per pixel lights in gtasa.

The resource itself adds exported clientside functions:

==Exported functions==
====createPointLight====
<section name="Client" class="client" show="true">
This function creates a pixel shader pointlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:createPointLight(float posX,posY,posZ,colorR,colorG,colorB,colorA,attenuation,[bool normalShadow = true])</syntaxhighlight>
===Required Arguments===
*'''float posX, posY, posZ:''' Light position in world.
*'''float colorR,colorG,colorB,colorA:''' RGBA color emitted by the light (0 - 1 instead of 0-255).
*'''float attenuation:''' Value specifying how the light intensity changes over distance.
===Optional Arguments===
*'''bool normalShadow:''' Determine if the light source should be obscured when lighting a surface on opposite angles.
===Returns===
The function returns true if set successfully, false otherwise.
</section>
====createSpotLight====
<section name="Client" class="client" show="true">
This function creates a pixel shader spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:createSpottLight(float posX,posY,posZ,colorR,colorG,colorB,colorA,dirX,dirY,dirZ, bool isEuler,float falloff,theta,phi,attenuation,[bool normalShadowing = true])</syntaxhighlight>
===Required Arguments===
*'''float posX, posY, posZ:''' Light position in world space.
*'''float colorR,colorG,colorB,colorA:''' RGBA color emitted by the light (0 - 1 instead of 0-255).
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
*'''bool isEuler:''' Is the angle set as an "ZXY" euler andgle or a vector.
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
*'''float falloff:''' Decrease in illumination between a spotlight's inner cone (the angle specified by Theta) and the outer edge of the outer cone (the angle specified by Phi).
*'''float theta: (radians)''' Angle, in radians, of a spotlight's inner cone - that is, the fully illuminated spotlight cone. This value must be in the range from 0 through the value specified by Phi.
*'''float phi: (radians)''' Angle, in radians, defining the outer edge of the spotlight's outer cone. Points outside this cone are not lit by the spotlight. This value must be between 0 and pi.
*'''float attenuation:''' Value specifying how the light intensity changes over distance.
===Optional Arguments===
*'''bool normalShadow:''' Determine if the light source should be obscured when lighting a surface on opposite angles.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

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

====setLightDirection====
<section name="Client" class="client" show="true">
This function setd light direction values for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightDirection(element lightElement,float dirX,dirY,dirZ,[bool isEuler = false])</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
===Optional Arguments===
*'''bool isEuler:'''Is the angle set as an "ZXY" euler andgle or a vector.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightPosition====
<section name="Client" class="client" show="true">
This function sets light position values for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightPosition(element lightElement,float posX,posY,posZ)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float posX, posY, posZ:''' Light position in world space.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightColor====
<section name="Client" class="client" show="true">
This function sets light color values for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightColor(element lightElement,float colorR,colorG,colorB,colorA)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float colorR,colorG,colorB,colorA:''' RGBA color emitted by the light (0 - 1 instead of 0-255).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightAttenuation====
<section name="Client" class="client" show="true">
This function sets setLightAttenuation value for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightAttenuation(element lightElement,float attenuation)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float attenuation:''' Value specifying how the light intensity changes over distance.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightFalloff====
<section name="Client" class="client" show="true">
This function sets falloff value for a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightFalloff(element lightElement,float falloff)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float falloff (radians):''' Decrease in illumination between a spotlight's inner cone (the angle specified by Theta) and the outer edge of the outer cone (the angle specified by Phi).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightTheta====
<section name="Client" class="client" show="true">
This function sets theta value for a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightTheta(element lightElement,float theta)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float theta (radians):''' Angle, in radians, of a spotlight's inner cone - that is, the fully illuminated spotlight cone. This value must be in the range from 0 through the value specified by Phi.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightPhi====
<section name="Client" class="client" show="true">
This function sets phi value for a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightPhi(element lightElement,float phi)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float phi (radians):''' Angle, in radians, defining the outer edge of the spotlight's outer cone. Points outside this cone are not lit by the spotlight. This value must be between 0 and pi.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightNormalShadowing====
<section name="Client" class="client" show="true">
Determine if the light source should be obscured when lighting a surface on opposite angles.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightNormalShadowing(element lightElement,bool normalShadow)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''bool normalShadow:''' Determine if the light source should be obscured when lighting a surface on opposite angles.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setNormalShadowingAmount====
<section name="Client" class="client" show="true">
Determine global shadowing value ( for all lights).
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setNormalShadowingAmount(element lightElement,float normalShadowAmmount)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float normalShadowAmmount:''' Determine global shadowing value (1-full 0-nil).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setGenerateBumpNormals====
<section name="Client" class="client" show="true">
Should the shader effect generate bump normals from texture0. Doesn't work when normal shadowing is set to false.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setGenerateBumpNormals(bool isTrue,[int textureSize = 512, float normalStrength.x = 1, float normalStrength.y = 1])</syntaxhighlight>
===Required Arguments===
*'''bool isTrue:''' Turn on or off bump mapping.
===Optional Arguments===
*'''int textureSize:''' The size of the input texture.
*'''float normalStrength.xy:''' How bumpy should the surface be ?
===Returns===
The function returns true if set successfully, false otherwise.
</section>

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

====setLightsEffectRange====
<section name="Client" class="client" show="true">
Set the Max distance from the camera the shader effects are applied to.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightsEffectRange(int maxEffectRange)</syntaxhighlight>
===Required Arguments===
*'''int maxEffectRange:''' If non-zero, the shaders will be applied to textures nearer than maxDistance only.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderForcedOn====
<section name="Client" class="client" show="true">
Should the shader effect turn off when no lightsources.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderForcedOn(bool isShaderForcedOn)</syntaxhighlight>
===Required Arguments===
*'''bool isShaderForcedOn:''' Should the shader effect turn off when no lightsources.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderTimeOut====
<section name="Client" class="client" show="true">
Should the shader effect turn off after number of seconds (when no lightsources)
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderTimeOut(int timeOut)</syntaxhighlight>
===Required Arguments===
*'''int timeOut:''' Should the shader effect turn off after number of seconds (when no lightsources)
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderNightMod====
<section name="Client" class="client" show="true">
Enable nightMod effect - requires proper manipulation of setTextureBrightness and SetShaderDayTime, also some additional shaders.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderNightMod(bool enable)</syntaxhighlight>
===Required Arguments===
*'''bool enable:''' Enable or disable nightMod effect
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderDayTime====
<section name="Client" class="client" show="true">
Another additional variable to control texture colors - requires setShaderNightMod(true)
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderDayTime(float dayTime)</syntaxhighlight>
===Required Arguments===
*'''float dayTime:''' Another additional variable to control texture colors - requires setShaderNightMod(true) set 1 as default
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderPedDiffuse====
<section name="Client" class="client" show="true">
Enable or disable gta directional lights for ped.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderPedDiffuse(bool enable)</syntaxhighlight>
===Required Arguments===
*'''bool enable:''' Enable or disable gta directional lights for ped (enabled as default)
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setDirLightEnable====
<section name="Client" class="client" show="true">
This function creates a vertex shader directional light. NOTE: Forcing the effects on or using any other lights is required for directional light to work.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setDirLightEnable(bool enable = false)</syntaxhighlight>
===Required Arguments===
*'''bool enable:''' Enable or disable the directional light.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setDirLightDirection====
<section name="Client" class="client" show="true">
This function sets the directional light direction.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setDirLightDirection(float dirX,dirY,dirZ,[bool isEuler = false])</syntaxhighlight>
===Required Arguments===
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
===Optional Arguments===
*'''bool isEuler:'''Is the angle set as an "ZXY" euler andgle or a vector.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setDirLightColor====
<section name="Client" class="client" show="true">
This function sets the directional light color value.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setDirLightColor(float colorR,colorG,colorB,colorA)</syntaxhighlight>
===Required Arguments===
*'''float colorR,colorG,colorB,colorA:''' RGBA color emitted by the light (0 - 1 instead of 0-255).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

==Examples==
<syntaxhighlight lang="lua">exports.dynamic_lighting:createPointLight(0,0,5,1,0,0,1,15)</syntaxhighlight>
This creates a red pointlight in world position (0,0,5)

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

==See Also==
[http://community.multitheftauto.com/index.php?p=resources&s=details&id=9398 Dynamic Lighting resource on MTA Community]

[http://msdn.microsoft.com/en-us/library/windows/desktop/bb174697%28v=vs.85%29.aspx Light Types (Direct3D 9)]

[http://www.youtube.com/watch?v=2t_bje_XjUY Vehicle lights video]

Resource:Custom coronas

2014-09-27T10:54:27Z

Renard712:

{{Resource page}}
This resource lets You create some coronas. Not just your typical gtasa coronas
that often times fail to appear. Since in this case corona Elements are created using
dxDrawMaterialLine3d MTA function. I have changed the behaviour of the material
to act as cylindrical billboards do.

== Overview ==

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

The resource itself adds exported clientside functions:

==Exported functions==
====createCorona====
<section name="Client" class="client" show="true">
This function creates a shadered materialLine3d Corona.
<syntaxhighlight lang="lua">bool exports.custom_coronas:createCorona(float posX,posY,posZ,size,int colorR,colorG,colorB,colorA,[bool isSoftParticle = false])</syntaxhighlight>
===Required Arguments===
*'''float posX, posY, posZ:''' Position in world space.
*'''float size:''' Size of the corona.
*'''int colorR,colorG,colorB,colorA:''' RGBA color (0 - 255).
===Optional Arguments===
*'''bool isSoftParticle:''' The aim with soft particles is to remove the ugly artifact that appears when the particle quad intersects the scene. The option requires DepthBuffer access.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====createMaterialCorona====
<section name="Client" class="client" show="true">
This function creates a shadered materialLine3d Corona with a custom material.
<syntaxhighlight lang="lua">bool exports.custom_coronas:createMaterialCorona(element material,float posX,posY,posZ,size,int colorR,colorG,colorB,colorA,[bool isSoftParticle = false])</syntaxhighlight>
===Required Arguments===
*'''element material:''' Material to replace the standard corona texture with.
*'''float posX, posY, posZ:''' Position in world space.
*'''float size:''' Size of the corona.
*'''int colorR,colorG,colorB,colorA:''' RGBA color (0 - 255).
===Optional Arguments===
*'''bool isSoftParticle:''' The aim with soft particles is to remove the ugly artifact that appears when the particle quad intersects the scene. The option requires DepthBuffer access.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

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

====setCoronaMaterial====
<section name="Client" class="client" show="true">
This function sets custom material for the corona.
<syntaxhighlight lang="lua">bool exports.custom_billboards:setCoronaMaterial(element coronaElement,element material)</syntaxhighlight>
===Required Arguments===
*'''element coronaElement:''' A previously declared corona element.
*'''element material:''' Material to replace the standard corona texture with.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

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

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

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

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

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

==Examples==
<syntaxhighlight lang="lua">function addStuff()
for i=1,30 do
for j=1,30 do
exports.custom_coronas:createCorona(i * 7,j * 7,10,4,math.random()*255,math.random()*255,math.random()*255,1*255,false)
end
end
end

addEventHandler("onClientResourceStart", getResourceRootElement( getThisResource()), addStuff)</syntaxhighlight>
This creates a 400 coronas 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 carLight = exports.custom_coronas:createCorona(0,0,0,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_coronas:setCoronaPosition(carLight,xxx1,yyy1,zzz1)
end
end
) </syntaxhighlight>
This creates a corona 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_coronas resource in meta.

==See Also==
[http://www.youtube.com/watch?v=5lruyY1fviQ A youtube video]

[http://community.multitheftauto.com/index.php?p=resources&s=details&id=9558 Custom Coronas resource on MTA Community]

[http://www.html5rocks.com/en/tutorials/webgl/webgl_orthographic_3d WebGL Orthographic 3D]

Resource:Custom billboards

2014-09-27T10:51:45Z

Renard712:

{{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:''' RGBA color (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 size.
<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:''' RGBA color (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 tex = dxCreateTexture("hello.jpg")
function addStuff()
for i=1,30 do
for j=1,30 do
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]

Resource:Custom billboards

2014-09-27T10:50:51Z

Renard712:

{{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:''' RGBA color (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:''' RGBA color (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 tex = dxCreateTexture("hello.jpg")
function addStuff()
for i=1,30 do
for j=1,30 do
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]

Resource:Blur box

2014-09-27T10:31:47Z

Renard712:

{{Resource page}}
This resource lets You create simple gaussian blur boxes onClientRender.
Using that - You can make your game GUI a bit more fancy.

== Overview ==

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

The resource itself adds exported clientside functions:

==Exported functions==
====createBlurBox====
<section name="Client" class="client" show="true">
This function creates a blur box.
<syntaxhighlight lang="lua">bool exports.blur_box:createBlurBox(float posX,posY,sizeX,sizeY,int colorR,colorG,colorB,colorA,postGUI)</syntaxhighlight>
===Required Arguments===
*'''float posX, posY:''' Position in screen space.
*'''float sizeX, sizeY:''' Size of the box.
*'''int colorR,colorG,colorB,colorA:''' RGBA color (0 - 255).
*'''bool postGUI:''' Should the box be drawn before or after MTA GUI elements.
===Returns===
The function returns the element if set successfully, 'false' otherwise.
</section>

====destroyBlurBox====
<section name="Client" class="client" show="true">
This function destroys a blur box element.
<syntaxhighlight lang="lua">bool exports.blur_box:destroyBlurBox(element blurBoxElement)</syntaxhighlight>
===Required Arguments===
*'''element blurBoxElement:''' A previously declared blur box element.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setBlurBoxEnabled====
<section name="Client" class="client" show="true">
This function enables or disables a created blur box element.
<syntaxhighlight lang="lua">bool exports.blur_box:setBlurBoxEnabled(element blurBoxElement, bool isEnabled)</syntaxhighlight>
===Required Arguments===
*'''element blurBoxElement:''' A previously declared blur box element.
*'''bool isEnabled:''' Enable/Disable the blur box element.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setBlurBoxPosition====
<section name="Client" class="client" show="true">
This function sets blur box position.
<syntaxhighlight lang="lua">bool exports.blur_box:setBlurBoxPosition(element blurBoxElement,float posX,posY)</syntaxhighlight>
===Required Arguments===
*'''element blurBoxElement:''' A previously declared blur box element.
*'''float posX, posY:''' Position in screen space.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

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

====setBlurBoxColor====
<section name="Client" class="client" show="true">
This function sets blur box color values.
<syntaxhighlight lang="lua">bool exports.blur_box:setBlurBoxColor(element billboardElement,float colorR,colorG,colorB,colorA)</syntaxhighlight>
===Required Arguments===
*'''element blurBoxElement:''' A previously declared blur box element.
*'''float colorR,colorG,colorB,colorA:''' RGBA color (0 - 255).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setBlurIntensity====
<section name="Client" class="client" show="true">
This function sets blur amount for all the blur boxes
<syntaxhighlight lang="lua">bool exports.blur_box:setBlurIntensity(float blurFactor)</syntaxhighlight>
===Required Arguments===
*'''float blurFactor:''' Set blur amount for all the blur boxes. (default 0.6)
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setScreenResolutionMultiplier====
<section name="Client" class="client" show="true">
This function sets screen relative resolution multiplier for the screenSource
<syntaxhighlight lang="lua">bool exports.blur_box:setScreenResolutionMultiplier(element blurBoxElement, float x,y)</syntaxhighlight>
===Required Arguments===
*'''element blurBoxElement:''' A previously declared blurBox element.
*'''float x,y:''' Set sampled screen relative resolution multiplier (0-1)
===Returns===
The function returns true if set successfully, false otherwise.
</section>

==Examples==
<syntaxhighlight lang="lua">local scx, scy = guiGetScreenSize()
local guiWindowElement = nil
local blurBoxElement = nil

addEventHandler( "onClientRender", root,
function()
if guiWindowElement and blurBoxElement then
local xPos, yPos = guiGetPosition ( guiWindowElement , false )
local xSize, ySize = guiGetSize ( guiWindowElement , false )
exports.blur_box:setBlurBoxPosition( blurBoxElement, xPos, yPos )
exports.blur_box:setBlurBoxSize( blurBoxElement, xSize, ySize )
end
end
,true ,"high-3" )

addEventHandler( "onClientResourceStart", getResourceRootElement( getThisResource()),
function()
guiWindowElement = guiCreateWindow ( scx/2-scy/4, scy/2 - scy/4, scy/2, scy/2, "BlurBox test", false )
guiWindowSetMovable ( guiWindowElement, true )
guiWindowSetSizable ( guiWindowElement, true )
guiSetAlpha ( guiWindowElement, 0.3 )
blurBoxElement = exports.blur_box:createBlurBox( scx/2-scy/4, scy/2 - scy/4, scy/2, scy/2, 255, 255, 255, 255, false )
--exports.blur_box:setBlurBoxColor( blurBoxElement, 255, 100, 100, 255)
exports.blur_box:setScreenResolutionMultiplier( 0.5, 0.5 )
end
)

addEventHandler( "onClientResourceStop", getResourceRootElement( getThisResource()),
function()
destroyElement( guiWindowElement )
blurBoxElement = not exports.blur_box:destroyBlurBox( blurBoxElement )
end
)
</syntaxhighlight>
This creates a blur box and attaches it to a created window element.

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

==See Also==

[http://community.multitheftauto.com/index.php?p=resources&s=details&id=10163 Community resource]

[http://www.solidfiles.com/d/f45a107b42/blurBox_test.zip Test resource]

Resource:Blur box

2014-09-27T10:30:07Z

Renard712: Created page with "{{Resource page}} This resource lets You create simple gaussian blur boxes onClientHUDRender. Using that - You can make your game GUI a bit more fancy. == Overview == It is ..."

{{Resource page}}
This resource lets You create simple gaussian blur boxes onClientHUDRender.
Using that - You can make your game GUI a bit more fancy.

== Overview ==

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

The resource itself adds exported clientside functions:

==Exported functions==
====createBlurBox====
<section name="Client" class="client" show="true">
This function creates a blur box.
<syntaxhighlight lang="lua">bool exports.blur_box:createBlurBox(float posX,posY,sizeX,sizeY,int colorR,colorG,colorB,colorA,postGUI)</syntaxhighlight>
===Required Arguments===
*'''float posX, posY:''' Position in screen space.
*'''float sizeX, sizeY:''' Size of the box.
*'''int colorR,colorG,colorB,colorA:''' RGBA color (0 - 255).
*'''bool postGUI:''' Should the box be drawn before or after MTA GUI elements.
===Returns===
The function returns the element if set successfully, 'false' otherwise.
</section>

====destroyBlurBox====
<section name="Client" class="client" show="true">
This function destroys a blur box element.
<syntaxhighlight lang="lua">bool exports.blur_box:destroyBlurBox(element blurBoxElement)</syntaxhighlight>
===Required Arguments===
*'''element blurBoxElement:''' A previously declared blur box element.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setBlurBoxEnabled====
<section name="Client" class="client" show="true">
This function enables or disables a created blur box element.
<syntaxhighlight lang="lua">bool exports.blur_box:setBlurBoxEnabled(element blurBoxElement, bool isEnabled)</syntaxhighlight>
===Required Arguments===
*'''element blurBoxElement:''' A previously declared blur box element.
*'''bool isEnabled:''' Enable/Disable the blur box element.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setBlurBoxPosition====
<section name="Client" class="client" show="true">
This function sets blur box position.
<syntaxhighlight lang="lua">bool exports.blur_box:setBlurBoxPosition(element blurBoxElement,float posX,posY)</syntaxhighlight>
===Required Arguments===
*'''element blurBoxElement:''' A previously declared blur box element.
*'''float posX, posY:''' Position in screen space.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

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

====setBlurBoxColor====
<section name="Client" class="client" show="true">
This function sets blur box color values.
<syntaxhighlight lang="lua">bool exports.blur_box:setBlurBoxColor(element billboardElement,float colorR,colorG,colorB,colorA)</syntaxhighlight>
===Required Arguments===
*'''element blurBoxElement:''' A previously declared blur box element.
*'''float colorR,colorG,colorB,colorA:''' RGBA color (0 - 255).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setBlurIntensity====
<section name="Client" class="client" show="true">
This function sets blur amount for all the blur boxes
<syntaxhighlight lang="lua">bool exports.blur_box:setBlurIntensity(float blurFactor)</syntaxhighlight>
===Required Arguments===
*'''float blurFactor:''' Set blur amount for all the blur boxes. (default 0.6)
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setScreenResolutionMultiplier====
<section name="Client" class="client" show="true">
This function sets screen relative resolution multiplier for the screenSource
<syntaxhighlight lang="lua">bool exports.blur_box:setScreenResolutionMultiplier(element blurBoxElement, float x,y)</syntaxhighlight>
===Required Arguments===
*'''element blurBoxElement:''' A previously declared blurBox element.
*'''float x,y:''' Set sampled screen relative resolution multiplier (0-1)
===Returns===
The function returns true if set successfully, false otherwise.
</section>

==Examples==
<syntaxhighlight lang="lua">local scx, scy = guiGetScreenSize()
local guiWindowElement = nil
local blurBoxElement = nil

addEventHandler( "onClientRender", root,
function()
if guiWindowElement and blurBoxElement then
local xPos, yPos = guiGetPosition ( guiWindowElement , false )
local xSize, ySize = guiGetSize ( guiWindowElement , false )
exports.blur_box:setBlurBoxPosition( blurBoxElement, xPos, yPos )
exports.blur_box:setBlurBoxSize( blurBoxElement, xSize, ySize )
end
end
,true ,"high-3" )

addEventHandler( "onClientResourceStart", getResourceRootElement( getThisResource()),
function()
guiWindowElement = guiCreateWindow ( scx/2-scy/4, scy/2 - scy/4, scy/2, scy/2, "BlurBox test", false )
guiWindowSetMovable ( guiWindowElement, true )
guiWindowSetSizable ( guiWindowElement, true )
guiSetAlpha ( guiWindowElement, 0.3 )
blurBoxElement = exports.blur_box:createBlurBox( scx/2-scy/4, scy/2 - scy/4, scy/2, scy/2, 255, 255, 255, 255, false )
--exports.blur_box:setBlurBoxColor( blurBoxElement, 255, 100, 100, 255)
exports.blur_box:setScreenResolutionMultiplier( 0.5, 0.5 )
end
)

addEventHandler( "onClientResourceStop", getResourceRootElement( getThisResource()),
function()
destroyElement( guiWindowElement )
blurBoxElement = not exports.blur_box:destroyBlurBox( blurBoxElement )
end
)
</syntaxhighlight>
This creates a blur box and attaches it to a created window element.

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

==See Also==

[http://community.multitheftauto.com/index.php?p=resources&s=details&id=10163 Community resource]

[http://www.solidfiles.com/d/f45a107b42/blurBox_test.zip Test resource]

Resource:Custom billboards

2014-09-24T23:54:43Z

Renard712:

{{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]

Resource:Custom billboards

2014-09-24T23:52:43Z

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..."

{{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]

Resource:Custom coronas

2014-09-12T10:28:33Z

Renard712:

{{Resource page}}
This resource lets You create some coronas. Not just your typical gtasa coronas
that often times fail to appear. Since in this case corona Elements are created using
dxDrawMaterialLine3d MTA function. I have changed the behaviour of the material
to act as cylindrical billboards do.

== Overview ==

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

The resource itself adds exported clientside functions:

==Exported functions==
====createCorona====
<section name="Client" class="client" show="true">
This function creates a shadered materialLine3d Corona.
<syntaxhighlight lang="lua">bool exports.custom_coronas:createCorona(float posX,posY,posZ,size,int colorR,colorG,colorB,colorA,[bool isSoftParticle = false])</syntaxhighlight>
===Required Arguments===
*'''float posX, posY, posZ:''' Position in world space.
*'''float size:''' Size of the corona.
*'''int colorR,colorG,colorB,colorA:''' Corona RGBA color emitted by the corona (0 - 255).
===Optional Arguments===
*'''bool isSoftParticle:''' The aim with soft particles is to remove the ugly artifact that appears when the particle quad intersects the scene. The option requires DepthBuffer access.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====createMaterialCorona====
<section name="Client" class="client" show="true">
This function creates a shadered materialLine3d Corona with a custom material.
<syntaxhighlight lang="lua">bool exports.custom_coronas:createMaterialCorona(element material,float posX,posY,posZ,size,int colorR,colorG,colorB,colorA,[bool isSoftParticle = false])</syntaxhighlight>
===Required Arguments===
*'''element material:''' Material to replace the standard corona texture with.
*'''float posX, posY, posZ:''' Position in world space.
*'''float size:''' Size of the corona.
*'''int colorR,colorG,colorB,colorA:''' Corona RGBA color emitted by the corona (0 - 255).
===Optional Arguments===
*'''bool isSoftParticle:''' The aim with soft particles is to remove the ugly artifact that appears when the particle quad intersects the scene. The option requires DepthBuffer access.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

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

====setCoronaMaterial====
<section name="Client" class="client" show="true">
This function sets custom material for the corona.
<syntaxhighlight lang="lua">bool exports.custom_billboards:setCoronaMaterial(element coronaElement,element material)</syntaxhighlight>
===Required Arguments===
*'''element coronaElement:''' A previously declared corona element.
*'''element material:''' Material to replace the standard corona texture with.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

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

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

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

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

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

==Examples==
<syntaxhighlight lang="lua">local corTable = {}

function addStuff()
for i=1,30 do
for j=1,30 do
corTable[i] = exports.custom_coronas:createCorona(i * 7,j * 7,10,4,math.random()*255,math.random()*255,math.random()*255,1*255,false)
end
end
end

addEventHandler("onClientResourceStart", getResourceRootElement( getThisResource()), addStuff)</syntaxhighlight>
This creates a 400 coronas 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 carLight = exports.custom_coronas:createCorona(0,0,0,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_coronas:setCoronaPosition(carLight,xxx1,yyy1,zzz1)
end
end
) </syntaxhighlight>
This creates a corona 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_coronas resource in meta.

==See Also==
[http://www.youtube.com/watch?v=5lruyY1fviQ A youtube video]

[http://community.multitheftauto.com/index.php?p=resources&s=details&id=9558 Custom Coronas resource on MTA Community]

[http://www.html5rocks.com/en/tutorials/webgl/webgl_orthographic_3d WebGL Orthographic 3D]

Resource:Custom coronas

2014-09-11T21:16:39Z

Renard712:

{{Resource page}}
This resource lets You create some coronas. Not just your typical gtasa coronas
that often times fail to appear. Since in this case corona Elements are created using
dxDrawMaterialLine3d MTA function. I have changed the behaviour of the material
to act as cylindrical billboards do.

== Overview ==

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

The resource itself adds exported clientside functions:

==Exported functions==
====createCorona====
<section name="Client" class="client" show="true">
This function creates a shadered materialLine3d Corona.
<syntaxhighlight lang="lua">bool exports.custom_coronas:createCorona(float posX,posY,posZ,size,int colorR,colorG,colorB,colorA,[bool isSoftParticle = false])</syntaxhighlight>
===Required Arguments===
*'''float posX, posY, posZ:''' Position in world space.
*'''float size:''' Size of the corona.
*'''int colorR,colorG,colorB,colorA:''' Corona RGBA color emitted by the corona (0 - 255).
===Optional Arguments===
*'''bool isSoftParticle:''' The aim with soft particles is to remove the ugly artifact that appears when the particle quad intersects the scene. The option requires DepthBuffer access.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====createMaterialCorona====
<section name="Client" class="client" show="true">
This function creates a shadered materialLine3d Corona with a custom material.
<syntaxhighlight lang="lua">bool exports.custom_coronas:createMaterialCorona(element material,float posX,posY,posZ,size,int colorR,colorG,colorB,colorA,[bool isSoftParticle = false])</syntaxhighlight>
===Required Arguments===
*'''element material:''' Material to replace the standard corona texture with.
*'''float posX, posY, posZ:''' Position in world space.
*'''float size:''' Size of the corona.
*'''int colorR,colorG,colorB,colorA:''' Corona RGBA color emitted by the corona (0 - 255).
===Optional Arguments===
*'''bool isSoftParticle:''' The aim with soft particles is to remove the ugly artifact that appears when the particle quad intersects the scene. The option requires DepthBuffer access.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

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

====setCoronaMaterial====
<section name="Client" class="client" show="true">
This function sets custom material for the corona.
<syntaxhighlight lang="lua">bool exports.custom_billboards:setCoronaMaterial(element coronaElement,element material)</syntaxhighlight>
===Required Arguments===
*'''element coronaElement:''' A previously declared corona element.
*'''element material:''' Material to replace the standard corona texture with.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

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

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

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

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

==Examples==
<syntaxhighlight lang="lua">local corTable = {}

function addStuff()
for i=1,30 do
for j=1,30 do
corTable[i] = exports.custom_coronas:createCorona(i * 7,j * 7,10,4,math.random()*255,math.random()*255,math.random()*255,1*255,false)
end
end
end

addEventHandler("onClientResourceStart", getResourceRootElement( getThisResource()), addStuff)</syntaxhighlight>
This creates a 400 coronas 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 carLight = exports.custom_coronas:createCorona(0,0,0,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_coronas:setCoronaPosition(carLight,xxx1,yyy1,zzz1)
end
end
) </syntaxhighlight>
This creates a corona 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_coronas resource in meta.

==See Also==
[http://www.youtube.com/watch?v=5lruyY1fviQ A youtube video]

[http://community.multitheftauto.com/index.php?p=resources&s=details&id=9558 Custom Coronas resource on MTA Community]

[http://www.html5rocks.com/en/tutorials/webgl/webgl_orthographic_3d WebGL Orthographic 3D]

Resource:Custom coronas

2014-09-11T13:23:15Z

Renard712:

Resource:Dynamic lighting

2014-08-16T11:23:27Z

Renard712: /* setDirLightEnable */

{{Resource page}}
This resource lets You create dynamic lights in MTA. It gives you a list of exported functions that You can use to create per pixel pointlights and spotlights. It should be considered a preview of what [https://wiki.multitheftauto.com/wiki/MTA:Eir MTA:Eir] will offer. The future solution should be more FPS friendly. Yet i see that resource as an example of what the future holds.

== Overview ==

It is easy to use, gives a few options to create per pixel lights in gtasa.

The resource itself adds exported clientside functions:

==Exported functions==
====createPointLight====
<section name="Client" class="client" show="true">
This function creates a pixel shader pointlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:createPointLight(float posX,posY,posZ,colorR,colorG,colorB,colorA,attenuation,[bool normalShadow = true])</syntaxhighlight>
===Required Arguments===
*'''float posX, posY, posZ:''' Light position in world.
*'''float colorR,colorG,colorB,colorA:''' Light RGBA color emitted by the light (0 - 1 instead of 0-255).
*'''float attenuation:''' Value specifying how the light intensity changes over distance.
===Optional Arguments===
*'''bool normalShadow:''' Determine if the light source should be obscured when lighting a surface on opposite angles.
===Returns===
The function returns true if set successfully, false otherwise.
</section>
====createSpotLight====
<section name="Client" class="client" show="true">
This function creates a pixel shader spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:createSpottLight(float posX,posY,posZ,colorR,colorG,colorB,colorA,dirX,dirY,dirZ, bool isEuler,float falloff,theta,phi,attenuation,[bool normalShadowing = true])</syntaxhighlight>
===Required Arguments===
*'''float posX, posY, posZ:''' Light position in world space.
*'''float colorR,colorG,colorB,colorA:''' Light RGBA color emitted by the light (0 - 1 instead of 0-255).
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
*'''bool isEuler:''' Is the angle set as an "ZXY" euler andgle or a vector.
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
*'''float falloff:''' Decrease in illumination between a spotlight's inner cone (the angle specified by Theta) and the outer edge of the outer cone (the angle specified by Phi).
*'''float theta: (radians)''' Angle, in radians, of a spotlight's inner cone - that is, the fully illuminated spotlight cone. This value must be in the range from 0 through the value specified by Phi.
*'''float phi: (radians)''' Angle, in radians, defining the outer edge of the spotlight's outer cone. Points outside this cone are not lit by the spotlight. This value must be between 0 and pi.
*'''float attenuation:''' Value specifying how the light intensity changes over distance.
===Optional Arguments===
*'''bool normalShadow:''' Determine if the light source should be obscured when lighting a surface on opposite angles.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

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

====setLightDirection====
<section name="Client" class="client" show="true">
This function setd light direction values for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightDirection(element lightElement,float dirX,dirY,dirZ,[bool isEuler = false])</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
===Optional Arguments===
*'''bool isEuler:'''Is the angle set as an "ZXY" euler andgle or a vector.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightPosition====
<section name="Client" class="client" show="true">
This function sets light position values for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightPosition(element lightElement,float posX,posY,posZ)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float posX, posY, posZ:''' Light position in world space.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightColor====
<section name="Client" class="client" show="true">
This function sets light color values for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightColor(element lightElement,float colorR,colorG,colorB,colorA)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float colorR,colorG,colorB,colorA:''' Light RGBA color emitted by the light (0 - 1 instead of 0-255).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightAttenuation====
<section name="Client" class="client" show="true">
This function sets setLightAttenuation value for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightAttenuation(element lightElement,float attenuation)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float attenuation:''' Value specifying how the light intensity changes over distance.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightFalloff====
<section name="Client" class="client" show="true">
This function sets falloff value for a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightFalloff(element lightElement,float falloff)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float falloff (radians):''' Decrease in illumination between a spotlight's inner cone (the angle specified by Theta) and the outer edge of the outer cone (the angle specified by Phi).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightTheta====
<section name="Client" class="client" show="true">
This function sets theta value for a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightTheta(element lightElement,float theta)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float theta (radians):''' Angle, in radians, of a spotlight's inner cone - that is, the fully illuminated spotlight cone. This value must be in the range from 0 through the value specified by Phi.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightPhi====
<section name="Client" class="client" show="true">
This function sets phi value for a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightPhi(element lightElement,float phi)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float phi (radians):''' Angle, in radians, defining the outer edge of the spotlight's outer cone. Points outside this cone are not lit by the spotlight. This value must be between 0 and pi.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightNormalShadowing====
<section name="Client" class="client" show="true">
Determine if the light source should be obscured when lighting a surface on opposite angles.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightNormalShadowing(element lightElement,bool normalShadow)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''bool normalShadow:''' Determine if the light source should be obscured when lighting a surface on opposite angles.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setNormalShadowingAmount====
<section name="Client" class="client" show="true">
Determine global shadowing value ( for all lights).
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setNormalShadowingAmount(element lightElement,float normalShadowAmmount)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float normalShadowAmmount:''' Determine global shadowing value (1-full 0-nil).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setGenerateBumpNormals====
<section name="Client" class="client" show="true">
Should the shader effect generate bump normals from texture0. Doesn't work when normal shadowing is set to false.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setGenerateBumpNormals(bool isTrue,[int textureSize = 512, float normalStrength.x = 1, float normalStrength.y = 1])</syntaxhighlight>
===Required Arguments===
*'''bool isTrue:''' Turn on or off bump mapping.
===Optional Arguments===
*'''int textureSize:''' The size of the input texture.
*'''float normalStrength.xy:''' How bumpy should the surface be ?
===Returns===
The function returns true if set successfully, false otherwise.
</section>

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

====setLightsEffectRange====
<section name="Client" class="client" show="true">
Set the Max distance from the camera the shader effects are applied to.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightsEffectRange(int maxEffectRange)</syntaxhighlight>
===Required Arguments===
*'''int maxEffectRange:''' If non-zero, the shaders will be applied to textures nearer than maxDistance only.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderForcedOn====
<section name="Client" class="client" show="true">
Should the shader effect turn off when no lightsources.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderForcedOn(bool isShaderForcedOn)</syntaxhighlight>
===Required Arguments===
*'''bool isShaderForcedOn:''' Should the shader effect turn off when no lightsources.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderTimeOut====
<section name="Client" class="client" show="true">
Should the shader effect turn off after number of seconds (when no lightsources)
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderTimeOut(int timeOut)</syntaxhighlight>
===Required Arguments===
*'''int timeOut:''' Should the shader effect turn off after number of seconds (when no lightsources)
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderNightMod====
<section name="Client" class="client" show="true">
Enable nightMod effect - requires proper manipulation of setTextureBrightness and SetShaderDayTime, also some additional shaders.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderNightMod(bool enable)</syntaxhighlight>
===Required Arguments===
*'''bool enable:''' Enable or disable nightMod effect
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderDayTime====
<section name="Client" class="client" show="true">
Another additional variable to control texture colors - requires setShaderNightMod(true)
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderDayTime(float dayTime)</syntaxhighlight>
===Required Arguments===
*'''float dayTime:''' Another additional variable to control texture colors - requires setShaderNightMod(true) set 1 as default
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderPedDiffuse====
<section name="Client" class="client" show="true">
Enable or disable gta directional lights for ped.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderPedDiffuse(bool enable)</syntaxhighlight>
===Required Arguments===
*'''bool enable:''' Enable or disable gta directional lights for ped (enabled as default)
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setDirLightEnable====
<section name="Client" class="client" show="true">
This function creates a vertex shader directional light. NOTE: Forcing the effects on or using any other lights is required for directional light to work.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setDirLightEnable(bool enable = false)</syntaxhighlight>
===Required Arguments===
*'''bool enable:''' Enable or disable the directional light.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setDirLightDirection====
<section name="Client" class="client" show="true">
This function sets the directional light direction.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setDirLightDirection(float dirX,dirY,dirZ,[bool isEuler = false])</syntaxhighlight>
===Required Arguments===
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
===Optional Arguments===
*'''bool isEuler:'''Is the angle set as an "ZXY" euler andgle or a vector.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setDirLightColor====
<section name="Client" class="client" show="true">
This function sets the directional light color value.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setDirLightColor(float colorR,colorG,colorB,colorA)</syntaxhighlight>
===Required Arguments===
*'''float colorR,colorG,colorB,colorA:''' Light RGBA color emitted by the light (0 - 1 instead of 0-255).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

==Examples==
<syntaxhighlight lang="lua">exports.dynamic_lighting:createPointLight(0,0,5,1,0,0,1,15)</syntaxhighlight>
This creates a red pointlight in world position (0,0,5)

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

==See Also==
[http://community.multitheftauto.com/index.php?p=resources&s=details&id=9398 Dynamic Lighting resource on MTA Community]

[http://msdn.microsoft.com/en-us/library/windows/desktop/bb174697%28v=vs.85%29.aspx Light Types (Direct3D 9)]

[http://www.youtube.com/watch?v=2t_bje_XjUY Vehicle lights video]

Resource:Dynamic lighting

2014-08-15T18:53:42Z

Renard712:

{{Resource page}}
This resource lets You create dynamic lights in MTA. It gives you a list of exported functions that You can use to create per pixel pointlights and spotlights. It should be considered a preview of what [https://wiki.multitheftauto.com/wiki/MTA:Eir MTA:Eir] will offer. The future solution should be more FPS friendly. Yet i see that resource as an example of what the future holds.

== Overview ==

It is easy to use, gives a few options to create per pixel lights in gtasa.

The resource itself adds exported clientside functions:

==Exported functions==
====createPointLight====
<section name="Client" class="client" show="true">
This function creates a pixel shader pointlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:createPointLight(float posX,posY,posZ,colorR,colorG,colorB,colorA,attenuation,[bool normalShadow = true])</syntaxhighlight>
===Required Arguments===
*'''float posX, posY, posZ:''' Light position in world.
*'''float colorR,colorG,colorB,colorA:''' Light RGBA color emitted by the light (0 - 1 instead of 0-255).
*'''float attenuation:''' Value specifying how the light intensity changes over distance.
===Optional Arguments===
*'''bool normalShadow:''' Determine if the light source should be obscured when lighting a surface on opposite angles.
===Returns===
The function returns true if set successfully, false otherwise.
</section>
====createSpotLight====
<section name="Client" class="client" show="true">
This function creates a pixel shader spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:createSpottLight(float posX,posY,posZ,colorR,colorG,colorB,colorA,dirX,dirY,dirZ, bool isEuler,float falloff,theta,phi,attenuation,[bool normalShadowing = true])</syntaxhighlight>
===Required Arguments===
*'''float posX, posY, posZ:''' Light position in world space.
*'''float colorR,colorG,colorB,colorA:''' Light RGBA color emitted by the light (0 - 1 instead of 0-255).
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
*'''bool isEuler:''' Is the angle set as an "ZXY" euler andgle or a vector.
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
*'''float falloff:''' Decrease in illumination between a spotlight's inner cone (the angle specified by Theta) and the outer edge of the outer cone (the angle specified by Phi).
*'''float theta: (radians)''' Angle, in radians, of a spotlight's inner cone - that is, the fully illuminated spotlight cone. This value must be in the range from 0 through the value specified by Phi.
*'''float phi: (radians)''' Angle, in radians, defining the outer edge of the spotlight's outer cone. Points outside this cone are not lit by the spotlight. This value must be between 0 and pi.
*'''float attenuation:''' Value specifying how the light intensity changes over distance.
===Optional Arguments===
*'''bool normalShadow:''' Determine if the light source should be obscured when lighting a surface on opposite angles.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

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

====setLightDirection====
<section name="Client" class="client" show="true">
This function setd light direction values for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightDirection(element lightElement,float dirX,dirY,dirZ,[bool isEuler = false])</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
===Optional Arguments===
*'''bool isEuler:'''Is the angle set as an "ZXY" euler andgle or a vector.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightPosition====
<section name="Client" class="client" show="true">
This function sets light position values for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightPosition(element lightElement,float posX,posY,posZ)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float posX, posY, posZ:''' Light position in world space.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightColor====
<section name="Client" class="client" show="true">
This function sets light color values for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightColor(element lightElement,float colorR,colorG,colorB,colorA)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float colorR,colorG,colorB,colorA:''' Light RGBA color emitted by the light (0 - 1 instead of 0-255).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightAttenuation====
<section name="Client" class="client" show="true">
This function sets setLightAttenuation value for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightAttenuation(element lightElement,float attenuation)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float attenuation:''' Value specifying how the light intensity changes over distance.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightFalloff====
<section name="Client" class="client" show="true">
This function sets falloff value for a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightFalloff(element lightElement,float falloff)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float falloff (radians):''' Decrease in illumination between a spotlight's inner cone (the angle specified by Theta) and the outer edge of the outer cone (the angle specified by Phi).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightTheta====
<section name="Client" class="client" show="true">
This function sets theta value for a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightTheta(element lightElement,float theta)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float theta (radians):''' Angle, in radians, of a spotlight's inner cone - that is, the fully illuminated spotlight cone. This value must be in the range from 0 through the value specified by Phi.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightPhi====
<section name="Client" class="client" show="true">
This function sets phi value for a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightPhi(element lightElement,float phi)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float phi (radians):''' Angle, in radians, defining the outer edge of the spotlight's outer cone. Points outside this cone are not lit by the spotlight. This value must be between 0 and pi.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightNormalShadowing====
<section name="Client" class="client" show="true">
Determine if the light source should be obscured when lighting a surface on opposite angles.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightNormalShadowing(element lightElement,bool normalShadow)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''bool normalShadow:''' Determine if the light source should be obscured when lighting a surface on opposite angles.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setNormalShadowingAmount====
<section name="Client" class="client" show="true">
Determine global shadowing value ( for all lights).
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setNormalShadowingAmount(element lightElement,float normalShadowAmmount)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float normalShadowAmmount:''' Determine global shadowing value (1-full 0-nil).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setGenerateBumpNormals====
<section name="Client" class="client" show="true">
Should the shader effect generate bump normals from texture0. Doesn't work when normal shadowing is set to false.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setGenerateBumpNormals(bool isTrue,[int textureSize = 512, float normalStrength.x = 1, float normalStrength.y = 1])</syntaxhighlight>
===Required Arguments===
*'''bool isTrue:''' Turn on or off bump mapping.
===Optional Arguments===
*'''int textureSize:''' The size of the input texture.
*'''float normalStrength.xy:''' How bumpy should the surface be ?
===Returns===
The function returns true if set successfully, false otherwise.
</section>

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

====setLightsEffectRange====
<section name="Client" class="client" show="true">
Set the Max distance from the camera the shader effects are applied to.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightsEffectRange(int maxEffectRange)</syntaxhighlight>
===Required Arguments===
*'''int maxEffectRange:''' If non-zero, the shaders will be applied to textures nearer than maxDistance only.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderForcedOn====
<section name="Client" class="client" show="true">
Should the shader effect turn off when no lightsources.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderForcedOn(bool isShaderForcedOn)</syntaxhighlight>
===Required Arguments===
*'''bool isShaderForcedOn:''' Should the shader effect turn off when no lightsources.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderTimeOut====
<section name="Client" class="client" show="true">
Should the shader effect turn off after number of seconds (when no lightsources)
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderTimeOut(int timeOut)</syntaxhighlight>
===Required Arguments===
*'''int timeOut:''' Should the shader effect turn off after number of seconds (when no lightsources)
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderNightMod====
<section name="Client" class="client" show="true">
Enable nightMod effect - requires proper manipulation of setTextureBrightness and SetShaderDayTime, also some additional shaders.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderNightMod(bool enable)</syntaxhighlight>
===Required Arguments===
*'''bool enable:''' Enable or disable nightMod effect
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderDayTime====
<section name="Client" class="client" show="true">
Another additional variable to control texture colors - requires setShaderNightMod(true)
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderDayTime(float dayTime)</syntaxhighlight>
===Required Arguments===
*'''float dayTime:''' Another additional variable to control texture colors - requires setShaderNightMod(true) set 1 as default
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderPedDiffuse====
<section name="Client" class="client" show="true">
Enable or disable gta directional lights for ped.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderPedDiffuse(bool enable)</syntaxhighlight>
===Required Arguments===
*'''bool enable:''' Enable or disable gta directional lights for ped (enabled as default)
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setDirLightEnable====
<section name="Client" class="client" show="true">
This function creates a vertex shader directional light.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setDirLightEnable(bool enable = false)</syntaxhighlight>
===Required Arguments===
*'''bool enable:''' Enable or disable the directional light.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setDirLightDirection====
<section name="Client" class="client" show="true">
This function sets the directional light direction.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setDirLightDirection(float dirX,dirY,dirZ,[bool isEuler = false])</syntaxhighlight>
===Required Arguments===
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
===Optional Arguments===
*'''bool isEuler:'''Is the angle set as an "ZXY" euler andgle or a vector.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setDirLightColor====
<section name="Client" class="client" show="true">
This function sets the directional light color value.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setDirLightColor(float colorR,colorG,colorB,colorA)</syntaxhighlight>
===Required Arguments===
*'''float colorR,colorG,colorB,colorA:''' Light RGBA color emitted by the light (0 - 1 instead of 0-255).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

==Examples==
<syntaxhighlight lang="lua">exports.dynamic_lighting:createPointLight(0,0,5,1,0,0,1,15)</syntaxhighlight>
This creates a red pointlight in world position (0,0,5)

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

==See Also==
[http://community.multitheftauto.com/index.php?p=resources&s=details&id=9398 Dynamic Lighting resource on MTA Community]

[http://msdn.microsoft.com/en-us/library/windows/desktop/bb174697%28v=vs.85%29.aspx Light Types (Direct3D 9)]

[http://www.youtube.com/watch?v=2t_bje_XjUY Vehicle lights video]

Resource:ShaderPedNormal

2014-07-06T01:44:29Z

Renard712: /* Examples */

{{Resource page}}
This is a normal map resource for MTA. It enables normal mapping effect for peds. Also adds sun and moon light to make gtasa lighting a bit more interesting. It is compatible with the peds created to work with normalmap plugin for gtasa.

== Overview ==

You'll have to extract normals from the txd file and apply them with the applyNormalToPedTexture function.

This test resource should present a better explanation. [http://www.solidfiles.com/d/be237103ee/ Download here] Choose (!SKIN ID 7!) after starting.

The resource itself adds exported clientside functions:

==Exported functions==
====applyNormalToPedTexture====
<section name="Client" class="client" show="true">
This function applies the normal mapping effect to ped textures.
<syntaxhighlight lang="lua">bool exports.shaderPedNormal:applyNormalToPedTexture( table filepath strings )</syntaxhighlight>
===Required Arguments===
*'''filepath strings:''' The table of filepaths to apply. Those should be paths for the normals extracted from the txd archive.
===Returns===
The function returns true if set successfully, false otherwise.
</section>
====removeNormalFromPedTexture====
<section name="Client" class="client" show="true">
This function removes the normal mapping effect from ped textures.
<syntaxhighlight lang="lua">bool exports.shaderPedNormal:removeNormalFromPedTexture( table filepath strings )</syntaxhighlight>
===Required Arguments===
*'''filepath strings:''' The table of previously applied normals to be disabled.
===Returns===
The function returns true if set successfully, false otherwise.
</section>
====applySpecularToGTAPeds====
<section name="Client" class="client" show="true">
This function applies a custom specular lighting effect to ped by ID.
<syntaxhighlight lang="lua">bool exports.shaderPedNormal:applySpecularToGTAPeds(table ped model id table,bool sobel)</syntaxhighlight>
===Optional Arguments===
*'''ped model id table:''' The ped model id table If left blank the effect is applied to all standard ped textures.
*'''sobel:''' The second argument generates normals based on original textures if set true. Sobel filter works only when your graphics card supports shader model 3.
===Returns===
The function returns true if set successfully, false otherwise.
</section>
====removeSpecularFromGTAPeds====
<section name="Client" class="client" show="true">
This function removes custom specular lighting effect from ped by ID.
<syntaxhighlight lang="lua">bool exports.shaderPedNormal:removeSpecularFromGTAPeds(table ped model ids)</syntaxhighlight>
===Optional Arguments===
*'''ped model ids:''' the ped model id table If left blank the effect is removed from all ped textures.
===Returns===
The function returns true if set successfully, false otherwise.
</section>
==Examples==
<syntaxhighlight lang="lua">local resourceName = ":"..getResourceName(getThisResource()).."/"
exports.shaderPedNormal:applyNormalToPedTexture({resourceName.."normals/face_nrm1.0.png",resourceName.."normals/skin_nrm1.0.png"})</syntaxhighlight>
This applies normal map effect to textures "face" and "skin". Notice that the nrm textures should be placed in the resource the function is being called from.

<syntaxhighlight lang="lua">exports.shaderPedNormal:applySpecularToGTAPeds({0,7,121},false)</syntaxhighlight>
This applies the specular effect to peds by id 0,7,121

<syntaxhighlight lang="lua">exports.shaderPedNormal:removeSpecularFromGTAPeds()</syntaxhighlight>
removes the specular effect from all the peds.

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

==See Also==
[https://community.multitheftauto.com/index.php?p=resources&s=details&id=7665 Resource page on community.mtasa]

Resource:ShaderPedNormal

2014-07-06T01:19:42Z

Renard712: /* Examples */

{{Resource page}}
This is a normal map resource for MTA. It enables normal mapping effect for peds. Also adds sun and moon light to make gtasa lighting a bit more interesting. It is compatible with the peds created to work with normalmap plugin for gtasa.

== Overview ==

You'll have to extract normals from the txd file and apply them with the applyNormalToPedTexture function.

This test resource should present a better explanation. [http://www.solidfiles.com/d/be237103ee/ Download here] Choose (!SKIN ID 7!) after starting.

The resource itself adds exported clientside functions:

==Exported functions==
====applyNormalToPedTexture====
<section name="Client" class="client" show="true">
This function applies the normal mapping effect to ped textures.
<syntaxhighlight lang="lua">bool exports.shaderPedNormal:applyNormalToPedTexture( table filepath strings )</syntaxhighlight>
===Required Arguments===
*'''filepath strings:''' The table of filepaths to apply. Those should be paths for the normals extracted from the txd archive.
===Returns===
The function returns true if set successfully, false otherwise.
</section>
====removeNormalFromPedTexture====
<section name="Client" class="client" show="true">
This function removes the normal mapping effect from ped textures.
<syntaxhighlight lang="lua">bool exports.shaderPedNormal:removeNormalFromPedTexture( table filepath strings )</syntaxhighlight>
===Required Arguments===
*'''filepath strings:''' The table of previously applied normals to be disabled.
===Returns===
The function returns true if set successfully, false otherwise.
</section>
====applySpecularToGTAPeds====
<section name="Client" class="client" show="true">
This function applies a custom specular lighting effect to ped by ID.
<syntaxhighlight lang="lua">bool exports.shaderPedNormal:applySpecularToGTAPeds(table ped model id table,bool sobel)</syntaxhighlight>
===Optional Arguments===
*'''ped model id table:''' The ped model id table If left blank the effect is applied to all standard ped textures.
*'''sobel:''' The second argument generates normals based on original textures if set true. Sobel filter works only when your graphics card supports shader model 3.
===Returns===
The function returns true if set successfully, false otherwise.
</section>
====removeSpecularFromGTAPeds====
<section name="Client" class="client" show="true">
This function removes custom specular lighting effect from ped by ID.
<syntaxhighlight lang="lua">bool exports.shaderPedNormal:removeSpecularFromGTAPeds(table ped model ids)</syntaxhighlight>
===Optional Arguments===
*'''ped model ids:''' the ped model id table If left blank the effect is removed from all ped textures.
===Returns===
The function returns true if set successfully, false otherwise.
</section>
==Examples==
<syntaxhighlight lang="lua">local resourceName = ":"..getResourceName(currentResource).."/"
exports.shaderPedNormal:applyNormalToPedTexture({resourceName.."normals/face_nrm1.0.png",resourceName.."normals/skin_nrm1.0.png"})</syntaxhighlight>
This applies normal map effect to textures "face" and "skin". Notice that the nrm textures should be placed in the resource the function is being called from.

<syntaxhighlight lang="lua">exports.shaderPedNormal:applySpecularToGTAPeds({0,7,121},false)</syntaxhighlight>
This applies the specular effect to peds by id 0,7,121

<syntaxhighlight lang="lua">exports.shaderPedNormal:removeSpecularFromGTAPeds()</syntaxhighlight>
removes the specular effect from all the peds.

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

==See Also==
[https://community.multitheftauto.com/index.php?p=resources&s=details&id=7665 Resource page on community.mtasa]

Resource:Custom coronas

2014-07-05T10:50:45Z

Renard712: /* createCorona */

Resource:Custom coronas

2014-07-05T03:30:45Z

Renard712: /* Examples */

Resource:Dynamic lighting

2014-07-05T03:26:16Z

Renard712:

{{Resource page}}
This resource lets You create dynamic lights in MTA. It gives you a list of exported functions that You can use to create per pixel pointlights and spotlights. It should be considered a preview of what [https://wiki.multitheftauto.com/wiki/MTA:Eir MTA:Eir] will offer. The future solution should be more FPS friendly. Yet i see that resource as an example of what the future holds.

== Overview ==

It is easy to use, gives a few options to create per pixel lights in gtasa.

The resource itself adds exported clientside functions:

==Exported functions==
====createPointLight====
<section name="Client" class="client" show="true">
This function creates a pixel shader pointlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:createPointLight(float posX,posY,posZ,colorR,colorG,colorB,colorA,attenuation,[bool normalShadow = true])</syntaxhighlight>
===Required Arguments===
*'''float posX, posY, posZ:''' Light position in world.
*'''float colorR,colorG,colorB,colorA:''' Light RGBA color emitted by the light (0 - 1 instead of 0-255).
*'''float attenuation:''' Value specifying how the light intensity changes over distance.
===Optional Arguments===
*'''bool normalShadow:''' Determine if the light source should be obscured when lighting a surface on opposite angles.
===Returns===
The function returns true if set successfully, false otherwise.
</section>
====createSpotLight====
<section name="Client" class="client" show="true">
This function creates a pixel shader spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:createSpottLight(float posX,posY,posZ,colorR,colorG,colorB,colorA,dirX,dirY,dirZ, bool isEuler,float falloff,theta,phi,attenuation,[bool normalShadowing = true])</syntaxhighlight>
===Required Arguments===
*'''float posX, posY, posZ:''' Light position in world space.
*'''float colorR,colorG,colorB,colorA:''' Light RGBA color emitted by the light (0 - 1 instead of 0-255).
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
*'''bool isEuler:''' Is the angle set as an "ZXY" euler andgle or a vector.
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
*'''float falloff:''' Decrease in illumination between a spotlight's inner cone (the angle specified by Theta) and the outer edge of the outer cone (the angle specified by Phi).
*'''float theta: (radians)''' Angle, in radians, of a spotlight's inner cone - that is, the fully illuminated spotlight cone. This value must be in the range from 0 through the value specified by Phi.
*'''float phi: (radians)''' Angle, in radians, defining the outer edge of the spotlight's outer cone. Points outside this cone are not lit by the spotlight. This value must be between 0 and pi.
*'''float attenuation:''' Value specifying how the light intensity changes over distance.
===Optional Arguments===
*'''bool normalShadow:''' Determine if the light source should be obscured when lighting a surface on opposite angles.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

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

====setLightDirection====
<section name="Client" class="client" show="true">
This function destroys a light element.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightDirection(element lightElement,float dirX,dirY,dirZ,[bool isEuler = false])</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
===Optional Arguments===
*'''bool isEuler:'''Is the angle set as an "ZXY" euler andgle or a vector.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightPosition====
<section name="Client" class="client" show="true">
This function sets light position value for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightPosition(element lightElement,float posX,posY,posZ)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float posX, posY, posZ:''' Light position in world space.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightColor====
<section name="Client" class="client" show="true">
This function sets light color value for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightColor(element lightElement,float colorR,colorG,colorB,colorA)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float colorR,colorG,colorB,colorA:''' Light RGBA color emitted by the light (0 - 1 instead of 0-255).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightAttenuation====
<section name="Client" class="client" show="true">
This function sets setLightAttenuation value for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightAttenuation(element lightElement,float attenuation)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float attenuation:''' Value specifying how the light intensity changes over distance.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightFalloff====
<section name="Client" class="client" show="true">
This function sets falloff value for a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightFalloff(element lightElement,float falloff)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float falloff (radians):''' Decrease in illumination between a spotlight's inner cone (the angle specified by Theta) and the outer edge of the outer cone (the angle specified by Phi).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightTheta====
<section name="Client" class="client" show="true">
This function sets theta value for a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightTheta(element lightElement,float theta)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float theta (radians):''' Angle, in radians, of a spotlight's inner cone - that is, the fully illuminated spotlight cone. This value must be in the range from 0 through the value specified by Phi.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightPhi====
<section name="Client" class="client" show="true">
This function sets phi value for a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightPhi(element lightElement,float phi)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float phi (radians):''' Angle, in radians, defining the outer edge of the spotlight's outer cone. Points outside this cone are not lit by the spotlight. This value must be between 0 and pi.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightNormalShadowing====
<section name="Client" class="client" show="true">
Determine if the light source should be obscured when lighting a surface on opposite angles.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightNormalShadowing(element lightElement,bool normalShadow)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''bool normalShadow:''' Determine if the light source should be obscured when lighting a surface on opposite angles.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setNormalShadowingAmount====
<section name="Client" class="client" show="true">
Determine global shadowing value ( for all lights).
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setNormalShadowingAmount(element lightElement,float normalShadowAmmount)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declared light element.
*'''float normalShadowAmmount:''' Determine global shadowing value (1-full 0-nil).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setGenerateBumpNormals====
<section name="Client" class="client" show="true">
Should the shader effect generate bump normals from texture0. Doesn't work when normal shadowing is set to false.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setGenerateBumpNormals(bool isTrue,[int textureSize = 512, float normalStrength.x = 1, float normalStrength.y = 1])</syntaxhighlight>
===Required Arguments===
*'''bool isTrue:''' Turn on or off bump mapping.
===Optional Arguments===
*'''int textureSize:''' The size of the input texture.
*'''float normalStrength.xy:''' How bumpy should the surface be ?
===Returns===
The function returns true if set successfully, false otherwise.
</section>

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

====setLightsEffectRange====
<section name="Client" class="client" show="true">
Set the Max distance from the camera the shader effects are applied to.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightsEffectRange(int maxEffectRange)</syntaxhighlight>
===Required Arguments===
*'''int maxEffectRange:''' If non-zero, the shaders will be applied to textures nearer than maxDistance only.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderForcedOn====
<section name="Client" class="client" show="true">
Should the shader effect turn off when no lightsources.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderForcedOn(bool isShaderForcedOn)</syntaxhighlight>
===Required Arguments===
*'''bool isShaderForcedOn:''' Should the shader effect turn off when no lightsources.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderTimeOut====
<section name="Client" class="client" show="true">
Should the shader effect turn off after number of seconds (when no lightsources)
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderTimeOut(int timeOut)</syntaxhighlight>
===Required Arguments===
*'''int timeOut:''' Should the shader effect turn off after number of seconds (when no lightsources)
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderNightMod====
<section name="Client" class="client" show="true">
Enable nightMod effect - requires proper manipulation of setTextureBrightness and SetShaderDayTime, also some additional shaders.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderNightMod(bool enable)</syntaxhighlight>
===Required Arguments===
*'''bool enable:''' Enable or disable nightMod effect
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderDayTime====
<section name="Client" class="client" show="true">
Another additional variable to control texture colors - requires setShaderNightMod(true)
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderDayTime(float dayTime)</syntaxhighlight>
===Required Arguments===
*'''float dayTime:''' Another additional variable to control texture colors - requires setShaderNightMod(true) set 1 as default
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderPedDiffuse====
<section name="Client" class="client" show="true">
Enable or disable gta directional lights for ped.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderPedDiffuse(bool enable)</syntaxhighlight>
===Required Arguments===
*'''bool enable:''' Enable or disable gta directional lights for ped (enabled as default)
===Returns===
The function returns true if set successfully, false otherwise.
</section>

==Examples==
<syntaxhighlight lang="lua">exports.dynamic_lighting:createPointLight(0,0,5,1,0,0,1,15)</syntaxhighlight>
This creates a red pointlight in world position (0,0,5)

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

==See Also==
[http://community.multitheftauto.com/index.php?p=resources&s=details&id=9398 Dynamic Lighting resource on MTA Community]

[http://msdn.microsoft.com/en-us/library/windows/desktop/bb174697%28v=vs.85%29.aspx Light Types (Direct3D 9)]

[http://www.youtube.com/watch?v=2t_bje_XjUY Vehicle lights video]

Resource:Custom coronas

2014-07-02T17:48:25Z

Renard712:

Resource:Custom coronas

2014-07-02T17:44:25Z

Renard712:

Resource:Custom coronas

2014-07-02T17:39:50Z

Renard712:

Resource:Dynamic lighting

2014-07-02T16:12:37Z

Renard712:

{{Resource page}}
This resource lets You create dynamic lights in MTA. It gives you a list of exported functions that You can use to create per pixel pointlights and spotlights. It should be considered a preview of what [https://wiki.multitheftauto.com/wiki/MTA:Eir MTA:Eir] will offer. The future solution should be more FPS friendly. Yet i see that resource as an example of what the future holds.

== Overview ==

It is easy to use, gives a few options to create per pixel lights in gtasa.

The resource itself adds exported clientside functions:

==Exported functions==
====createPointLight====
<section name="Client" class="client" show="true">
This function creates a pixel shader pointlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:createPointLight(float posX,posY,posZ,colorR,colorG,colorB,colorA,attenuation,[bool normalShadow = true])</syntaxhighlight>
===Required Arguments===
*'''float posX, posY, posZ:''' Light position in world.
*'''float colorR,colorG,colorB,colorA:''' Light RGBA color emitted by the light (0 - 1 instead of 0-255).
*'''float attenuation:''' Value specifying how the light intensity changes over distance.
===Optional Arguments===
*'''bool normalShadow:''' Determine if the light source should be obscured when lighting a surface on opposite angles.
===Returns===
The function returns true if set successfully, false otherwise.
</section>
====createSpotLight====
<section name="Client" class="client" show="true">
This function creates a pixel shader spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:createSpottLight(float posX,posY,posZ,colorR,colorG,colorB,colorA,dirX,dirY,dirZ, bool isEuler,float falloff,theta,phi,attenuation,[bool normalShadowing = true])</syntaxhighlight>
===Required Arguments===
*'''float posX, posY, posZ:''' Light position in world space.
*'''float colorR,colorG,colorB,colorA:''' Light RGBA color emitted by the light (0 - 1 instead of 0-255).
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
*'''bool isEuler:''' Is the angle set as an "ZXY" euler andgle or a vector.
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
*'''float falloff:''' Decrease in illumination between a spotlight's inner cone (the angle specified by Theta) and the outer edge of the outer cone (the angle specified by Phi).
*'''float theta: (radians)''' Angle, in radians, of a spotlight's inner cone - that is, the fully illuminated spotlight cone. This value must be in the range from 0 through the value specified by Phi.
*'''float phi: (radians)''' Angle, in radians, defining the outer edge of the spotlight's outer cone. Points outside this cone are not lit by the spotlight. This value must be between 0 and pi.
*'''float attenuation:''' Value specifying how the light intensity changes over distance.
===Optional Arguments===
*'''bool normalShadow:''' Determine if the light source should be obscured when lighting a surface on opposite angles.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====destroyLight====
<section name="Client" class="client" show="true">
This function destroys a light element.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:destroyLight(element lightElement)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declaired light element.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightDirection====
<section name="Client" class="client" show="true">
This function destroys a light element.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightDirection(element lightElement,float dirX,dirY,dirZ,[bool isEuler = false])</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declaired light element.
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
===Optional Arguments===
*'''bool isEuler:'''Is the angle set as an "ZXY" euler andgle or a vector.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightPosition====
<section name="Client" class="client" show="true">
This function sets light position value for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightPosition(element lightElement,float posX,posY,posZ)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declaired light element.
*'''float posX, posY, posZ:''' Light position in world space.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightColor====
<section name="Client" class="client" show="true">
This function sets light color value for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightColor(element lightElement,float colorR,colorG,colorB,colorA)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declaired light element.
*'''float colorR,colorG,colorB,colorA:''' Light RGBA color emitted by the light (0 - 1 instead of 0-255).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightAttenuation====
<section name="Client" class="client" show="true">
This function sets setLightAttenuation value for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightAttenuation(element lightElement,float attenuation)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declaired light element.
*'''float attenuation:''' Value specifying how the light intensity changes over distance.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightFalloff====
<section name="Client" class="client" show="true">
This function sets falloff value for a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightFalloff(element lightElement,float falloff)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declaired light element.
*'''float falloff (radians):''' Decrease in illumination between a spotlight's inner cone (the angle specified by Theta) and the outer edge of the outer cone (the angle specified by Phi).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightTheta====
<section name="Client" class="client" show="true">
This function sets theta value for a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightTheta(element lightElement,float theta)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declaired light element.
*'''float theta (radians):''' Angle, in radians, of a spotlight's inner cone - that is, the fully illuminated spotlight cone. This value must be in the range from 0 through the value specified by Phi.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightPhi====
<section name="Client" class="client" show="true">
This function sets phi value for a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightPhi(element lightElement,float phi)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declaired light element.
*'''float phi (radians):''' Angle, in radians, defining the outer edge of the spotlight's outer cone. Points outside this cone are not lit by the spotlight. This value must be between 0 and pi.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightNormalShadowing====
<section name="Client" class="client" show="true">
Determine if the light source should be obscured when lighting a surface on opposite angles.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightNormalShadowing(element lightElement,bool normalShadow)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declaired light element.
*'''bool normalShadow:''' Determine if the light source should be obscured when lighting a surface on opposite angles.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setNormalShadowingAmount====
<section name="Client" class="client" show="true">
Determine global shadowing value ( for all lights).
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setNormalShadowingAmount(element lightElement,float normalShadowAmmount)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declaired light element.
*'''float normalShadowAmmount:''' Determine global shadowing value (1-full 0-nil).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setGenerateBumpNormals====
<section name="Client" class="client" show="true">
Should the shader effect generate bump normals from texture0. Doesn't work when normal shadowing is set to false.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setGenerateBumpNormals(bool isTrue,[int textureSize = 512, float normalStrength.x = 1, float normalStrength.y = 1])</syntaxhighlight>
===Required Arguments===
*'''bool isTrue:''' Turn on or off bump mapping.
===Optional Arguments===
*'''int textureSize:''' The size of the input texture.
*'''float normalStrength.xy:''' How bumpy should the surface be ?
===Returns===
The function returns true if set successfully, false otherwise.
</section>

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

====setLightsEffectRange====
<section name="Client" class="client" show="true">
Set the Max distance from the camera the shader effects are applied to.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightsEffectRange(int maxEffectRange)</syntaxhighlight>
===Required Arguments===
*'''int maxEffectRange:''' If non-zero, the shaders will be applied to textures nearer than maxDistance only.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderForcedOn====
<section name="Client" class="client" show="true">
Should the shader effect turn off when no lightsources.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderForcedOn(bool isShaderForcedOn)</syntaxhighlight>
===Required Arguments===
*'''bool isShaderForcedOn:''' Should the shader effect turn off when no lightsources.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderTimeOut====
<section name="Client" class="client" show="true">
Should the shader effect turn off after number of seconds (when no lightsources)
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderTimeOut(int timeOut)</syntaxhighlight>
===Required Arguments===
*'''int timeOut:''' Should the shader effect turn off after number of seconds (when no lightsources)
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderNightMod====
<section name="Client" class="client" show="true">
Enable nightMod effect - requires proper manipulation of setTextureBrightness and SetShaderDayTime, also some additional shaders.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderNightMod(bool enable)</syntaxhighlight>
===Required Arguments===
*'''bool enable:''' Enable or disable nightMod effect
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderDayTime====
<section name="Client" class="client" show="true">
Another additional variable to control texture colors - requires setShaderNightMod(true)
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderDayTime(float dayTime)</syntaxhighlight>
===Required Arguments===
*'''float dayTime:''' Another additional variable to control texture colors - requires setShaderNightMod(true) set 1 as default
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderPedDiffuse====
<section name="Client" class="client" show="true">
Enable or disable gta directional lights for ped.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderPedDiffuse(bool enable)</syntaxhighlight>
===Required Arguments===
*'''bool enable:''' Enable or disable gta directional lights for ped (enabled as default)
===Returns===
The function returns true if set successfully, false otherwise.
</section>

==Examples==
<syntaxhighlight lang="lua">exports.dynamic_lighting:createPointLight(0,0,5,1,0,0,1,15)</syntaxhighlight>
This creates a red pointlight in world position (0,0,5)

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

==See Also==
[http://community.multitheftauto.com/index.php?p=resources&s=details&id=9398 Dynamic Lighting resource on MTA Community]

[http://msdn.microsoft.com/en-us/library/windows/desktop/bb174697%28v=vs.85%29.aspx Light Types (Direct3D 9)]

[http://www.youtube.com/watch?v=2t_bje_XjUY Vehicle lights video]

Resource:Custom coronas

2014-07-01T22:33:57Z

Renard712:

Resource:Custom coronas

2014-07-01T22:33:24Z

Renard712:

Resource:Custom coronas

2014-07-01T22:31:50Z

Renard712: Created page with "{{Resource page}} This resource lets You create some coronas. Not just your typical gtasa coronas that often times fail to appear. Since in this case corona Elements are crea..."

Resource:Dynamic lighting

2014-06-20T14:05:36Z

Renard712:

{{Resource page}}
This resource lets You create dynamic lights in MTA. It gives you a list of exported functions that You can use to create per pixel pointlights and spotlights. It should be considered a preview of what [https://wiki.multitheftauto.com/wiki/MTA:Eir MTA:Eir] will offer. The future solution should be more FPS friendly. Yet i see that resource as an example of what the future holds.

== Overview ==

It is easy to use, gives a few options to create per pixel lights in gtasa.

The resource itself adds exported clientside functions:

==Exported functions==
====createPointLight====
<section name="Client" class="client" show="true">
This function creates a pixel shader pointlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:createPointLight(float posX,posY,posZ,colorR,colorG,colorB,colorA,attenuation,[bool normalShadow = true])</syntaxhighlight>
===Required Arguments===
*'''float posX, posY, posZ:''' Light position in world.
*'''float colorR,colorG,colorB,colorA:''' Light RGBA color emitted by the light (0 - 1 instead of 0-255).
*'''float attenuation:''' Value specifying how the light intensity changes over distance.
===Optional Arguments===
*'''bool normalShadow:''' Determine if the light source should be obscured when lighting a surface on opposite angles.
===Returns===
The function returns true if set successfully, false otherwise.
</section>
====createSpotLight====
<section name="Client" class="client" show="true">
This function creates a pixel shader spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:createSpottLight(float posX,posY,posZ,colorR,colorG,colorB,colorA,dirX,dirY,dirZ, bool isEuler,float falloff,theta,phi,attenuation,[bool normalShadowing = true])</syntaxhighlight>
===Required Arguments===
*'''float posX, posY, posZ:''' Light position in world space.
*'''float colorR,colorG,colorB,colorA:''' Light RGBA color emitted by the light (0 - 1 instead of 0-255).
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
*'''bool isEuler:''' Is the angle set as an "ZXY" euler andgle or a vector.
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
*'''float falloff:''' Decrease in illumination between a spotlight's inner cone (the angle specified by Theta) and the outer edge of the outer cone (the angle specified by Phi).
*'''float theta: (radians)''' Angle, in radians, of a spotlight's inner cone - that is, the fully illuminated spotlight cone. This value must be in the range from 0 through the value specified by Phi.
*'''float phi: (radians)''' Angle, in radians, defining the outer edge of the spotlight's outer cone. Points outside this cone are not lit by the spotlight. This value must be between 0 and pi.
*'''float attenuation:''' Value specifying how the light intensity changes over distance.
===Optional Arguments===
*'''bool normalShadow:''' Determine if the light source should be obscured when lighting a surface on opposite angles.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====destroyLight====
<section name="Client" class="client" show="true">
This function destroys a light element.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:destroyLight(element lightElement)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declaired light element.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightDirection====
<section name="Client" class="client" show="true">
This function destroys a light element.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightDirection(element lightElement,float dirX,dirY,dirZ,[bool isEuler = false])</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declaired light element.
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
===Optional Arguments===
*'''bool isEuler:'''Is the angle set as an "ZXY" euler andgle or a vector.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightPosition====
<section name="Client" class="client" show="true">
This function sets light position value for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightPosition(element lightElement,float posX,posY,posZ)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declaired light element.
*'''float posX, posY, posZ:''' Light position in world space.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightColor====
<section name="Client" class="client" show="true">
This function sets light color value for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightColor(element lightElement,float colorR,colorG,colorB,colorA)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declaired light element.
*'''float colorR,colorG,colorB,colorA:''' Light RGBA color emitted by the light (0 - 1 instead of 0-255).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightAttenuation====
<section name="Client" class="client" show="true">
This function sets setLightAttenuation value for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightAttenuation(element lightElement,float attenuation)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declaired light element.
*'''float attenuation:''' Value specifying how the light intensity changes over distance.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightFalloff====
<section name="Client" class="client" show="true">
This function sets falloff value for a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightFalloff(element lightElement,float falloff)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declaired light element.
*'''float falloff (radians):''' Decrease in illumination between a spotlight's inner cone (the angle specified by Theta) and the outer edge of the outer cone (the angle specified by Phi).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightTheta====
<section name="Client" class="client" show="true">
This function sets theta value for a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightTheta(element lightElement,float theta)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declaired light element.
*'''float theta (radians):''' Angle, in radians, of a spotlight's inner cone - that is, the fully illuminated spotlight cone. This value must be in the range from 0 through the value specified by Phi.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightPhi====
<section name="Client" class="client" show="true">
This function sets phi value for a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightPhi(element lightElement,float phi)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declaired light element.
*'''float phi (radians):''' Angle, in radians, defining the outer edge of the spotlight's outer cone. Points outside this cone are not lit by the spotlight. This value must be between 0 and pi.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightNormalShadowing====
<section name="Client" class="client" show="true">
Determine if the light source should be obscured when lighting a surface on opposite angles.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightNormalShadowing(element lightElement,bool normalShadow)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declaired light element.
*'''bool normalShadow:''' Determine if the light source should be obscured when lighting a surface on opposite angles.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setNormalShadowingAmount====
<section name="Client" class="client" show="true">
Determine global shadowing value ( for all lights).
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setNormalShadowingAmount(element lightElement,float normalShadowAmmount)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declaired light element.
*'''float normalShadowAmmount:''' Determine global shadowing value (1-full 0-nil).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setGenerateBumpNormals====
<section name="Client" class="client" show="true">
Should the shader effect generate bump normals from texture0. Doesn't work when normal shadowing is set to false.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setGenerateBumpNormals(bool isTrue,[int textureSize = 512, float normalStrength.x = 1, float normalStrength.y = 1])</syntaxhighlight>
===Required Arguments===
*'''bool isTrue:''' Turn on or off bump mapping.
===Optional Arguments===
*'''integer textureSize:''' The size of the input texture.
*'''float normalStrength.xy:''' How bumpy should the surface be ?
===Returns===
The function returns true if set successfully, false otherwise.
</section>

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

====setLightsEffectRange====
<section name="Client" class="client" show="true">
Set the Max distance from the camera the shader effects are applied to.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightsEffectRange(integer maxEffectRange)</syntaxhighlight>
===Required Arguments===
*'''integer maxEffectRange:''' If non-zero, the shaders will be applied to textures nearer than maxDistance only.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderForcedOn====
<section name="Client" class="client" show="true">
Should the shader effect turn off when no lightsources.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderForcedOn(bool isShaderForcedOn)</syntaxhighlight>
===Required Arguments===
*'''bool isShaderForcedOn:''' Should the shader effect turn off when no lightsources.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderTimeOut====
<section name="Client" class="client" show="true">
Should the shader effect turn off after number of seconds (when no lightsources)
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderTimeOut(integer timeOut)</syntaxhighlight>
===Required Arguments===
*'''integer timeOut:''' Should the shader effect turn off after number of seconds (when no lightsources)
===Returns===
The function returns true if set successfully, false otherwise.
</section>

==Examples==
<syntaxhighlight lang="lua">exports.dynamic_lighting:createPointLight(0,0,5,1,0,0,1,15)</syntaxhighlight>
This creates a red pointlight in world position (0,0,5)

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

==See Also==
[http://community.multitheftauto.com/index.php?p=resources&s=details&id=9398 Dynamic Lighting resource on MTA Community]

[http://msdn.microsoft.com/en-us/library/windows/desktop/bb174697%28v=vs.85%29.aspx Light Types (Direct3D 9)]

[http://www.youtube.com/watch?v=2t_bje_XjUY Vehicle lights video]

Resource:Dynamic lighting

2014-06-17T20:43:29Z

Renard712:

{{Resource page}}
This resource lets You create dynamic lights in MTA. It gives you a list of exported functions that You can use to create per pixel pointlights and spotlights. It should be considered a preview of what [https://wiki.multitheftauto.com/wiki/MTA:Eir MTA:Eir] will offer. The future solution should be more FPS friendly. Yet i see that resource as an example of what the future holds.

== Overview ==

It is easy to use, gives a few options to create per pixel lights in gtasa.

The resource itself adds exported clientside functions:

==Exported functions==
====createPointLight====
<section name="Client" class="client" show="true">
This function creates a pixel shader pointlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:createPointLight(float posX,posY,posZ,colorR,colorG,colorB,colorA,attenuation,[bool normalShadow = true])</syntaxhighlight>
===Required Arguments===
*'''float posX, posY, posZ:''' Light position in world.
*'''float colorR,colorG,colorB,colorA:''' Light RGBA color emitted by the light (0 - 1 instead of 0-255).
*'''float attenuation:''' Value specifying how the light intensity changes over distance.
===Optional Arguments===
*'''bool normalShadow:''' Determine if the light source should be obscured when lighting a surface on opposite angles.
===Returns===
The function returns true if set successfully, false otherwise.
</section>
====createSpotLight====
<section name="Client" class="client" show="true">
This function creates a pixel shader spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:createSpottLight(float posX,posY,posZ,colorR,colorG,colorB,colorA,dirX,dirY,dirZ, bool isEuler,float falloff,theta,phi,attenuation,[bool normalShadowing = true])</syntaxhighlight>
===Required Arguments===
*'''float posX, posY, posZ:''' Light position in world space.
*'''float colorR,colorG,colorB,colorA:''' Light RGBA color emitted by the light (0 - 1 instead of 0-255).
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
*'''bool isEuler:''' Is the angle set as an "ZXY" euler andgle or a vector.
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
*'''float falloff:''' Decrease in illumination between a spotlight's inner cone (the angle specified by Theta) and the outer edge of the outer cone (the angle specified by Phi).
*'''float theta: (radians)''' Angle, in radians, of a spotlight's inner cone - that is, the fully illuminated spotlight cone. This value must be in the range from 0 through the value specified by Phi.
*'''float phi: (radians)''' Angle, in radians, defining the outer edge of the spotlight's outer cone. Points outside this cone are not lit by the spotlight. This value must be between 0 and pi.
*'''float attenuation:''' Value specifying how the light intensity changes over distance.
===Optional Arguments===
*'''bool normalShadow:''' Determine if the light source should be obscured when lighting a surface on opposite angles.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====destroyLight====
<section name="Client" class="client" show="true">
This function destroys a light element.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:destroyLight(element lightElement)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declaired light element.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightDirection====
<section name="Client" class="client" show="true">
This function destroys a light element.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightDirection(element lightElement,float dirX,dirY,dirZ,[bool isEuler = false])</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declaired light element.
*'''float dirX,dirY,dirZ:''' Direction that the light is pointing in world space. It's a vector as default.
===Optional Arguments===
*'''bool isEuler:'''Is the angle set as an "ZXY" euler andgle or a vector.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightPosition====
<section name="Client" class="client" show="true">
This function sets light position value for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightPosition(element lightElement,float posX,posY,posZ)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declaired light element.
*'''float posX, posY, posZ:''' Light position in world space.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightColor====
<section name="Client" class="client" show="true">
This function sets light color value for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightColor(element lightElement,float colorR,colorG,colorB,colorA)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declaired light element.
*'''float colorR,colorG,colorB,colorA:''' Light RGBA color emitted by the light (0 - 1 instead of 0-255).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightAttenuation====
<section name="Client" class="client" show="true">
This function sets setLightAttenuation value for both a pointlight and a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightAttenuation(element lightElement,float attenuation)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declaired light element.
*'''float attenuation:''' Value specifying how the light intensity changes over distance.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightFalloff====
<section name="Client" class="client" show="true">
This function sets falloff value for a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightFalloff(element lightElement,float falloff)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declaired light element.
*'''float falloff (radians):''' Decrease in illumination between a spotlight's inner cone (the angle specified by Theta) and the outer edge of the outer cone (the angle specified by Phi).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightTheta====
<section name="Client" class="client" show="true">
This function sets theta value for a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightTheta(element lightElement,float theta)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declaired light element.
*'''float theta (radians):''' Angle, in radians, of a spotlight's inner cone - that is, the fully illuminated spotlight cone. This value must be in the range from 0 through the value specified by Phi.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightPhi====
<section name="Client" class="client" show="true">
This function sets phi value for a spotlight.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightPhi(element lightElement,float phi)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declaired light element.
*'''float phi (radians):''' Angle, in radians, defining the outer edge of the spotlight's outer cone. Points outside this cone are not lit by the spotlight. This value must be between 0 and pi.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setLightNormalShadowing====
<section name="Client" class="client" show="true">
Determine if the light source should be obscured when lighting a surface on opposite angles.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setLightNormalShadowing(element lightElement,bool normalShadow)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declaired light element.
*'''bool normalShadow:''' Determine if the light source should be obscured when lighting a surface on opposite angles.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setNormalShadowingAmount====
<section name="Client" class="client" show="true">
Determine global shadowing value ( for all lights).
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setNormalShadowingAmount(element lightElement,float normalShadowAmmount)</syntaxhighlight>
===Required Arguments===
*'''element lightElement:''' A previously declaired light element.
*'''float normalShadowAmmount:''' Determine global shadowing value (1-full 0-nil).
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setGenerateBumpNormals====
<section name="Client" class="client" show="true">
Should the shader effect generate bump normals from texture0. Doesn't work when normal shadowing is set to false.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setGenerateBumpNormals(bool isTrue,[int textureSize = 512, float normalStrength.x = 1, float normalStrength.y = 1])</syntaxhighlight>
===Required Arguments===
*'''bool isTrue:''' Turn on or off bump mapping.
===Optional Arguments===
*'''integer textureSize:''' The size of the input texture.
*'''float normalStrength.xy:''' How bumpy should the surface be ?
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderForcedOn====
<section name="Client" class="client" show="true">
Should the shader effect turn off when no lightsources.
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderForcedOn(bool isShaderForcedOn)</syntaxhighlight>
===Required Arguments===
*'''bool isShaderForcedOn:''' Should the shader effect turn off when no lightsources.
===Returns===
The function returns true if set successfully, false otherwise.
</section>

====setShaderTimeOut====
<section name="Client" class="client" show="true">
Should the shader effect turn off after number of seconds (when no lightsources)
<syntaxhighlight lang="lua">bool exports.dynamic_lighting:setShaderTimeOut(integer timeOut)</syntaxhighlight>
===Required Arguments===
*'''integer timeOut:''' Should the shader effect turn off after number of seconds (when no lightsources)
===Returns===
The function returns true if set successfully, false otherwise.
</section>

==Examples==
<syntaxhighlight lang="lua">exports.dynamic_lighting:createPointLight(0,0,5,1,0,0,1,15)</syntaxhighlight>
This creates a red pointlight in world position (0,0,5)

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

==See Also==
[http://community.multitheftauto.com/index.php?p=resources&s=details&id=9398 Dynamic Lighting resource on MTA Community]

[http://msdn.microsoft.com/en-us/library/windows/desktop/bb174697%28v=vs.85%29.aspx Light Types (Direct3D 9)]

[http://www.youtube.com/watch?v=2t_bje_XjUY Vehicle lights video]

Resource:Dynamic lighting

2014-06-09T17:59:14Z

Renard712:

Resource:Dynamic lighting

2014-06-09T17:50:20Z

Renard712:

Resource:Dynamic lighting

2014-06-09T16:41:09Z

Renard712: