Playing Cinematics using A.P.E.


 

PlayScene



extern playscene [scriptname] [timeoffset] [sequencecallback] [targetname / sequence] [targetname / sequence] [source rel]] [target rel] [true / false] [true / false]
(i.e. "extern playscene tensil/bird002 0 89:1407 null null 0 0 false false")

Used to play a scene, a scene being a cinematic where the camera is controlled by the script.

[scriptname] - cannot be a string / variable
[timeoffset] - start playing x seconds into script, normally 0
[sequencecallback] - APE sequence to invoke at script end (can be 0:0 if none)
[targetname / sequence] - source of relative script, use "null" if not relative script.
[targetname / sequence] - target of relative script, use "null" if not relative script.
[source rel] - Source of the relative script referred to by index / entity number. 0 if not used
[target rel] - Target of the relative script referred to by index / entity number. 0 if not used
[true / false] - lerp after. True, it will smooth transition back, false and it will zip back.
[true / false] - if true, keep cursor hidden after cinematic (not reccomended)


StopScene



extern stopscene [scriptname]
(i.e. "extern stopscene tensil/bird002")

Used to stop a scene that is currently playing.

[scriptname] - cannot be a string / variable


PlayAmbient



extern playambient [scriptname] [timeoffset] [sequencecallback] [targetname / sequence] [targetname / sequence] [source rel]] [target rel] [true / false] [true / false]
(i.e. "extern playambient tensil/bird002 0 89:1407 null null 0 0 false false")

Used to play an ambient script, an ambient being a cinematic where the script does not controll the camera. Examples would be the cars that fly around Bricks.

[scriptname] - cannot be a string / variable
[timeoffset] - start playing x seconds into script, normally 0
[sequencecallback] - APE sequence to invoke at script end (can be 0:0 if none)
[targetname / sequence] - source of relative script, use "null" if not relative script.
[targetname / sequence] - target of relative script, use "null" if not relative script.
[source rel] - Source of the relative script referred to by index / entity number. 0 if not used
[target rel] - Target of the relative script referred to by index / entity number. 0 if not used
[true / false] - lerp after. True, it will smooth transition back, false and it will zip back.
[true / false] - if true, keep cursor hidden after cinematic (not reccomended)


LoopAmbient



extern loopambient [scriptname] [timeoffset] [sequencecallback] [targetname / sequence] [targetname / sequence] [source rel]] [target rel] [true / false] [true / false]
(i.e. "extern loopambient tensil/bird002 0 89:1407 null null 0 0 false false")

Used to loop an ambient script, an ambient being a cinematic where the script does not controll the camera. Examples would be the cars that fly around Bricks.

[scriptname] - cannot be a string / variable
[timeoffset] - start playing x seconds into script, normally 0
[sequencecallback] - APE sequence to invoke at script end (can be 0:0 if none)
[targetname / sequence] - source of relative script, use "null" if not relative script.
[targetname / sequence] - target of relative script, use "null" if not relative script.
[source rel] - Source of the relative script referred to by index / entity number. 0 if not used
[target rel] - Target of the relative script referred to by index / entity number. 0 if not used
[true / false] - lerp after. True, it will smooth transition back, false and it will zip back.
[true / false] - if true, keep cursor hidden after cinematic (not reccomended)


StopAmbient



extern stopambient [scriptname]
(i.e. "extern stopambient tensil/bird002")

Used to stop an ambient that is currently playing / looping.

[scriptname] - cannot be a string / variable