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

Synopsis

ambientLight [-ambientShade float] [-discRadius linear] [-intensity float] [-name string] [-rgb float float float] [-shadowColor float float float] [-shadowDither float] [-shadowSamples int] [-softShadow boolean] [-useRayTraceShadows boolean]

ambientLight is undoable, queryable, and editable.

The ambientLight command is used to edit the parameters of existing ambientLights, or to create new ones. The default behaviour is to create a new ambientlight.

Return value

stringLight shape name

In query mode, return type is based on queried flag.

Related

directionalLight, exclusiveLightCheckBox, lightList, lightlink, pointLight, spotLight, spotLightPreviewPort

Flags

ambientShade, discRadius, intensity, name, rgb, shadowColor, shadowDither, shadowSamples, softShadow, useRayTraceShadows
Long name (short name) Argument types Properties
-ambientShade(-as) float createqueryedit
ambientShade
-discRadius(-drs) linear createqueryedit
radius of the disc around the light
-intensity(-i) float createqueryedit
intensity of the light (expressed as a percentage)
-name(-n) string createqueryedit
specify the name of the light
-rgb(-rgb) float float float createqueryedit
color of the light (0-1)
-shadowColor(-sc) float float float createqueryedit
the shadow color
-shadowDither(-sd) float createqueryedit
dither the shadow
-shadowSamples(-sh) int createqueryedit
number of shadow samples.
-softShadow(-ss) boolean createqueryedit
soft shadow
-useRayTraceShadows(-rs) boolean createqueryedit
ray trace shadows
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.

MEL examples

// Create an ambient light
string $light = `ambientLight -intensity 0.8`;

// Change the light intensity
ambientLight -e -intensity 0.5 $light;

// Query it
ambientLight -q -intensity $light;
// Result:0.5 //