Session (PhysicsSandbox) | PhysicsSandbox

PhysicsSandbox

Session Module

Namespace: PhysicsClient
Assembly: PhysicsClient.dll

Types

Type	Description
Session	Opaque session handle for all library operations.

Functions and values

Function or value	Description
`bodyPropertiesCache session` Full Usage: `bodyPropertiesCache session` Parameters: session : `Session` Returns: `ConcurrentDictionary<string, BodyProperties>`	Get the cached body properties for all known bodies. session : `Session` Returns: `ConcurrentDictionary<string, BodyProperties>`
`bodyRegistry session` Full Usage: `bodyRegistry session` Parameters: session : `Session` Returns: `ConcurrentDictionary<string, string>`	Get the body registry from a session. Maps body names to shape kinds. session : `Session` Returns: `ConcurrentDictionary<string, string>`
`cachedConstraints session` Full Usage: `cachedConstraints session` Parameters: session : `Session` Returns: `ConstraintState list`	Get the cached list of active constraints. session : `Session` Returns: `ConstraintState list`
`cachedRegisteredShapes session` Full Usage: `cachedRegisteredShapes session` Parameters: session : `Session` Returns: `RegisteredShapeState list`	Get the cached list of registered custom shapes. session : `Session` Returns: `RegisteredShapeState list`
`connect serverAddress` Full Usage: `connect serverAddress` Parameters: serverAddress : `string` Returns: `Result<Session, string>`	Connect to the physics server. Returns a session or error. serverAddress : `string` Returns: `Result<Session, string>`
`disconnect session` Full Usage: `disconnect session` Parameters: session : `Session`	Disconnect and clean up resources. session : `Session`
`isConnected session` Full Usage: `isConnected session` Parameters: session : `Session` Returns: `bool`	Check if the session is currently connected. session : `Session` Returns: `bool`
`lastStateUpdate session` Full Usage: `lastStateUpdate session` Parameters: session : `Session` Returns: `DateTime`	Get the timestamp of the last state update received from the server. session : `Session` Returns: `DateTime`
`latestState session` Full Usage: `latestState session` Parameters: session : `Session` Returns: `SimulationState option`	Get the latest cached simulation state, or None if no state has arrived yet. session : `Session` Returns: `SimulationState option`
`reconnect session` Full Usage: `reconnect session` Parameters: session : `Session` Returns: `Result<Session, string>`	Reconnect a disconnected session to the same server. session : `Session` Returns: `Result<Session, string>`
`serverAddress session` Full Usage: `serverAddress session` Parameters: session : `Session` Returns: `string`	Get the server address this session is connected to. session : `Session` Returns: `string`