fsCameraSubscribeToCameraWorldLockerStatusUpdate

The fsCameraSubscribeToCameraWorldLockerStatusUpdate function is used to receive update messages when the simulation changes the camera world locker status.

Syntax

bool fsCameraSubscribeToCameraWorldLockerStatusUpdate(
    fsCameraWorldLockerStatusUpdateCallback callback,
    void* context = nullptr
    );

Members

Parameters	Description
`callback`	A `fsCameraWorldLockerStatusUpdateCallback` to use when a status update message is received.
`context`	The context of the call.

Return Values

The function returns false if it was not possible to send the request, or true otherwise. If the request was sent but failed, the specified callback will be invoked with an appropriate error code.

Example

Subscribe to camera status updates:

fsCameraSubscribeToCameraWorldLockerStatusUpdate(CameraLockerStatusUpdateCallback);

User defined callback:

static void CameraLockerStatusUpdateCallback(FsCameraWorldLockerStatus status, void* ctx)
{
    g_eLockerStatus = status;
    switch (g_eLockerStatus)
    {
        // ...
    }
    
}

Remarks

N/A