World Utilities / Values
Vector3
A three component vector - positions, directions, scales or any three numbers.
since v0.1.0localsynchronizedpersistednetworked
| Component | Add Component menu / prefab | Source |
|---|---|---|
Local Vector3VRCTools.World.LocalValues.LocalVector3
|
Local Values › Local Vector3prefab: Local Vector3.prefab
|
LocalVector3.cs ↗ |
Synchronized Vector3VRCTools.World.SynchronizedValues.SynchronizedVector3
|
Synchronized Values › Synchronized Vector3prefab: Synchronized Vector3.prefab
|
SynchronizedVector3.cs ↗ |
Persisted Vector3VRCTools.World.PersistedValues.PersistedVector3
|
Persisted Values › Persisted Vector3prefab: Persisted Vector3.prefab
|
PersistedVector3.cs ↗ |
Vector3 values can be applied to material vector properties or read from scripts, for example to remember where a player left an object.
Parameters
| Parameter | Default | Description |
|---|---|---|
| Default Value | (0, 0, 0) |
The state the value is initialized with. |
| Key (persisted only) | PlayerData key used to store the value. Required - see choosing keys. |
Synchronized variants additionally expose the networking settings.
Networked values need a unique hierarchy path - see naming networked objects.
Events
| Event | Kinds | Description |
|---|---|---|
EVENT_STATE_UPDATED |
all | The state changed (also emitted once with the initial state). |
EVENT_STATE_RESET |
local, persisted | _Reset() restored the default value. |
EVENT_LOADED |
persisted | Stored data has been restored - see loading. |
EVENT_PERSIST |
persisted | The state has been written to player data. |
Functions
| Function | Kinds | Description |
|---|---|---|
_Reset() |
local, persisted | Restores Default Value. |