Skip to content
On this page

AthenaClient.camera.pedEdit

Functions

calculateCamOffset

Usage

AthenaClient.camera.pedEdit.calculateCamOffset(offset): alt.IVector3

Calculates a camera offset.

Static

Parameters

NameType
offsetIVector3

Returns

alt.IVector3

Defined in

client/camera/pedEdit.ts:86


create

Usage

AthenaClient.camera.pedEdit.create(_scriptID, offset?, _isLocalPlayer?): Promise<void>

Creates a Pedestrian Edit Camera

Static

Parameters

NameTypeDefault value
_scriptIDnumberundefined
offset?IVector3null
_isLocalPlayerbooleanfalse

Returns

Promise<void>

Defined in

client/camera/pedEdit.ts:26


destroy

Usage

AthenaClient.camera.pedEdit.destroy(): any

Destroy the Ped Edit Camera

Static

Returns

any

Defined in

client/camera/pedEdit.ts:135


disableControls

Usage

AthenaClient.camera.pedEdit.disableControls(status): void

Disable All Controls?

Static

Parameters

NameType
statusboolean

Returns

void

Defined in

client/camera/pedEdit.ts:171


exists

Usage

AthenaClient.camera.pedEdit.exists(): any

Check if a PedEditCamera exists.

Static

Returns

any

Defined in

client/camera/pedEdit.ts:122


handleControls

Usage

AthenaClient.camera.pedEdit.handleControls(): any

Returns

any

Defined in

client/camera/pedEdit.ts:264


override

Usage

AthenaClient.camera.pedEdit.override(functionName, callback): any

Parameters

NameType
functionName"create"
callback(_scriptID: number, offset?: IVector3, _isLocalPlayer: boolean) => Promise<void>

Returns

any

Defined in

client/camera/pedEdit.ts:424

Usage

AthenaClient.camera.pedEdit.override(functionName, callback): any

Parameters

NameType
functionName"destroy"
callback() => any

Returns

any

Defined in

client/camera/pedEdit.ts:425

Usage

AthenaClient.camera.pedEdit.override(functionName, callback): any

Parameters

NameType
functionName"disableControls"
callback(status: boolean) => void

Returns

any

Defined in

client/camera/pedEdit.ts:426

Usage

AthenaClient.camera.pedEdit.override(functionName, callback): any

Parameters

NameType
functionName"update"
callback(id: number) => any

Returns

any

Defined in

client/camera/pedEdit.ts:427

Usage

AthenaClient.camera.pedEdit.override(functionName, callback): any

Parameters

NameType
functionName"handleControls"
callback() => any

Returns

any

Defined in

client/camera/pedEdit.ts:428

Usage

AthenaClient.camera.pedEdit.override(functionName, callback): any

Parameters

NameType
functionName"exists"
callback() => any

Returns

any

Defined in

client/camera/pedEdit.ts:429

Usage

AthenaClient.camera.pedEdit.override(functionName, callback): any

Parameters

NameType
functionName"runQueue"
callback() => any

Returns

any

Defined in

client/camera/pedEdit.ts:430

Usage

AthenaClient.camera.pedEdit.override(functionName, callback): any

Parameters

NameType
functionName"setCameraOffset"
callback(offset: IVector3) => any

Returns

any

Defined in

client/camera/pedEdit.ts:431

Usage

AthenaClient.camera.pedEdit.override(functionName, callback): any

Parameters

NameType
functionName"setCamParams"
callback(_zpos: number, _fov: number, _easeTime: number) => any

Returns

any

Defined in

client/camera/pedEdit.ts:432


runQueue

Usage

AthenaClient.camera.pedEdit.runQueue(): any

Returns

any

Defined in

client/camera/pedEdit.ts:201


setCamParams

Usage

AthenaClient.camera.pedEdit.setCamParams(_zpos?, _fov?, _easeTime?): any

Set the Camera Field of View

Static

Parameters

NameTypeDefault value
_zposnumbernull
_fovnumbernull
_easeTimenumber500

Returns

any

Defined in

client/camera/pedEdit.ts:185


setCameraOffset

Usage

AthenaClient.camera.pedEdit.setCameraOffset(offset): any

Sets up the camera with the original position and a new offset.

Static

Parameters

NameType
offsetIVector3

Returns

any

Defined in

client/camera/pedEdit.ts:105


update

Usage

AthenaClient.camera.pedEdit.update(id): any

Update the ScriptID for who we should use to rotate.

Static

Parameters

NameType
idnumber

Returns

any

Defined in

client/camera/pedEdit.ts:256

Created by Stuyk | Est. 2020