aom.scripting.xs.tr

Class Cinematic

Object

Cinematic

public class Cinematic
extends Object

This class provides a collection of Trigger commands concerning Cinematics, the Camera and Waypoints.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Method Summary

Modifier and Type	Method and Description
void	trCameraCut(vector pos, vector dir, vector up, vector right) Puts the camera in the specified location
void	trCameraShake(float duration, float strength) Makes the camera shake.
void	trCamTrackLoad(string filename) Loads a camera track.
void	trCamTrackPlay(float duration, int eventID) Plays the current camera track.
bool	trCinematicAbort() Returns the abort cinematic status.
void	trCinematicDoAbort() Aborts the cinematic.
void	trForceNonCinematicModels() Forces models to be in non-cinematic mode.
void	trLetterBox(bool on) Turns letter box mode on or off.
void	trOverlayText(string message, float duration, int x, int y, int width) Puts up a big movie-credits style text overlay, optionally in a strange location.
void	trOverlayTextColour(float r, float g, float b) Sets the overlay text colour.
void	trWaypointAddPoint(vector a) Adds the waypoint into the trigger selection system.
void	trWaypointAddUnit(string unitScenarioName) Adds the unit's position as a waypoint in the trigger selection system.
void	trWaypointClear() Clears the waypoints in the trigger selection system

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

trCameraCut

public void trCameraCut(vector pos,
                        vector dir,
                        vector up,
                        vector right)

Puts the camera in the specified location

trCameraShake

public void trCameraShake(float duration,
                          float strength)

Makes the camera shake.

trCamTrackLoad

public void trCamTrackLoad(string filename)

Loads a camera track.

trCamTrackPlay

public void trCamTrackPlay(float duration,
                           int eventID)

Plays the current camera track.

trCinematicAbort

public bool trCinematicAbort()

Returns the abort cinematic status.

trCinematicDoAbort

public void trCinematicDoAbort()

Aborts the cinematic.

trForceNonCinematicModels

public void trForceNonCinematicModels()

Forces models to be in non-cinematic mode.

trLetterBox

public void trLetterBox(bool on)

Turns letter box mode on or off.

trOverlayText

public void trOverlayText(string message,
                          float duration,
                          int x,
                          int y,
                          int width)

Puts up a big movie-credits style text overlay, optionally in a strange location.

trOverlayTextColour

public void trOverlayTextColour(float r,
                                float g,
                                float b)

Sets the overlay text colour.

Since:

AoM:EE

trWaypointAddPoint

public void trWaypointAddPoint(vector a)

Adds the waypoint into the trigger selection system.

trWaypointAddUnit

public void trWaypointAddUnit(string unitScenarioName)

Adds the unit's position as a waypoint in the trigger selection system.

trWaypointClear

public void trWaypointClear()

Clears the waypoints in the trigger selection system