GetLightRadius: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
Line 21: Line 21:
===Example===
===Example===
<syntaxhighlight lang="lua">[Lua]
<syntaxhighlight lang="lua">[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}}

Revision as of 11:51, 13 April 2015

Accessories-text-editor.png Script Example Missing Function GetLightRadius needs a script example, help out by writing one.

Before submitting check out Editing Guidelines Script Examples.


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

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

See also