Resource:Custom coronas: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Undo revision 50134 by Marcin778 (talk))
 
(16 intermediate revisions by 3 users not shown)
Line 15: Line 15:
<section name="Client" class="client" show="true">
<section name="Client" class="client" show="true">
This function creates a shadered materialLine3d Corona.
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)</syntaxhighlight>  
<syntaxhighlight lang="lua">coronaElement exports.custom_coronas:createCorona(float posX,posY,posZ,size,int colorR,colorG,colorB,colorA,[bool isSoftParticle = false])</syntaxhighlight>  
===Required Arguments===  
===Required Arguments===  
*'''float posX, posY, posZ:''' Position in world space.
*'''float posX, posY, posZ:''' Position in world space.
*'''float size:''' Size of the corona.
*'''float size:''' Size of the corona.
*'''int colorR,colorG,colorB,colorA:''' Corona RGBA color emitted by the corona (0 - 255).
*'''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===
===Returns===
The function returns true if set successfully, false otherwise.
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>
</section>


Line 29: Line 46:
<syntaxhighlight lang="lua">bool exports.custom_coronas:destroyCorona(element coronaElement)</syntaxhighlight>  
<syntaxhighlight lang="lua">bool exports.custom_coronas:destroyCorona(element coronaElement)</syntaxhighlight>  
===Required Arguments===  
===Required Arguments===  
*'''element coronaElement:''' A previously declaired corona element.
*'''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===
===Returns===
The function returns true if set successfully, false otherwise.
The function returns true if set successfully, false otherwise.
Line 39: Line 100:
<syntaxhighlight lang="lua">bool exports.custom_coronas:setCoronaPosition(element coronaElement,float posX,posY,posZ)</syntaxhighlight>  
<syntaxhighlight lang="lua">bool exports.custom_coronas:setCoronaPosition(element coronaElement,float posX,posY,posZ)</syntaxhighlight>  
===Required Arguments===  
===Required Arguments===  
*'''element coronaElement:''' A previously declaired corona element.
*'''element coronaElement:''' A previously declared corona element.
*'''float posX, posY, posZ:''' Position in world space.
*'''float posX, posY, posZ:''' Position in world space.
===Returns===
===Returns===
Line 45: Line 106:
</section>
</section>


====setCoroaColor====
====setCoronaColor====
<section name="Client" class="client" show="true">
<section name="Client" class="client" show="true">
This function sets light color values.
This function sets light color values.
<syntaxhighlight lang="lua">bool exports.custom_coronas:setCoroaColor(element coronaElement,float colorR,colorG,colorB,colorA)</syntaxhighlight>  
<syntaxhighlight lang="lua">bool exports.custom_coronas:setCoronaColor(element coronaElement,float colorR,colorG,colorB,colorA)</syntaxhighlight>  
===Required Arguments===  
===Required Arguments===  
*'''element coronaElement:''' A previously declaired light element.
*'''element coronaElement:''' A previously declared corona element.
*'''float colorR,colorG,colorB,colorA:''' Corona RGBA color emitted by the corona (0 - 255).
*'''float colorR,colorG,colorB,colorA:''' RGBA color (0 - 255).
===Returns===
===Returns===
The function returns true if set successfully, false otherwise.
The function returns true if set successfully, false otherwise.
Line 63: Line 124:
*'''int MaxEffectFade:''' Set the Max distance of the corona to sync.(Must be greater than MinEffectFade).
*'''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.
*'''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===
===Returns===
The function returns true if set successfully, false otherwise.
The function returns true if set successfully, false otherwise.
Line 68: Line 139:


==Examples==  
==Examples==  
<syntaxhighlight lang="lua">local corTable = {}
<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


function addStuff()
addEventHandler("onClientResourceStart", getResourceRootElement( getThisResource()), addStuff)</syntaxhighlight>
This creates a 400 coronas near position (0,0,0)


for i=1,30 do
<syntaxhighlight lang="lua">local vehicle1 = nil
for j=1,30 do
addEventHandler("onClientVehicleEnter", getRootElement(),
corTable[i] = createCorona(i * 7,j * 7,10,4,math.random()*255,math.random()*255,math.random()*255,1*255,false)  
    function(thePlayer, seat)
end
        if thePlayer == getLocalPlayer() then
end
            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
end
 
) </syntaxhighlight>
bindKey("r","down",addStuff)</syntaxhighlight>
This creates a corona and attaches it to a vehicle that the player enters.
This creates a 400 coronas near position (0,0,0)


Of course when you want to use these functions in your resources you have to include
Of course when you want to use these functions in your resources you have to include
Line 87: Line 174:
==See Also==
==See Also==
[http://www.youtube.com/watch?v=5lruyY1fviQ A youtube video]
[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://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]
[http://www.html5rocks.com/en/tutorials/webgl/webgl_orthographic_3d WebGL Orthographic 3D]

Latest revision as of 18:23, 1 January 2017

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

Click to collapse [-]
Client

This function creates a shadered materialLine3d Corona. 

coronaElement exports.custom_coronas:createCorona(float posX,posY,posZ,size,int colorR,colorG,colorB,colorA,[bool isSoftParticle = false])

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.

createMaterialCorona

Click to collapse [-]
Client

This function creates a shadered materialLine3d Corona with a custom material. 

coronaElement exports.custom_coronas:createMaterialCorona(element material,float posX,posY,posZ,size,int colorR,colorG,colorB,colorA,[bool isSoftParticle = false])

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.

destroyCorona

Click to collapse [-]
Client

This function destroys a shadered materialLine3d Corona element. 

bool exports.custom_coronas:destroyCorona(element coronaElement)

Required Arguments

  • element coronaElement: A previously declared corona element.

Returns

The function returns true if set successfully, false otherwise.

setCoronaMaterial

Click to collapse [-]
Client

This function sets custom material for the corona. 

bool exports.custom_coronas:setCoronaMaterial(element coronaElement,element material)

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.

setCoronaSize

Click to collapse [-]
Client

This function sets size of the corona. 

bool exports.custom_coronas:setCoronaSize(element coronaElement,float size)

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.

setCoronaSizeXY

Click to collapse [-]
Client

This function sets size of the corona (width and height). 

bool exports.custom_coronas:setCoronaSizeXY(element coronaElement,float width,height)

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.

setCoronaDepthBias

Click to collapse [-]
Client

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. 

bool exports.custom_coronas:setCoronaDepthBias(element coronaElement,float depthBiasValue)

Required Arguments

  • element coronaElement: A previously declared corona element.
  • float depthBiasValue: depthBias value.

Returns

The function returns true if set successfully, false otherwise.

setCoronaPosition

Click to collapse [-]
Client

This function sets corona position. 

bool exports.custom_coronas:setCoronaPosition(element coronaElement,float posX,posY,posZ)

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.

setCoronaColor

Click to collapse [-]
Client

This function sets light color values. 

bool exports.custom_coronas:setCoronaColor(element coronaElement,float colorR,colorG,colorB,colorA)

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.

setCoronasDistFade

Click to collapse [-]
Client

Set the Max distance of the corona to sync and the distance on which the it starts to fade out. 

bool exports.custom_coronas:setCoronasDistFade(int MaxEffectFade,int MinEffectFade)

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.

enableDepthBiasScale

Click to collapse [-]
Client

Standard depthBias for GTASA coronas is about 1 unit, despite the corona scale. This function elables depthBias scaling. 

bool exports.custom_coronas:enableDepthBiasScale(bool isDepthScaleEnabled)

Required Arguments

  • bool isDepthScaleEnabled: Enable/disable depthBias scaling.

Returns

The function returns true if set successfully, false otherwise.

Examples

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)

This creates a 400 coronas near position (0,0,0) 

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
)

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

A youtube video

Custom Coronas resource on MTA Community

WebGL Orthographic 3D

Retrieved from "https://wiki.multitheftauto.com/wiki/Resource:Custom_coronas?oldid=50142"