SetCameraPose

setCameraPose

AVAILABLE FROM UPDATE 0.1.3

This function is available in G1R:MP 0.1.3 and later. The contract below includes the compatibility guarantees introduced in that update.

Sets scripted-camera position, rotation and field of view in one command.

Syntax

-- Client-side
number|false setCameraPose(table pose)
-- Server-side
bool setCameraPose(int playerId, table pose)

Parameters

Name	Type	Required	Description
playerId	int	yes	Server-side only: the connected player whose local camera receives the command.
pose	table	yes	Pose fields: x/y/z in metres; pitch/yaw/roll and fov in degrees. See the side-specific defaults below.

Returns

Client-side: a positive requestId, or false when validation or queuing fails. Wait for onClientCameraCommandResult to learn the execution result. Server-side: true only means validated and queued for the connected player; false means rejected. A server return value is not a client acknowledgement.

Examples

Read the local camera/player state before issuing the command. The command's own result arrives separately in onClientCameraCommandResult.

-- Client-side: run after the local world and player camera are ready.
local query
addEventHandler("onClientCameraCommandResult", resourceRoot,
    function(requestId, ok, phase, errorText, stateJson)
        if requestId ~= query then return end
        query = nil
        if not ok or phase ~= "state" then
            outputDebugString("Camera query failed: " .. tostring(errorText), 2)
            return
        end
        local state = getCameraState()
        if not state or not state.ready then return end
        setCameraPose({x=state.playerX - 5, y=state.playerY, z=state.playerZ + 3,
            pitch=-15, yaw=0, roll=0, fov=75})
    end)
query = requestCameraState()
if not query then outputDebugString("Camera query was not queued", 2) end

Notes

• Available in client-side and server-side resource scripts. Equivalent PascalCase spelling: SetCameraPose.
• Client-side pose fields omitted after a ready acknowledged state inherit that resource's cached pose. Without such a cache, all seven fields (x, y, z, pitch, yaw, roll, fov) are required. Server-side x/y/z are required and omitted angles default to 0, FOV to 90; there is no server camera cache.
• Client success phase: applied.
• Only the owning resource may change an already controlled camera. Server and client ownership are distinct, even when resource names match; use one side consistently for a camera sequence.
• Camera positions, paths and orbits have no distance limit relative to the local character. All world coordinates must remain finite and within -1,000,000 to 1,000,000 metres; the complete orbit extent is validated too. Camera control does not move the character, change replication distance, freeze input, or enable remote-player spectating.
• Use resetCameraPos to restore gameplay view. Resource stop, disconnect and world/character changes release camera ownership; see onClientCameraReset.
• An applied acknowledgement confirms command handling, not rendering or completion of world streaming. For a fresh read-back, request state after another frame or a short timer. See Scripted camera for distant scenes, lifecycle, acknowledgement and state-cache details.