Class: Camera#

Hierarchy#

Camera

Accessors#

boundMaxX#

static boundMaxX(): number

Return-value for the local players camera only.

Returns: number

_{Defined in: handles/camera.ts:34}

boundMaxY#

static boundMaxY(): number

Returns: number

_{Defined in: handles/camera.ts:38}

boundMinX#

static boundMinX(): number

Return-value for the local players camera only.

Returns: number

_{Defined in: handles/camera.ts:20}

boundMinY#

static boundMinY(): number

Return-value for the local players camera only.

Returns: number

_{Defined in: handles/camera.ts:27}

eyePoint#

static eyePoint(): Point

Return-value for the local players camera only.

Returns: Point

_{Defined in: handles/camera.ts:87}

eyeX#

static eyeX(): number

Return-value for the local players camera only.

Returns: number

_{Defined in: handles/camera.ts:66}

eyeY#

static eyeY(): number

Return-value for the local players camera only.

Returns: number

_{Defined in: handles/camera.ts:73}

eyeZ#

static eyeZ(): number

Return-value for the local players camera only.

Returns: number

_{Defined in: handles/camera.ts:80}

targetPoint#

static targetPoint(): Point

Return-value for the local players camera only.

Returns: Point

_{Defined in: handles/camera.ts:94}

targetX#

static targetX(): number

Return-value for the local players camera only.

Returns: number

_{Defined in: handles/camera.ts:45}

targetY#

static targetY(): number

Return-value for the local players camera only.

Returns: number

_{Defined in: handles/camera.ts:52}

targetZ#

static targetZ(): number

Return-value for the local players camera only.

Returns: number

_{Defined in: handles/camera.ts:59}

visible#

static visible(): boolean

Returns: boolean

_{Defined in: handles/camera.ts:13}

static visible(flag: boolean): void

Parameters:#

Name	Type
`flag`	boolean

Returns: void

_{Defined in: handles/camera.ts:9}

Methods#

SetCinematicScene#

static SetCinematicScene(portraitUnitId: number, color: playercolor, speakerTitle: string, text: string, sceneDuration: number, voiceoverDuration: number): void

Parameters:#

Name	Type
`portraitUnitId`	number
`color`	playercolor
`speakerTitle`	string
`text`	string
`sceneDuration`	number
`voiceoverDuration`	number

Returns: void

_{Defined in: handles/camera.ts:195}

adjustField#

static adjustField(whichField: camerafield, offset: number, duration: number): void

Changes one of the game camera's options whichField by offset over duration seconds.

Parameters:#

Name	Type	Description
`whichField`	camerafield
`offset`	number
`duration`	number

Returns: void

_{Defined in: handles/camera.ts:104}

endCinematicScene#

static endCinematicScene(): void

Returns: void

_{Defined in: handles/camera.ts:108}

forceCinematicSubtitles#

static forceCinematicSubtitles(flag: boolean): void

Parameters:#

Name	Type
`flag`	boolean

Returns: void

_{Defined in: handles/camera.ts:112}

getField#

static getField(field: camerafield): number

Return-value for the local players camera only.

Parameters:#

Name	Type
`field`	camerafield

Returns: number

_{Defined in: handles/camera.ts:119}

getMargin#

static getMargin(whichMargin: number): number

Parameters:#

Name	Type
`whichMargin`	number

Returns: number

_{Defined in: handles/camera.ts:123}

pan#

static pan(x: number, y: number, zOffsetDest: undefined | number): void

Parameters:#

Name	Type
`x`	number
`y`	number
`zOffsetDest`	undefined \| number

Returns: void

_{Defined in: handles/camera.ts:127}

panTimed#

static panTimed(x: number, y: number, duration: number, zOffsetDest: undefined | number): void

Parameters:#

Name	Type
`x`	number
`y`	number
`duration`	number
`zOffsetDest`	undefined \| number

Returns: void

_{Defined in: handles/camera.ts:135}

reset#

static reset(duration: number): void

Parameters:#

Name	Type
`duration`	number

Returns: void

_{Defined in: handles/camera.ts:143}

setBounds#

static setBounds(x1: number, y1: number, x2: number, y2: number, x3: number, y3: number, x4: number, y4: number): void

Parameters:#

Name	Type
`x1`	number
`y1`	number
`x2`	number
`y2`	number
`x3`	number
`y3`	number
`x4`	number
`y4`	number

Returns: void

_{Defined in: handles/camera.ts:147}

setCameraOrientController#

static setCameraOrientController(whichUnit: unit, xOffset: number, yOffset: number): void

Parameters:#

Name	Type
`whichUnit`	unit
`xOffset`	number
`yOffset`	number

Returns: void

_{Defined in: handles/camera.ts:151}

setCineFilterBlendMode#

static setCineFilterBlendMode(whichMode: blendmode): void

Parameters:#

Name	Type
`whichMode`	blendmode

Returns: void

_{Defined in: handles/camera.ts:155}

setCineFilterDuration#

static setCineFilterDuration(duration: number): void

Parameters:#

Name	Type
`duration`	number

Returns: void

_{Defined in: handles/camera.ts:159}

setCineFilterEndColor#

static setCineFilterEndColor(red: number, green: number, blue: number, alpha: number): void

Parameters:#

Name	Type
`red`	number
`green`	number
`blue`	number
`alpha`	number

Returns: void

_{Defined in: handles/camera.ts:163}

setCineFilterEndUV#

static setCineFilterEndUV(minU: number, minV: number, maxU: number, maxV: number): void

Parameters:#

Name	Type
`minU`	number
`minV`	number
`maxU`	number
`maxV`	number

Returns: void

_{Defined in: handles/camera.ts:167}

setCineFilterStartColor#

static setCineFilterStartColor(red: number, green: number, blue: number, alpha: number): void

Parameters:#

Name	Type
`red`	number
`green`	number
`blue`	number
`alpha`	number

Returns: void

_{Defined in: handles/camera.ts:171}

setCineFilterStartUV#

static setCineFilterStartUV(minU: number, minV: number, maxU: number, maxV: number): void

Parameters:#

Name	Type
`minU`	number
`minV`	number
`maxU`	number
`maxV`	number

Returns: void

_{Defined in: handles/camera.ts:175}

setCineFilterTexMapFlags#

static setCineFilterTexMapFlags(whichFlags: texmapflags): void

Parameters:#

Name	Type
`whichFlags`	texmapflags

Returns: void

_{Defined in: handles/camera.ts:179}

setCineFilterTexture#

static setCineFilterTexture(fileName: string): void

Parameters:#

Name	Type
`fileName`	string

Returns: void

_{Defined in: handles/camera.ts:183}

setCinematicAudio#

static setCinematicAudio(cinematicAudio: boolean): void

Parameters:#

Name	Type
`cinematicAudio`	boolean

Returns: void

_{Defined in: handles/camera.ts:187}

setCinematicCamera#

static setCinematicCamera(cameraModelFile: string): void

Parameters:#

Name	Type
`cameraModelFile`	string

Returns: void

_{Defined in: handles/camera.ts:191}

setDepthOfFieldScale#

static setDepthOfFieldScale(scale: number): void

Parameters:#

Name	Type
`scale`	number

Returns: void

_{Defined in: handles/camera.ts:199}

setField#

static setField(whichField: camerafield, value: number, duration: number): void

Parameters:#

Name	Type
`whichField`	camerafield
`value`	number
`duration`	number

Returns: void

_{Defined in: handles/camera.ts:203}

setFocalDistance#

static setFocalDistance(distance: number): void

Parameters:#

Name	Type
`distance`	number

Returns: void

_{Defined in: handles/camera.ts:207}

setPos#

static setPos(x: number, y: number): void

Parameters:#

Name	Type
`x`	number
`y`	number

Returns: void

_{Defined in: handles/camera.ts:211}

setRotateMode#

static setRotateMode(x: number, y: number, radiansToSweep: number, duration: number): void

Parameters:#

Name	Type
`x`	number
`y`	number
`radiansToSweep`	number
`duration`	number

Returns: void

_{Defined in: handles/camera.ts:215}

setSmoothingFactor#

static setSmoothingFactor(factor: number): void

Parameters:#

Name	Type
`factor`	number

Returns: void

_{Defined in: handles/camera.ts:219}

setSourceNoise#

static setSourceNoise(mag: number, velocity: number, vertOnly?: boolean): void

Parameters:#

Name	Type	Default value
`mag`	number	-
`velocity`	number	-
`vertOnly`	boolean	false

Returns: void

_{Defined in: handles/camera.ts:223}

setTargetController#

static setTargetController(whichUnit: unit, xOffset: number, yOffset: number, inheritOrientation: boolean): void

Parameters:#

Name	Type
`whichUnit`	unit
`xOffset`	number
`yOffset`	number
`inheritOrientation`	boolean

Returns: void

_{Defined in: handles/camera.ts:227}

setTargetNoise#

static setTargetNoise(mag: number, velocity: number, vertOnly?: boolean): void

Parameters:#

Name	Type	Default value
`mag`	number	-
`velocity`	number	-
`vertOnly`	boolean	false

Returns: void

_{Defined in: handles/camera.ts:231}

stop#

static stop(): void

Returns: void

_{Defined in: handles/camera.ts:235}