GetLightDirection: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (who did this example?)
 
(6 intermediate revisions by 4 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
{{Needs_Example}}


{{New feature/item|9.07048|1.4.0|7048|
{{New feature/item|3.0150|1.5.0|7048|
This function returns the direction for a light element.
This function returns the direction for a [[Element/Light|light]] element.
}}
}}


Line 20: Line 19:


===Example===
===Example===
<syntaxhighlight lang="lua">[Lua]
<syntaxhighlight lang="lua">
-- todo
function lightDirection ()
local light = createLight(0, 1, 0, 4)
local lx, ly, lz = getLightDirection(light)
outputChatBox("light direction: " .. lx .. ", " .. ly .. ", " .. lz)
end
addCommandHandler("lightDirection", lightDirection)
</syntaxhighlight>
</syntaxhighlight>


==See also==
==See also==
{{Client_light_functions}}
{{Client_light_functions}}

Latest revision as of 13:38, 4 October 2016

This function returns the direction for a light element.

Syntax

float, float, float getLightDirection ( light theLight )

OOP Syntax Help! I don't understand this!

Method: light:getDirection(...)
Variable: .direction
Counterpart: setLightDirection


Required Arguments

  • theLight: The light that you wish to retrieve the direction of.

Returns

Returns three ints corresponding to the x, y and z coordinates (respectively) of the light direction, false if invalid arguments were passed.

Example

function lightDirection ()
	local light = createLight(0, 1, 0, 4)
	local lx, ly, lz = getLightDirection(light)
	outputChatBox("light direction: " .. lx .. ", " .. ly .. ", " .. lz)
end
addCommandHandler("lightDirection", lightDirection) 

See also