MTA:Eir/functions/engineCreateLight - Revision history

The GTA at 13:30, 14 March 2014

2014-03-14T13:30:57Z

← Older revision		Revision as of 13:30, 14 March 2014
Line 31:		Line 31:

	<section name="Client" class="client" show="true">		<section name="Client" class="client" show="true">
	This snippet creates a spotlight that ~~point~~ in the direction of the player.		This snippet creates a spotlight that points in the direction of the player.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local light = engineCreateLight( "spot_soft" ); -- create a soft spot light		local light = engineCreateLight( "spot_soft" ); -- create a soft spot light

The GTA at 13:10, 14 March 2014

2014-03-14T13:10:26Z

← Older revision		Revision as of 13:10, 14 March 2014
Line 33:		Line 33:
	This snippet creates a spotlight that point in the direction of the player.		This snippet creates a spotlight that point in the direction of the player.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local light = engineCreateLight( "~~spot~~" );		local light = engineCreateLight( "spot_soft" ); -- create a soft spot light
	light.setColor( 1, 1, 1, 1 );		light.setColor( 1, 1, 1, 1 ); -- set its color to white
	light.setAttenuation( 0, 10, 8 );		light.setAttenuation( 0, 10, 8 ); -- give it a random attenuation value
	light.setRadius( ~~150~~ );		light.setRadius( 300 ); -- set its radius to 300 game units
	light.setFalloff( 1.5 );		light.setFalloff( 99 ); -- set the softness of the spot light
			light.setConeAngle( 15 ); -- set the spot light's cone angle

			-- Spot lights face in the direction of the "up" vector.
			-- If we want to rotate it according to the player's "front" vector,
			-- we must tilt the light so that the "up" vector becomes the "front" vector.
	local lightFrame = engineCreateFrame();		local lightFrame = engineCreateFrame();
	light.setParent( lightFrame );		light.setParent( lightFrame );
	light.addToScene();		light.addToScene();

			-- We tilt the light "up vector" onto the ped "x" axis using 90-degree y angle.
			-- Then the "up" vector is rotated onto the "y" axis using 90-degree x angle.
			local transMatrix = matrixNew();
			transMatrix.setEulerAngles( 90, 90, 0 );
			lightFrame.setModelling( transMatrix );

			-- We use another transformation frame to actually face the direction of the player.
			-- This frame is updated with the player's world matrix.
			local lightPointTransform = engineCreateFrame();
			lightFrame.setParent( lightPointTransform );

			-- We need to update it every frame.
	local function updateLight()		local function updateLight()
	local playerMatrix = localPlayer.getMatrix();		local playerMatrix = localPlayer.getMatrix();

			-- I decided to offset the world matrix by 1 unit up.
			playerMatrix.setPosition(
			playerMatrix.offset( 0, 0, 1 )
			);

			-- Apply it to the light's root transformation.
			lightPointTransform.setModelling( playerMatrix );

	-- ~~todo~~		-- Remember to clean up resources to simplify the task of
			-- the garbage collector.
	playerMatrix.destroy();		playerMatrix.destroy();
	end		end

	addEventHandler( "~~onClientFrame~~", root, updateLight );		addEventHandler( "onClientRender", root, updateLight );
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

The GTA at 12:35, 14 March 2014

2014-03-14T12:35:27Z

@@ Line 8: / Line 8: @@
 ===Arguments===
-*'''type:''' decides which type that light should have, can be '''point''', '''spot''', '''spot_soft''', '''directional''' or '''ambient''' (currently '''spot''' and '''spot_soft''' do not work)
+*'''type:''' decides which type that light should have, can be '''point''', '''spot''', '''spot_soft''', '''directional''' or '''ambient'''
 ===Returns===
@@ Line 27: / Line 27: @@
 lightFrame.setPosition( 0, 0, 10 ); -- repositions the light
 </syntaxhighlight>
 </section>

The GTA at 13:27, 7 January 2014

2014-01-07T13:27:55Z

← Older revision		Revision as of 13:27, 7 January 2014
Line 8:		Line 8:

	===Arguments===		===Arguments===
	*'''type:''' decides which type that light should have, can be '''point''', '''spot''' or '''~~spot_soft~~''' (currently ~~only~~ '''~~point~~''' ~~works~~)		*'''type:''' decides which type that light should have, can be '''point''', '''spot''', '''spot_soft''', '''directional''' or '''ambient''' (currently '''spot''' and '''spot_soft''' do not work)

	===Returns===		===Returns===

The GTA: /* Example */

2014-01-06T22:21:09Z

Example

← Older revision		Revision as of 22:21, 6 January 2014
Line 25:		Line 25:
	light.setParent( lightFrame ); -- attaches the light to its frame, the light can now be active in the world.		light.setParent( lightFrame ); -- attaches the light to its frame, the light can now be active in the world.
	light.addToScene(); -- activates the light object, so it illuminates its surroundings		light.addToScene(); -- activates the light object, so it illuminates its surroundings

			lightFrame.setPosition( 0, 0, 10 ); -- repositions the light
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

The GTA: Created page with "NOTOC This function creates a RenderWare RpLight object. A light is an object that affects its surrouding RpAtomic instances in a certain radius and casts effects on them. T..."

2014-01-06T22:01:52Z

Created page with "__NOTOC__ This function creates a RenderWare RpLight object. A light is an object that affects its surrouding RpAtomic instances in a certain radius and casts effects on them. T..."

New page

__NOTOC__
This function creates a RenderWare RpLight object. A light is an object that affects its surrouding RpAtomic instances in a certain radius and casts effects on them. The most notable effect is the '''pointlight''', that colors its surroundings based on attenuation settings.

==Syntax==
<syntaxhighlight lang="lua">
rplight engineCreateLight ( string type )
</syntaxhighlight>

===Arguments===
*'''type:''' decides which type that light should have, can be '''point''', '''spot''' or '''spot_soft''' (currently only '''point''' works)

===Returns===
Returns the '''rplight object''' if creation was successful, '''false''' otherwise.

==Example==
<section name="Client" class="client" show="true">
This snippet creates a RenderWare light object and sets it up properly.
<syntaxhighlight lang="lua">
local light = engineCreateLight( "point" ); -- creates the new point light
light.setColor(1, 1, 1, 1); -- gives the point light a bright color
light.setAttenuation(0.8, 1.4, 4); -- makes the light fade somewhat
light.setRadius(100); -- makes the light affect atomics in a 100 unit radius

local lightFrame = engineCreateFrame(); -- create a 3D transformation for the light
light.setParent( lightFrame ); -- attaches the light to its frame, the light can now be active in the world.
light.addToScene(); -- activates the light object, so it illuminates its surroundings
</syntaxhighlight>
</section>