V5 DocsAthenaClient.camera.cinematic ​
Interfaces ​
Functions ​
addNode ​
Usage
AthenaClient.camera.cinematic.addNode(node): any
Add a camera node to the camera set.
Parameters ​
| Name | Type |
|---|---|
node | iCameraNode |
Returns ​
any
Defined in ​
client/camera/cinematic.ts:327
destroy ​
Usage
AthenaClient.camera.cinematic.destroy(): Promise<void>
This function will destroy all camera instances
Returns ​
Promise<void>
Defined in ​
client/camera/cinematic.ts:305
next ​
Usage
AthenaClient.camera.cinematic.next(removeFromArray?): Promise<boolean>
Goes to the next camera.
If false is passed in the function it will not remove a camera from the camera array. Allows for repeating camera movement over and over.
Parameters ​
| Name | Type | Default value |
|---|---|---|
removeFromArray? | boolean | true |
Returns ​
Promise<boolean>
Defined in ​
client/camera/cinematic.ts:357
override ​
Usage
AthenaClient.camera.cinematic.override(functionName, callback): any
Parameters ​
| Name | Type |
|---|---|
functionName | "addNode" |
callback | (node: iCameraNode) => any |
Returns ​
any
Defined in ​
client/camera/cinematic.ts:490
Usage
AthenaClient.camera.cinematic.override(functionName, callback): any
Parameters ​
| Name | Type |
|---|---|
functionName | "destroy" |
callback | () => Promise<void> |
Returns ​
any
Defined in ​
client/camera/cinematic.ts:491
Usage
AthenaClient.camera.cinematic.override(functionName, callback): any
Parameters ​
| Name | Type |
|---|---|
functionName | "overrideNodes" |
callback | (_nodes: iCameraNode[]) => any |
Returns ​
any
Defined in ​
client/camera/cinematic.ts:492
Usage
AthenaClient.camera.cinematic.override(functionName, callback): any
Parameters ​
| Name | Type |
|---|---|
functionName | "next" |
callback | (removeFromArray?: boolean) => Promise<boolean> |
Returns ​
any
Defined in ​
client/camera/cinematic.ts:493
Usage
AthenaClient.camera.cinematic.override(functionName, callback): any
Parameters ​
| Name | Type |
|---|---|
functionName | "switchNode" |
callback | (index: number, removeFromArray?: boolean) => Promise<boolean | (index: number, removeFromArray?: boolean) => Promise<boolean | typeof switchNode>> |
Returns ​
any
Defined in ​
client/camera/cinematic.ts:494
Usage
AthenaClient.camera.cinematic.override(functionName, callback): any
Parameters ​
| Name | Type |
|---|---|
functionName | "previous" |
callback | (removeFromArray?: boolean) => Promise<boolean> |
Returns ​
any
Defined in ​
client/camera/cinematic.ts:495
Usage
AthenaClient.camera.cinematic.override(functionName, callback): any
Parameters ​
| Name | Type |
|---|---|
functionName | "play" |
callback | () => any |
Returns ​
any
Defined in ​
client/camera/cinematic.ts:496
overrideNodes ​
Usage
AthenaClient.camera.cinematic.overrideNodes(_nodes): any
Parameters ​
| Name | Type |
|---|---|
_nodes | iCameraNode[] |
Returns ​
any
Defined in ​
client/camera/cinematic.ts:313
play ​
Usage
AthenaClient.camera.cinematic.play(): any
Play all camera nodes, but do not clear the camera nodes array.
Returns ​
any
Defined in ​
client/camera/cinematic.ts:466
previous ​
Usage
AthenaClient.camera.cinematic.previous(removeFromArray?): Promise<boolean>
Goes to the previous camera.
If false is passed in the function it will not remove a camera from the camera array. Allows for repeating camera movement over and over.
Parameters ​
| Name | Type | Default value |
|---|---|---|
removeFromArray? | boolean | true |
Returns ​
Promise<boolean>
Defined in ​
client/camera/cinematic.ts:433
switchNode ​
Usage
AthenaClient.camera.cinematic.switchNode(index, removeFromArray?): Promise<boolean | (index: number, removeFromArray?: boolean) => Promise<boolean | (index: number, removeFromArray?: boolean) => Promise<boolean | typeof switchNode>>>
Goes to the index specified camera.
If false is passed in the function it will not remove a camera from the camera array. Allows for repeating camera movement over and over.
Parameters ​
| Name | Type | Default value |
|---|---|---|
index | number | undefined |
removeFromArray? | boolean | true |
Returns ​
Promise<boolean | (index: number, removeFromArray?: boolean) => Promise<boolean | (index: number, removeFromArray?: boolean) => Promise<boolean | typeof switchNode>>>