Class Camera

Hierarchy

Camera

Accessors

`Static` boundMaxX

get boundMaxX(): number
Returns number
- Defined in w3ts/handles/camera.ts:26

`Static` boundMaxY

get boundMaxY(): number
Returns number
- Defined in w3ts/handles/camera.ts:30

`Static` boundMinX

get boundMinX(): number
Returns number
- Defined in w3ts/handles/camera.ts:18

`Static` boundMinY

get boundMinY(): number
Returns number
- Defined in w3ts/handles/camera.ts:22

`Static` eyePoint

get eyePoint(): location
Returns location
- Defined in w3ts/handles/camera.ts:58

`Static` eyeX

get eyeX(): number
Returns number
- Defined in w3ts/handles/camera.ts:46

`Static` eyeY

get eyeY(): number
Returns number
- Defined in w3ts/handles/camera.ts:50

`Static` eyeZ

get eyeZ(): number
Returns number
- Defined in w3ts/handles/camera.ts:54

`Static` targetPoint

get targetPoint(): Point
Returns Point
- Defined in w3ts/handles/camera.ts:62

`Static` targetX

get targetX(): number
Returns number
- Defined in w3ts/handles/camera.ts:34

`Static` targetY

get targetY(): number
Returns number
- Defined in w3ts/handles/camera.ts:38

`Static` targetZ

get targetZ(): number
Returns number
- Defined in w3ts/handles/camera.ts:42

`Static` visible

get visible(): boolean
Returns boolean
- Defined in w3ts/handles/camera.ts:14
set visible(flag: boolean): void
Parameters
- flag: boolean
Returns void
- Defined in w3ts/handles/camera.ts:10

Methods

`Static` SetCinematicScene

SetCinematicScene(portraitUnitId: string | number, color: playercolor, speakerTitle: string, text: string, sceneDuration: number, voiceoverDuration: number): void
Parameters
- portraitUnitId: string | number
- color: playercolor
- speakerTitle: string
- text: string
- sceneDuration: number
- voiceoverDuration: number
Returns void
- Defined in w3ts/handles/camera.ts:150

`Static` adjustField

adjustField(whichField: camerafield, offset: number, duration: number): void
Parameters
- whichField: camerafield
- offset: number
- duration: number
Returns void
- Defined in w3ts/handles/camera.ts:66

`Static` endCinematicScene

endCinematicScene(): void
Returns void
- Defined in w3ts/handles/camera.ts:70

`Static` forceCinematicSubtitles

forceCinematicSubtitles(flag: boolean): void
Parameters
- flag: boolean
Returns void
- Defined in w3ts/handles/camera.ts:74

`Static` getMargin

getMargin(whichMargin: number): number
Parameters
- whichMargin: number
Returns number
- Defined in w3ts/handles/camera.ts:78

`Static` pan

pan(x: number, y: number, zOffsetDest: number): void
Parameters
- x: number
- y: number
- zOffsetDest: number
Returns void
- Defined in w3ts/handles/camera.ts:82

`Static` panTimed

panTimed(x: number, y: number, duration: number, zOffsetDest: number): void
Parameters
- x: number
- y: number
- duration: number
- zOffsetDest: number
Returns void
- Defined in w3ts/handles/camera.ts:90

`Static` reset

reset(duration: number): void
Parameters
- duration: number
Returns void
- Defined in w3ts/handles/camera.ts:98

`Static` setBounds

setBounds(x1: number, y1: number, x2: number, y2: number, x3: number, y3: number, x4: number, y4: number): void
Parameters
- x1: number
- y1: number
- x2: number
- y2: number
- x3: number
- y3: number
- x4: number
- y4: number
Returns void
- Defined in w3ts/handles/camera.ts:102

`Static` setCameraOrientController

setCameraOrientController(whichUnit: unit, xOffset: number, yOffset: number): void
Parameters
- whichUnit: unit
- xOffset: number
- yOffset: number
Returns void
- Defined in w3ts/handles/camera.ts:106

`Static` setCineFilterBlendMode

setCineFilterBlendMode(whichMode: blendmode): void
Parameters
- whichMode: blendmode
Returns void
- Defined in w3ts/handles/camera.ts:110

`Static` setCineFilterDuration

setCineFilterDuration(duration: number): void
Parameters
- duration: number
Returns void
- Defined in w3ts/handles/camera.ts:114

`Static` setCineFilterEndColor

setCineFilterEndColor(red: number, green: number, blue: number, alpha: number): void
Parameters
- red: number
- green: number
- blue: number
- alpha: number
Returns void
- Defined in w3ts/handles/camera.ts:118

`Static` setCineFilterEndUV

setCineFilterEndUV(minU: number, minV: number, maxU: number, maxV: number): void
Parameters
- minU: number
- minV: number
- maxU: number
- maxV: number
Returns void
- Defined in w3ts/handles/camera.ts:122

`Static` setCineFilterStartColor

setCineFilterStartColor(red: number, green: number, blue: number, alpha: number): void
Parameters
- red: number
- green: number
- blue: number
- alpha: number
Returns void
- Defined in w3ts/handles/camera.ts:126

`Static` setCineFilterStartUV

setCineFilterStartUV(minU: number, minV: number, maxU: number, maxV: number): void
Parameters
- minU: number
- minV: number
- maxU: number
- maxV: number
Returns void
- Defined in w3ts/handles/camera.ts:130

`Static` setCineFilterTexMapFlags

setCineFilterTexMapFlags(whichFlags: texmapflags): void
Parameters
- whichFlags: texmapflags
Returns void
- Defined in w3ts/handles/camera.ts:134

`Static` setCineFilterTexture

setCineFilterTexture(fileName: string): void
Parameters
- fileName: string
Returns void
- Defined in w3ts/handles/camera.ts:138

`Static` setCinematicCamera

setCinematicCamera(cameraModelFile: string): void
Parameters
- cameraModelFile: string
Returns void
- Defined in w3ts/handles/camera.ts:146

`Static` setField

setField(whichField: camerafield, value: number, duration: number): void
Parameters
- whichField: camerafield
- value: number
- duration: number
Returns void
- Defined in w3ts/handles/camera.ts:158

`Static` setPos

setPos(x: number, y: number): void
Parameters
- x: number
- y: number
Returns void
- Defined in w3ts/handles/camera.ts:166

`Static` setRotateMode

setRotateMode(x: number, y: number, radiansToSweep: number, duration: number): void
Parameters
- x: number
- y: number
- radiansToSweep: number
- duration: number
Returns void
- Defined in w3ts/handles/camera.ts:170

`Static` setSmoothingFactor

setSmoothingFactor(factor: number): void
Parameters
- factor: number
Returns void
- Defined in w3ts/handles/camera.ts:174

`Static` setSourceNoise

setSourceNoise(mag: number, velocity: number, vertOnly?: boolean): void
Parameters
- mag: number
- velocity: number
- vertOnly: boolean = false
Returns void
- Defined in w3ts/handles/camera.ts:178

`Static` setTargetController

setTargetController(whichUnit: unit, xOffset: number, yOffset: number, inheritOrientation: boolean): void
Parameters
- whichUnit: unit
- xOffset: number
- yOffset: number
- inheritOrientation: boolean
Returns void
- Defined in w3ts/handles/camera.ts:182

`Static` setTargetNoise

setTargetNoise(mag: number, velocity: number, vertOnly?: boolean): void
Parameters
- mag: number
- velocity: number
- vertOnly: boolean = false
Returns void
- Defined in w3ts/handles/camera.ts:186

`Static` stop

stop(): void
Returns void
- Defined in w3ts/handles/camera.ts:190