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

Synopsis

ambientLight([ambientShade=float], [discRadius=float], [edit=boolean], [intensity=float], [name=string], [query=boolean], [rgb=[float, float, float]], [shadowColor=[float, float, float]], [shadowDither=float], [shadowSamples=int], [softShadow=boolean], [useRayTraceShadows=boolean])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

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.

Flags

ambientShade, discRadius, edit, intensity, name, query, rgb, shadowColor, shadowDither, shadowSamples, softShadow, useRayTraceShadows
Long name (short name) [argument types] Properties
edit(e) boolean edit
edit the parameters of an existing light
query(q) boolean 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.

ambientShade(ambientShade) float createqueryedit
ambientShade

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.

intensity(i) float createqueryedit
intensity of the light (expressed as a percentage)

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.

name(n) string createqueryedit
specify the name of the light

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 have multiple arguments, passed either as a tuple or a list.

Return value


[string] (light name)

Related

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

Python examples

import maya.cmds as cmds

# Create an ambientLight light
light = cmds.ambientLight(intensity=0.8)

# Change the light intensity
cmds.ambientLight( light, e=True, intensity=0.5 )

# Query it
cmds.ambientLight( light, q=True, intensity=True )
# Result:0.5 #