autodoc_client_functions

JO Functions > jo.camera.freeCamera.getCam()

A function to get the freecam camera <br>

JO Functions > jo.camera.freeCamera.getCam() > Syntax

jo.camera.freeCamera.getCam()

JO Functions > jo.camera.freeCamera.getCam() > Return Value

Type : integer

The camera id

JO Functions > jo.camera.freeCamera.getPromptGroup()

A function to get the freecam prompt group <br>

JO Functions > jo.camera.freeCamera.getPromptGroup() > Syntax

jo.camera.freeCamera.getPromptGroup()

JO Functions > jo.camera.freeCamera.getPromptGroup() > Return Value

Type : string

The prompt group name

JO Functions > jo.camera.freeCamera.isActive()

A function to check if the freecam is active <br>

JO Functions > jo.camera.freeCamera.isActive() > Syntax

jo.camera.freeCamera.isActive()

JO Functions > jo.camera.freeCamera.isActive() > Return Value

Type : boolean

Whether the freecam is active

JO Functions > jo.camera.freeCamera.isLocked()

A function to check if the freecam rotation is locked <br>

JO Functions > jo.camera.freeCamera.isLocked() > Syntax

jo.camera.freeCamera.isLocked()

JO Functions > jo.camera.freeCamera.isLocked() > Return Value

Type : boolean

Whether the freecam rotation is locked

JO Functions > jo.camera.freeCamera.lockRotate()

A function to lock the freecam rotation <br>

JO Functions > jo.camera.freeCamera.lockRotate() > Syntax

jo.camera.freeCamera.lockRotate()

JO Functions > jo.camera.freeCamera.start()

A function to start the freecam <br>

<Badge type="alias" text="Alias" /> jo.freecam() & jo.camera.freeCamera()

JO Functions > jo.camera.freeCamera.start() > Syntax

jo.camera.freeCamera.start(options)

JO Functions > jo.camera.freeCamera.start() > Parameters

options : table <BadgeOptional />

The freecam option options

options.interpolate : number - The interpolate time - default 0

options.showPrompts : boolean - Whether to show prompts - default true

options.range : number - The range of the freecam - default 10000

JO Functions > jo.camera.freeCamera.stop() > Syntax

jo.camera.freeCamera.stop()

JO Functions > jo.camera.freeCamera.unlockRotate()

A function to unlock the freecam rotation <br>

JO Functions > jo.camera.freeCamera.unlockRotate() > Syntax

jo.camera.freeCamera.unlockRotate()