Go to: Synopsis. Return value. Related. Flags. Python 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])

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.

Return value

stringLight shape name

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

Related

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

Flags

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

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 #