The script ties together models, actions, sounds and cameras. It is through starting, stopping or altering some characteristic of a script that you generate lengthy animations or generate user interaction with your 3D models.

A script is a collection of sequences. The corresponding Animation:Master element is the model shortcut or the camera shortcut. Just as you can start, stop and loop actions with a model shortcut, the corresponding actionSequence object also allows you these commands. The actionSequence object is more flexible than the AM model shortcut as you can for example re-start an action at a later time and also execute goto commands on the timeline.

A choreography is basically a collection of commands to initialise a script and to create the necessary sequences. It is through adding a chor to a script that most animations will be played.

Properties, Events and Methods

Name Type Description
onframechange EventThis event fires on every frame location change of the script.
onframechange()
addAction MethodAdds an action file to a model instance and returns an actionSequence object.
actionSequence addAction(String actionname, model modelinstance)
addChoreography MethodAdd a choreography to this script
void addChoreography(String chorname)
addModel MethodCreates a new model instance from a modelFile and adds it to the scene.
model addModel(String modelfilename)
addSound MethodAdds a sound file to the script and returns a soundSequence object
soundSequence addSound(String soundname,model modelinstance, String bonename)
custom MethodAdd a custom event to the script
void custom(float time,VARIANT gin, VARIANT jam)
fadeIn MethodStarts this script, but does so using a fade-in over a period of time.
void fadeIn(float fadetime)
fadeOut MethodStops this script using a fade out.
void fadeOut(float fadetime)
needReadyEvent MethodCall this function to flag the need for ar ReadyEvent message
void needReadyEvent()
pause MethodPauses all animations part of this script
void pause()
restart MethodContinues the animation of this script.
void restart()
start MethodStarts all animations related to this script.
void start()
stop MethodStops all animations related to this script.
void stop()
frame(Float) PropertyThe current frame of the animation.
name(String) PropertyThe name of this script
sequences(Object) PropertyReturns a sequences collection object holding all sequence objects belonging to this script.
status(Integer) PropertyReturns the current status of the script.

 

©2000 arcticpigs. All rights reserved.
This is a draft version! The functionality of parts of the software are liable to change.