anachronox-sdk/docs/ape_cinematics.htm

122 lines
5.6 KiB
HTML

<html>
<head>
<title>Playing Cinematics using A.P.E.</title>
</head>
<body bgcolor="#000000" text="#FFFFFF" font="arial" VLINK="#6666ff" alink="#FF0000">
<FONT FACE="Arial" SIZE="3">
<p>
<font size=6 style="Times New Roman" color=#ff0000>Playing Cinematics using A.P.E.</font>
<p>
<FONT COLOR="#FFFF00"><B>PlayScene</B></FONT><BR>
<HR>
<FONT COLOR="#FF5555"><pre>
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")
</pre></FONT><P>
Used to play a scene, a scene being a cinematic where the camera is controlled by the script.
<P>
<FONT COLOR="#FF5555">[scriptname]</font> - cannot be a string / variable <BR>
<FONT COLOR="#FF5555">[timeoffset]</font> - start playing x seconds into script, normally 0 <BR>
<FONT COLOR="#FF5555">[sequencecallback]</font> - APE sequence to invoke at script end (can be 0:0 if none) <BR>
<FONT COLOR="#FF5555">[targetname / sequence]</font> - source of relative script, use "null" if not relative script. <BR>
<FONT COLOR="#FF5555">[targetname / sequence]</font> - target of relative script, use "null" if not relative script. <BR>
<FONT COLOR="#FF5555">[source rel]</font> - Source of the relative script referred to by index / entity number. 0 if not used <BR>
<FONT COLOR="#FF5555">[target rel]</font> - Target of the relative script referred to by index / entity number. 0 if not used <BR>
<FONT COLOR="#FF5555">[true / false]</font> - lerp after. True, it will smooth transition back, false and it will zip back. <BR>
<FONT COLOR="#FF5555">[true / false]</font> - if true, keep cursor hidden after cinematic (not reccomended) <BR>
<HR>
<p>
<P>
&nbsp;
<P>
<FONT COLOR="#FFFF00"><B>StopScene</B></FONT><BR>
<HR>
<FONT COLOR="#FF5555"><pre>
extern stopscene [scriptname]
(i.e. "extern stopscene tensil/bird002")
</pre></FONT><P>
Used to stop a scene that is currently playing.
<P>
<FONT COLOR="#FF5555">[scriptname]</font> - cannot be a string / variable <BR>
<HR>
<p>
<P>
&nbsp;
<P>
<FONT COLOR="#FFFF00"><B>PlayAmbient</B></FONT><BR>
<HR>
<FONT COLOR="#FF5555"><pre>
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")
</pre></FONT><P>
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.
<P>
<FONT COLOR="#FF5555">[scriptname]</font> - cannot be a string / variable <BR>
<FONT COLOR="#FF5555">[timeoffset]</font> - start playing x seconds into script, normally 0 <BR>
<FONT COLOR="#FF5555">[sequencecallback]</font> - APE sequence to invoke at script end (can be 0:0 if none) <BR>
<FONT COLOR="#FF5555">[targetname / sequence]</font> - source of relative script, use "null" if not relative script. <BR>
<FONT COLOR="#FF5555">[targetname / sequence]</font> - target of relative script, use "null" if not relative script. <BR>
<FONT COLOR="#FF5555">[source rel]</font> - Source of the relative script referred to by index / entity number. 0 if not used <BR>
<FONT COLOR="#FF5555">[target rel]</font> - Target of the relative script referred to by index / entity number. 0 if not used <BR>
<FONT COLOR="#FF5555">[true / false]</font> - lerp after. True, it will smooth transition back, false and it will zip back. <BR>
<FONT COLOR="#FF5555">[true / false]</font> - if true, keep cursor hidden after cinematic (not reccomended) <BR>
<HR>
<p>
<P>
&nbsp;
<P>
<FONT COLOR="#FFFF00"><B>LoopAmbient</B></FONT><BR>
<HR>
<FONT COLOR="#FF5555"><pre>
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")
</pre></FONT><P>
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.
<P>
<FONT COLOR="#FF5555">[scriptname]</font> - cannot be a string / variable <BR>
<FONT COLOR="#FF5555">[timeoffset]</font> - start playing x seconds into script, normally 0 <BR>
<FONT COLOR="#FF5555">[sequencecallback]</font> - APE sequence to invoke at script end (can be 0:0 if none) <BR>
<FONT COLOR="#FF5555">[targetname / sequence]</font> - source of relative script, use "null" if not relative script. <BR>
<FONT COLOR="#FF5555">[targetname / sequence]</font> - target of relative script, use "null" if not relative script. <BR>
<FONT COLOR="#FF5555">[source rel]</font> - Source of the relative script referred to by index / entity number. 0 if not used <BR>
<FONT COLOR="#FF5555">[target rel]</font> - Target of the relative script referred to by index / entity number. 0 if not used <BR>
<FONT COLOR="#FF5555">[true / false]</font> - lerp after. True, it will smooth transition back, false and it will zip back. <BR>
<FONT COLOR="#FF5555">[true / false]</font> - if true, keep cursor hidden after cinematic (not reccomended) <BR>
<HR>
<p>
<P>
&nbsp;
<P>
<FONT COLOR="#FFFF00"><B>StopAmbient</B></FONT><BR>
<HR>
<FONT COLOR="#FF5555"><pre>
extern stopambient [scriptname]
(i.e. "extern stopambient tensil/bird002")
</pre></FONT><P>
Used to stop an ambient that is currently playing / looping.
<P>
<FONT COLOR="#FF5555">[scriptname]</font> - cannot be a string / variable <BR>
<HR>
<p>
<P>
&nbsp;
<P>
<P>&nbsp;<P>
</FONT>
</body>
</html>