User Guide

Chapter 19514
registerScript
(eventName,
handlerName,
scriptInstance)
Registers a handler named handlerName that is called in the
instance
scriptInstance when the event eventName occurs.
If
scriptInstance is 0, a movie script handler called
eventName is called.
The user defines what
eventName is.
TRUE (1) or
FALSE (0),
with
TRUE (1)
indicating that the
event happened
and
FALSE (0)
that it did not
translate
(
xIncrement,
yIncrement,
zIncrement,
relativeTo)
Moves the light forward by xIncrement along the x-axis,
yIncrement along the y-axis, and zIncrement along the z-axis.
The
relativeTo parameter is optional. It determines how
arguments are interpreted. The possible values are as follows:
#self: the default. Increments are applied relative to the light’s local
coordinate system.
#parent: increments are relative to the light’s parent’s coordinate
system.
#world: increments are relative to the world’s coordinate system.
Equivalent to
#parent if the parent is the world.
node (model, light, camera, or group): increments are relative to the
argument’s coordinate system.
Nothing
translate
(
direction
Vector
, relativeTo)
Moves the light directionVector.length() in the direction
of the vector
directionVector. The relativeTo argument is
optional and defaults to
#self.
Nothing
translate(x,y,z,
relativeTo)
Moves the light distance x along the x-axis, distance y along the y-
axis, and distance
z along the z-axis. The relativeTo argument is
optional and defaults to
#self.
This command can also be written as
translate
(vector(x,y,z) relativeTo)
Nothing
rotate(x,y,z,
relativeTo)
Rotates the light by x degrees around the x-axis, y degrees around
the y-axis, and z degrees around the z-axis.
The
relativeTo argument is optional and defaults to #self. If
included, it defines the coordinate space of the axes.
This command can also be written as
rotate
(vector(x,y,z) relativeTo)
Nothing
rotate (position,
axis, angle,
relativeTo)
Rotates the light around the axis vector in the specified position the
specified number of degrees. The
relativeTo argument is
optional and defaults to
#self.
Nothing
pointAt(world
Position,
worldUp)
Rotates the light until it points at the world-relative position
worldPosition. The optional worldUp argument indicates the
position of the light’s Up axis.
Both the object-relative axes are defined by the
pointAtOrientation property. Default values are an object-
relative forward direction of vector
(0,0,-1) and an object-
relative up direction of vector
(0,1,0).
Nothing
getWorld
Transform()
Calculates and returns a transform that converts object-relative
positions for this light into world-relative positions.
A transform
object
Command Description Returns