Go to: Synopsis. Flags. Return value. Related. MEL examples.

Synopsis

spotLight [-coneAngle float] [-decayRate int] [-discRadius float] [-dropOff float] [-edit] [-intensity float] [-name string] [-penumbra float] [-query] [-rgb float float float] [-shadowColor float float float] [-shadowDither float] [-shadowSamples int] [-softShadow boolean] [-useRayTraceShadows boolean]

spotLight is undoable, queryable, and editable.

The spotLight command is used to edit the parameters of existing spotLights, or to create new ones. The default behaviour is to create a new spotlight.

Flags

coneAngle, decayRate, discRadius, dropOff, edit, intensity, name, penumbra, query, rgb, shadowColor, shadowDither, shadowSamples, softShadow, useRayTraceShadows
Long name (short name) [argument types] Properties
-edit(-e) edit
edit the parameters of an existing light
-query(-q) query
Puts the command in query mode so that it will return the value of the specified flag.

In query mode, this flag needs a value.
-coneAngle(-ca) float createqueryedit
angle of the spotLight

In query mode, this flag needs a value.
-decayRate(-d) int createqueryedit
decay rate of the light (0-no decay, 1-slow, 2-realistic, 3-fast)

In query mode, this flag needs a value.
-discRadius(-drs) float createqueryedit
radius of the disc around the light

In query mode, this flag needs a value.
-dropOff(-do) float createqueryedit
dropOff of the spotLight

In query mode, this flag needs a value.
-intensity(-i) float createqueryedit
intensity of the light (expressed as a percentage)

In query mode, this flag needs a value.
-name(-n) string createqueryedit
specify the name of the light

In query mode, this flag needs a value.
-penumbra(-p) float createqueryedit
specify penumbra region

In query mode, this flag needs a value.
-rgb(-rgb) float float float createqueryedit
color of the light (0-1)

In query mode, this flag needs a value.
-useRayTraceShadows(-rs) boolean createqueryedit
ray trace shadows

In query mode, this flag needs a value.
-shadowColor(-sc) float float float createqueryedit
the shadow color

In query mode, this flag needs a value.
-softShadow(-ss) boolean createqueryedit
soft shadow

In query mode, this flag needs a value.
-shadowSamples(-sh) int createqueryedit
number of shadow samples.

In query mode, this flag needs a value.
-shadowDither(-sd) float createqueryedit
dither the shadow

In query mode, this flag needs a value.
Flag can appear in Create mode of command Flag can appear in Edit mode of command
Flag can appear in Query mode of command Flag can be used more than once in a command

Return value


string (light name)

Related

ambientLight, directionalLight, exclusiveLightCheckBox, lightList, lightListEditor, lightListPanel, lightlink, pointLight, spotLightPreviewPort

MEL examples

// Create a spot light
string $light = `spotLight -coneAngle 45`;

// Change the cone angle value
spotLight -e -coneAngle 33 $light;

// Query it
spotLight -q -coneAngle $light;
// Result:33//