com.GameInterface.Game.Camera

Summary

com.GameInterface.Game.Camera
Variables
m_Pos	These static variables are updated every 0.5 sec with info about cameras current posistion and rotation.
m_AngleY	The cameras angle around the y axis.
m_CinematicStripHeight	The height of one black part of the cinematic letterbox.
SignalCinematicActivated	Signal send when cinematic is started or ended.
Functions
RunCameraPath	Runs a camerapath.
PlaceCamera	Place the cinematic camera at a position looking at something.
SetFOV	Set field of view for the cinematic camera.
RequestCameraPosRotUpdates	Tell gamecode to start filling m_Pos and m_AngleY every interval.
GetZoom	Get the zoom position of the camera

Variables

m_Pos

public static var m_Pos: Vector3

These static variables are updated every 0.5 sec with info about cameras current posistion and rotation. NOTE: You must first call RequestCameraPosRotUpdates( true ) once to start the timer.

m_AngleY

public static var m_AngleY

The cameras angle around the y axis. In radians.

m_CinematicStripHeight

public static var m_CinematicStripHeight

The height of one black part of the cinematic letterbox. This number is always up to date.

SignalCinematicActivated

public static var SignalCinematicActivated: Signal

Signal send when cinematic is started or ended.

Parameters

activated

:Number 1 if started, 0 if ended.

Functions

RunCameraPath

public static function RunCameraPath(
    pathName: String,
    switchToDefaultCamWhenDone: Boolean,
    initialPosition: Number,
    targetPosition: Number
) : Void

Runs a camerapath.

Parameters

pathName	:String Path to play.
switchToDefaultCamWhenDone	:Boolean Set camera back?
initialPosition	:Number Start pos on the path.
targetPosition	:Number End pos on the path.

PlaceCamera

public static function PlaceCamera( posX: Number,
posY: Number,
posZ: Number,
offsetX: Number,
offsetY: Number,
offsetZ: Number,
upX: Number,
upY: Number,
upZ: Number ) : Void

Place the cinematic camera at a position looking at something.

Parameters

posX	:Number The new position of the camera in world coordinates.
offsetX	:Number The position to look at in world coordinates.

SetFOV

public static function SetFOV( fov: Number ) : Void

Set field of view for the cinematic camera.

Parameters

fov	:Number The fov. Hopefully reset everytime a new cinematic is started.

RequestCameraPosRotUpdates

public static function RequestCameraPosRotUpdates( startUpdates: Boolean ) : Void

Tell gamecode to start filling m_Pos and m_AngleY every interval.

Parameters

startUpdates

:Boolean True to start it, false to end it.

GetZoom

public static function GetZoom( ) : Number

Get the zoom position of the camera