Struct UnityCheckpointRespawnPose

The data a UnityCheckpointTriggerComponent saves with its checkpoint: the world position and rotation a respawn puts the player back at, as UTF-8 JSON. A respawn script loads the checkpoint and reads its data back with TryRead(byte[], out UnityCheckpointRespawnPose).

public struct UnityCheckpointRespawnPose

Describes where a respawn puts the player back.

public UnityCheckpointRespawnPose(Vector3 position, Quaternion rotation)

Type	Name	Description
Vector3	position	The world position.
Quaternion	rotation	The world rotation.

The world position a respawn puts the player back at.

public Vector3 Position { get; }

Type	Description
Vector3

The world rotation a respawn puts the player back at.

public Quaternion Rotation { get; }

Type	Description
Quaternion

The pose as the checkpoint data a checkpoint trigger saves.

public byte[] ToBytes()

Type	Description
byte[]	UTF-8 JSON.

Reads the pose back from checkpoint data a checkpoint trigger saved.

public static bool TryRead(byte[] data, out UnityCheckpointRespawnPose pose)

Type	Name	Description
byte[]	data	The checkpoint's data.
UnityCheckpointRespawnPose	pose	The pose, or the default pose when the data is not one.

Type	Description
bool	True when `data` holds a whole pose: a position and a rotation. Data a checkpoint trigger did not save — text that is not JSON, bytes that are not text, JSON of another shape, or a pose missing its position or its rotation — answers false instead of a pose at the origin.