3D Lingo Dictionary > O-S > queue() |  |

queue()

Syntax

    member(whichCastmember).model(whichModel).bonesPlayer.queue(motionName {, looped, startTime, endTime, scale, offset})
    member(whichCastmember).model(whichModel).keyframePlayer.queue(motionName {, looped, startTime, endTime, scale, offset})

Description

3D `keyframePlayer` and `bonesPlayer` modifier command; adds the motion specified by `motionName` to the end of the modifier's playlist. The motion is executed by the model when all of the motions ahead of it in the playlist are finished playing.

The optional parameters of this command are as follows:

`looped` specifies whether the motion plays once (`FALSE`) or continuously (`TRUE`).

`startTime` is measured in milliseconds from the beginning of the motion. When `looped` is `FALSE`, the motion begins at `offset` and ends at `endTime`. When `looped` is `TRUE`, the first iteration of the loop begins at `offset` and ends at `endTime`. All subsequent repetitions begin at `startTime` and end at `endTime`.

`endTime` is measured in milliseconds from the beginning of the motion. When `looped` is `FALSE`, the motion begins at `offset` and ends at `endTime`. When `looped` is `TRUE`, the first iteration of the loop begins at `offset` and ends at `endTime`. All subsequent repetitions begin at `cropStart` and end at `endTime`. Set `endTime` to -1 if you want the motion to play to the end.

`scale` is multiplied by the `playRate` property of the model's `keyframePlayer` modifier or `bonesPlayer` modifier to determine the actual speed of the motion's playback.

`offset` is measured in milliseconds from the beginning of the motion. When `looped` is `FALSE`, the motion begins at `offset` and ends at `endTime`. When `looped` is `TRUE`, the first iteration of the loop begins at `offset` and ends at `endTime`. All subsequent repetitions begin at `startTime` and end at `endTime`.

Example

This command adds the motion named Fall to the end of the `bonesPlayer` playlist of the model named Walker. When all motions before Fall in the playlist have been executed, Fall will play one time from beginning to end.

    sprite(1).member.model("Walker").bonesPlayer.queue("Fall", 0, 0, -1, 1, 0)

This command adds the motion named Kick to the end of the `bonesPlayer` playlist of the model named Walker. When all motions before Kick in the playlist have been executed, a section of Kick will play in a continuous loop. The first iteration of the loop will begin 2000 milliseconds from the motion's beginning. All subsequent iterations of the loop will begin 1000 milliseconds from Kick's beginning and will end 5000 milliseconds from Kick's beginning. The rate of playback will be three times the `playRate` property of the model's `bonesPlayer` modifier.

    sprite(1).member.model("Walker").bonesPlayer.queue("Kick", 1, 1000, 5000, 3, 2000)

See also

`play()`, `playNext()`, `playRate`