Header menu logo PhysicsSandbox

ViewCommands Module

Functions and values

Function or value Description

cameraChase session bodyId offset

Full Usage: cameraChase session bodyId offset

Parameters:
    session : Session
    bodyId : string
    offset : float * float * float

Returns: Result<unit, string>
session : Session
bodyId : string
offset : float * float * float
Returns: Result<unit, string>

cameraFollow session bodyId

Full Usage: cameraFollow session bodyId

Parameters:
    session : Session
    bodyId : string

Returns: Result<unit, string>
session : Session
bodyId : string
Returns: Result<unit, string>

cameraFrameBodies session bodyIds

Full Usage: cameraFrameBodies session bodyIds

Parameters:
    session : Session
    bodyIds : string list

Returns: Result<unit, string>
session : Session
bodyIds : string list
Returns: Result<unit, string>

cameraLookAt session bodyId durationSeconds

Full Usage: cameraLookAt session bodyId durationSeconds

Parameters:
    session : Session
    bodyId : string
    durationSeconds : float

Returns: Result<unit, string>
session : Session
bodyId : string
durationSeconds : float
Returns: Result<unit, string>

cameraOrbit session bodyId durationSeconds degrees

Full Usage: cameraOrbit session bodyId durationSeconds degrees

Parameters:
    session : Session
    bodyId : string
    durationSeconds : float
    degrees : float

Returns: Result<unit, string>
session : Session
bodyId : string
durationSeconds : float
degrees : float
Returns: Result<unit, string>

cameraShake session intensity durationSeconds

Full Usage: cameraShake session intensity durationSeconds

Parameters:
    session : Session
    intensity : float
    durationSeconds : float

Returns: Result<unit, string>
session : Session
intensity : float
durationSeconds : float
Returns: Result<unit, string>

cameraStop session

Full Usage: cameraStop session

Parameters:
Returns: Result<unit, string>
session : Session
Returns: Result<unit, string>

setCamera session position target

Full Usage: setCamera session position target

Parameters:
    session : Session
    position : float * float * float
    target : float * float * float

Returns: Result<unit, string>
session : Session
position : float * float * float
target : float * float * float
Returns: Result<unit, string>

setDemoMetadata session name description

Full Usage: setDemoMetadata session name description

Parameters:
    session : Session
    name : string
    description : string

Returns: Result<unit, string>
session : Session
name : string
description : string
Returns: Result<unit, string>

setNarration session text

Full Usage: setNarration session text

Parameters:
Returns: Result<unit, string>
session : Session
text : string
Returns: Result<unit, string>

setZoom session level

Full Usage: setZoom session level

Parameters:
Returns: Result<unit, string>
session : Session
level : float
Returns: Result<unit, string>

smoothCamera session position target durationSeconds

Full Usage: smoothCamera session position target durationSeconds

Parameters:
    session : Session
    position : float * float * float
    target : float * float * float
    durationSeconds : float

Returns: Result<unit, string>
session : Session
position : float * float * float
target : float * float * float
durationSeconds : float
Returns: Result<unit, string>

smoothCameraWithZoom session position target durationSeconds zoomLevel

Full Usage: smoothCameraWithZoom session position target durationSeconds zoomLevel

Parameters:
    session : Session
    position : float * float * float
    target : float * float * float
    durationSeconds : float
    zoomLevel : float

Returns: Result<unit, string>
session : Session
position : float * float * float
target : float * float * float
durationSeconds : float
zoomLevel : float
Returns: Result<unit, string>

wireframe session enabled

Full Usage: wireframe session enabled

Parameters:
Returns: Result<unit, string>
session : Session
enabled : bool
Returns: Result<unit, string>

Type something to start searching.