CVR Avatar Pickup Marker ¶
Marks a GameObject as a pickup for an avatar. A pickup marker creates a small world-space UI, sometimes called a pedestal, that lets players view and select avatars from within the world.
When initialized, it spawns a panel showing:
- The avatar's preview image and name
- The author's name
- A Select button to switch to the avatar
- A Details button to open the avatar's detail page in the Main Menu
Fields¶
| Name | Type | Description |
|---|---|---|
avatarGuid |
string |
The avatar's GUID. |
Methods¶
| Name | Description |
|---|---|
ShowAvatarDetailsPage() |
Opens the avatar's detail page in the Main Menu. |
ChangeAvatar() |
Changes the player's avatar to the target one. |
TrySetGuid(string) |
Attempts to update the marker's avatar GUID. Returns false if the GUID is not valid or the pickup marker is still processing. |
SetGuid(string) |
Legacy method which now calls TrySetGuid. This method does not return if it was a success. |
Show Details Page Rate Limit
The ShowAvatarDetailsPage() method is rate-limited to one call per three seconds to prevent abuse.
This rate limit is global and applies to all components that can open the details page.
(CVRInteractable, Scripting API, other pickup markers, etc.)