Lights.itemByName Method

Parent Object: Lights

Preview This functionality is provided as a preview of intended future API capabilities. You are encouraged to use it and report any problems or suggestions using the Fusion API and Scripts forum.

Because this is a preview of future functionality, there is the possibility that it will change, which will possibly break any existing programs that use this functionality. Because of that, you should never deliver any programs that use any preview capabilities. For a distributed program, you should wait until it has moved from preview to released state.

Defined in namespace "adsk::fusion" and the header file is <Fusion/Render/Lights.h>

Description

Returns the light with the specified name, as the name is displayed in the user interface.

"lights_var" is a variable referencing a Lights object.

returnValue = lights_var.itemByName(name)

"lights_var" is a variable referencing a Lights object.

#include <Fusion/Render/Lights.h>

returnValue = lights_var->itemByName(name);

"lights_var" is a variable referencing a Lights object.

returnValue = lights_var.itemByName(name);

Return Value

Type	Description
Light	Returns the light with the specified name or null if no light with that name exists.

Parameters

Name	Type	Description
name	string	The name of the light to return.

Version

Introduced in version September 2026