GetLightRadius: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Changed version from 1.4.0 to 1.5 (it wasn't implemented in 1.4))
mNo edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
{{Needs_Example}}


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


Line 20: Line 19:


===Example===
===Example===
<syntaxhighlight lang="lua">[Lua]
<syntaxhighlight lang="lua">
-- todo
local light = createLight(0, 0, 0, 4)
outputChatBox("light radius: " .. getLightRadius(light))
</syntaxhighlight>
</syntaxhighlight>


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

Latest revision as of 21:12, 7 May 2017

This function returns the radius for a light element.

Syntax

float getLightRadius ( light theLight )

OOP Syntax Help! I don't understand this!

Method: light:getRadius(...)
Variable: .radius
Counterpart: setLightRadius


Required Arguments

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

Returns

Returns a float containing the radius of the specified light, false if invalid arguments were passed.

Example

local light = createLight(0, 0, 0, 4)
outputChatBox("light radius: " .. getLightRadius(light))

See also