SetLightRadius: Difference between revisions
Jump to navigation
Jump to search
m (Changed version from 1.4.0 to 1.5 (it wasn't implemented in 1.4)) |
m (anywhere else "light" start from lowercase letter) |
||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
{{New feature/item|3.0150|1.5.0|7048| | {{New feature/item|3.0150|1.5.0|7048| | ||
This function sets the radius for a light element. | This function sets the radius for a [[Element/Light|light]] element. | ||
}} | }} | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool setLightRadius ( | bool setLightRadius ( light theLight, float radius ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[light]]:setRadius|radius|getLightRadius}} | {{OOP||[[light]]:setRadius|radius|getLightRadius}} | ||
| Line 20: | Line 20: | ||
===Example=== | ===Example=== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
local light = createLight(0, 2, 3, 4) | |||
</syntaxhighlight> | addCommandHandler("setradiusoflight", | ||
function(cmd, radius) | |||
if radius then | |||
if tonumber(radius) > 0 then | |||
setLightRadius(light, tonumber(radius)) | |||
else | |||
outputChatBox("Radius must be greater than 0.") | |||
end | |||
else | |||
outputChatBox("You must specify a radius.") | |||
end | |||
end | |||
)</syntaxhighlight> | |||
==See also== | ==See also== | ||
{{Client_light_functions}} | {{Client_light_functions}} | ||
Latest revision as of 20:28, 15 February 2021
This function sets the radius for a light element.
Syntax
bool setLightRadius ( light theLight, float radius )
OOP Syntax Help! I don't understand this!
- Method: light:setRadius(...)
- Variable: .radius
- Counterpart: getLightRadius
Required Arguments
- theLight: The light that you wish to set the radius of.
Returns
Returns true if the function was successful, false otherwise.
Example
local light = createLight(0, 2, 3, 4)
addCommandHandler("setradiusoflight",
function(cmd, radius)
if radius then
if tonumber(radius) > 0 then
setLightRadius(light, tonumber(radius))
else
outputChatBox("Radius must be greater than 0.")
end
else
outputChatBox("You must specify a radius.")
end
end
)