SetLightRadius

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

[Lua]
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
)

See also

• createLight
• getLightColor
• getLightDirection
• getLightRadius
• getLightType
• setLightColor
• setLightDirection
• setLightRadius