V5 DocsAthenaClient.camera.pedEdit ​
Functions ​
calculateCamOffset ​
Usage
AthenaClient.camera.pedEdit.calculateCamOffset(offset): alt.IVector3
Calculates a camera offset.
Static
Parameters ​
| Name | Type |
|---|---|
offset | IVector3 |
Returns ​
alt.IVector3
Defined in ​
create ​
Usage
AthenaClient.camera.pedEdit.create(_scriptID, offset?, _isLocalPlayer?): Promise<void>
Creates a Pedestrian Edit Camera
Static
Parameters ​
| Name | Type | Default value |
|---|---|---|
_scriptID | number | undefined |
offset? | IVector3 | null |
_isLocalPlayer | boolean | false |
Returns ​
Promise<void>
Defined in ​
destroy ​
Usage
AthenaClient.camera.pedEdit.destroy(): any
Destroy the Ped Edit Camera
Static
Returns ​
any
Defined in ​
disableControls ​
Usage
AthenaClient.camera.pedEdit.disableControls(status): void
Disable All Controls?
Static
Parameters ​
| Name | Type |
|---|---|
status | boolean |
Returns ​
void
Defined in ​
exists ​
Usage
AthenaClient.camera.pedEdit.exists(): any
Check if a PedEditCamera exists.
Static
Returns ​
any
Defined in ​
handleControls ​
Usage
AthenaClient.camera.pedEdit.handleControls(): any
Returns ​
any
Defined in ​
override ​
Usage
AthenaClient.camera.pedEdit.override(functionName, callback): any
Parameters ​
| Name | Type |
|---|---|
functionName | "create" |
callback | (_scriptID: number, offset?: IVector3, _isLocalPlayer: boolean) => Promise<void> |
Returns ​
any
Defined in ​
Usage
AthenaClient.camera.pedEdit.override(functionName, callback): any
Parameters ​
| Name | Type |
|---|---|
functionName | "destroy" |
callback | () => any |
Returns ​
any
Defined in ​
Usage
AthenaClient.camera.pedEdit.override(functionName, callback): any
Parameters ​
| Name | Type |
|---|---|
functionName | "disableControls" |
callback | (status: boolean) => void |
Returns ​
any
Defined in ​
Usage
AthenaClient.camera.pedEdit.override(functionName, callback): any
Parameters ​
| Name | Type |
|---|---|
functionName | "update" |
callback | (id: number) => any |
Returns ​
any
Defined in ​
Usage
AthenaClient.camera.pedEdit.override(functionName, callback): any
Parameters ​
| Name | Type |
|---|---|
functionName | "handleControls" |
callback | () => any |
Returns ​
any
Defined in ​
Usage
AthenaClient.camera.pedEdit.override(functionName, callback): any
Parameters ​
| Name | Type |
|---|---|
functionName | "exists" |
callback | () => any |
Returns ​
any
Defined in ​
Usage
AthenaClient.camera.pedEdit.override(functionName, callback): any
Parameters ​
| Name | Type |
|---|---|
functionName | "runQueue" |
callback | () => any |
Returns ​
any
Defined in ​
Usage
AthenaClient.camera.pedEdit.override(functionName, callback): any
Parameters ​
| Name | Type |
|---|---|
functionName | "setCameraOffset" |
callback | (offset: IVector3) => any |
Returns ​
any
Defined in ​
Usage
AthenaClient.camera.pedEdit.override(functionName, callback): any
Parameters ​
| Name | Type |
|---|---|
functionName | "setCamParams" |
callback | (_zpos: number, _fov: number, _easeTime: number) => any |
Returns ​
any
Defined in ​
runQueue ​
Usage
AthenaClient.camera.pedEdit.runQueue(): any
Returns ​
any
Defined in ​
setCamParams ​
Usage
AthenaClient.camera.pedEdit.setCamParams(_zpos?, _fov?, _easeTime?): any
Set the Camera Field of View
Static
Parameters ​
| Name | Type | Default value |
|---|---|---|
_zpos | number | null |
_fov | number | null |
_easeTime | number | 500 |
Returns ​
any
Defined in ​
setCameraOffset ​
Usage
AthenaClient.camera.pedEdit.setCameraOffset(offset): any
Sets up the camera with the original position and a new offset.
Static
Parameters ​
| Name | Type |
|---|---|
offset | IVector3 |
Returns ​
any
Defined in ​
update ​
Usage
AthenaClient.camera.pedEdit.update(id): any
Update the ScriptID for who we should use to rotate.
Static
Parameters ​
| Name | Type |
|---|---|
id | number |
Returns ​
any