SimulationCommands (PhysicsSandbox)

SimulationCommands Module

Namespace: PhysicsClient
Assembly: PhysicsClient.dll

Functions and values

Function or value	Description
`addBox session position halfExtents mass id material color motionType collisionGroup collisionMask` Full Usage: `addBox session position halfExtents mass id material color motionType collisionGroup collisionMask` Parameters: session : `Session` position : `float * float * float` halfExtents : `float * float * float` mass : `float` id : `string option` material : `MaterialProperties option` color : `Color option` motionType : `BodyMotionType option` collisionGroup : `uint32 option` collisionMask : `uint32 option` Returns: `Result<string, string>`	session : `Session` position : `float * float * float` halfExtents : `float * float * float` mass : `float` id : `string option` material : `MaterialProperties option` color : `Color option` motionType : `BodyMotionType option` collisionGroup : `uint32 option` collisionMask : `uint32 option` Returns: `Result<string, string>`
`addCapsule session position radius length mass id` Full Usage: `addCapsule session position radius length mass id` Parameters: session : `Session` position : `float * float * float` radius : `float` length : `float` mass : `float` id : `string option` Returns: `Result<string, string>`	session : `Session` position : `float * float * float` radius : `float` length : `float` mass : `float` id : `string option` Returns: `Result<string, string>`
`addConstraint session id bodyA bodyB constraintType` Full Usage: `addConstraint session id bodyA bodyB constraintType` Parameters: session : `Session` id : `string` bodyA : `string` bodyB : `string` constraintType : `ConstraintType` Returns: `Result<string, string>`	session : `Session` id : `string` bodyA : `string` bodyB : `string` constraintType : `ConstraintType` Returns: `Result<string, string>`
`addCylinder session position radius length mass id` Full Usage: `addCylinder session position radius length mass id` Parameters: session : `Session` position : `float * float * float` radius : `float` length : `float` mass : `float` id : `string option` Returns: `Result<string, string>`	session : `Session` position : `float * float * float` radius : `float` length : `float` mass : `float` id : `string option` Returns: `Result<string, string>`
`addPlane session normal id` Full Usage: `addPlane session normal id` Parameters: session : `Session` normal : `(float * float * float) option` id : `string option` Returns: `Result<string, string>`	session : `Session` normal : `(float * float * float) option` id : `string option` Returns: `Result<string, string>`
`addSphere session position radius mass id material color motionType collisionGroup collisionMask` Full Usage: `addSphere session position radius mass id material color motionType collisionGroup collisionMask` Parameters: session : `Session` position : `float * float * float` radius : `float` mass : `float` id : `string option` material : `MaterialProperties option` color : `Color option` motionType : `BodyMotionType option` collisionGroup : `uint32 option` collisionMask : `uint32 option` Returns: `Result<string, string>`	session : `Session` position : `float * float * float` radius : `float` mass : `float` id : `string option` material : `MaterialProperties option` color : `Color option` motionType : `BodyMotionType option` collisionGroup : `uint32 option` collisionMask : `uint32 option` Returns: `Result<string, string>`
`applyForce session bodyId force` Full Usage: `applyForce session bodyId force` Parameters: session : `Session` bodyId : `string` force : `float * float * float` Returns: `Result<unit, string>`	session : `Session` bodyId : `string` force : `float * float * float` Returns: `Result<unit, string>`
`applyImpulse session bodyId impulse` Full Usage: `applyImpulse session bodyId impulse` Parameters: session : `Session` bodyId : `string` impulse : `float * float * float` Returns: `Result<unit, string>`	session : `Session` bodyId : `string` impulse : `float * float * float` Returns: `Result<unit, string>`
`applyTorque session bodyId torque` Full Usage: `applyTorque session bodyId torque` Parameters: session : `Session` bodyId : `string` torque : `float * float * float` Returns: `Result<unit, string>`	session : `Session` bodyId : `string` torque : `float * float * float` Returns: `Result<unit, string>`
`batchCommands session commands` Full Usage: `batchCommands session commands` Parameters: session : `Session` commands : `SimulationCommand list` Returns: `Result<BatchResponse, string>`	session : `Session` commands : `SimulationCommand list` Returns: `Result<BatchResponse, string>`
`batchViewCommands session commands` Full Usage: `batchViewCommands session commands` Parameters: session : `Session` commands : `ViewCommand list` Returns: `Result<BatchResponse, string>`	session : `Session` commands : `ViewCommand list` Returns: `Result<BatchResponse, string>`
`clearAll session` Full Usage: `clearAll session` Parameters: session : `Session` Returns: `Result<int, string>`	session : `Session` Returns: `Result<int, string>`
`clearForces session bodyId` Full Usage: `clearForces session bodyId` Parameters: session : `Session` bodyId : `string` Returns: `Result<unit, string>`	session : `Session` bodyId : `string` Returns: `Result<unit, string>`
`confirmedReset session` Full Usage: `confirmedReset session` Parameters: session : `Session` Returns: `Result<ConfirmedResetResponse, string>`	session : `Session` Returns: `Result<ConfirmedResetResponse, string>`
`overlap session shape position orientation collisionMask` Full Usage: `overlap session shape position orientation collisionMask` Parameters: session : `Session` shape : `Shape` position : `float * float * float` orientation : `(float * float * float * float) option` collisionMask : `uint32 option` Returns: `Result<OverlapResponse, string>`	session : `Session` shape : `Shape` position : `float * float * float` orientation : `(float * float * float * float) option` collisionMask : `uint32 option` Returns: `Result<OverlapResponse, string>`
`pause session` Full Usage: `pause session` Parameters: session : `Session` Returns: `Result<unit, string>`	session : `Session` Returns: `Result<unit, string>`
`play session` Full Usage: `play session` Parameters: session : `Session` Returns: `Result<unit, string>`	session : `Session` Returns: `Result<unit, string>`
`raycast session origin direction maxDistance allHits collisionMask` Full Usage: `raycast session origin direction maxDistance allHits collisionMask` Parameters: session : `Session` origin : `float * float * float` direction : `float * float * float` maxDistance : `float` allHits : `bool` collisionMask : `uint32 option` Returns: `Result<RaycastResponse, string>`	session : `Session` origin : `float * float * float` direction : `float * float * float` maxDistance : `float` allHits : `bool` collisionMask : `uint32 option` Returns: `Result<RaycastResponse, string>`
`registerShape session handle shape` Full Usage: `registerShape session handle shape` Parameters: session : `Session` handle : `string` shape : `Shape` Returns: `Result<unit, string>`	session : `Session` handle : `string` shape : `Shape` Returns: `Result<unit, string>`
`removeBody session bodyId` Full Usage: `removeBody session bodyId` Parameters: session : `Session` bodyId : `string` Returns: `Result<unit, string>`	session : `Session` bodyId : `string` Returns: `Result<unit, string>`
`removeConstraint session constraintId` Full Usage: `removeConstraint session constraintId` Parameters: session : `Session` constraintId : `string` Returns: `Result<unit, string>`	session : `Session` constraintId : `string` Returns: `Result<unit, string>`
`reset session` Full Usage: `reset session` Parameters: session : `Session` Returns: `Result<unit, string>`	session : `Session` Returns: `Result<unit, string>`
`setBodyPose session bodyId position orientation velocity angularVelocity` Full Usage: `setBodyPose session bodyId position orientation velocity angularVelocity` Parameters: session : `Session` bodyId : `string` position : `float * float * float` orientation : `(float * float * float * float) option` velocity : `(float * float * float) option` angularVelocity : `(float * float * float) option` Returns: `Result<unit, string>`	session : `Session` bodyId : `string` position : `float * float * float` orientation : `(float * float * float * float) option` velocity : `(float * float * float) option` angularVelocity : `(float * float * float) option` Returns: `Result<unit, string>`
`setCollisionFilter session bodyId collisionGroup collisionMask` Full Usage: `setCollisionFilter session bodyId collisionGroup collisionMask` Parameters: session : `Session` bodyId : `string` collisionGroup : `uint32` collisionMask : `uint32` Returns: `Result<unit, string>`	session : `Session` bodyId : `string` collisionGroup : `uint32` collisionMask : `uint32` Returns: `Result<unit, string>`
`setGravity session gravity` Full Usage: `setGravity session gravity` Parameters: session : `Session` gravity : `float * float * float` Returns: `Result<unit, string>`	session : `Session` gravity : `float * float * float` Returns: `Result<unit, string>`
`step session` Full Usage: `step session` Parameters: session : `Session` Returns: `Result<unit, string>`	session : `Session` Returns: `Result<unit, string>`
`sweepCast session shape startPosition direction maxDistance orientation collisionMask` Full Usage: `sweepCast session shape startPosition direction maxDistance orientation collisionMask` Parameters: session : `Session` shape : `Shape` startPosition : `float * float * float` direction : `float * float * float` maxDistance : `float` orientation : `(float * float * float * float) option` collisionMask : `uint32 option` Returns: `Result<SweepCastResponse, string>`	session : `Session` shape : `Shape` startPosition : `float * float * float` direction : `float * float * float` maxDistance : `float` orientation : `(float * float * float * float) option` collisionMask : `uint32 option` Returns: `Result<SweepCastResponse, string>`
`unregisterShape session handle` Full Usage: `unregisterShape session handle` Parameters: session : `Session` handle : `string` Returns: `Result<unit, string>`	session : `Session` handle : `string` Returns: `Result<unit, string>`