vrctools@docs:~/docs/world-utils/values$ man int

World Utilities / Values

Int

A whole number - option indices, counters and limits.

since v0.1.0localsynchronizedpersistednetworked

$ ls -l components/

Component	Add Component menu / prefab	Source
Local IntVRCTools.World.LocalValues.LocalInt	Local Values › Local Intprefab: Local Int.prefab	LocalInt.cs ↗
Synchronized IntVRCTools.World.SynchronizedValues.SynchronizedInt	Synchronized Values › Synchronized Intprefab: Synchronized Int.prefab	SynchronizedInt.cs ↗
Persisted IntVRCTools.World.PersistedValues.PersistedInt	Persisted Values › Persisted Intprefab: Persisted Int.prefab	PersistedInt.cs ↗

Int values work well for anything you count or choose from a list: the selected music track, the number of players in a game, the active lighting preset. Combine them with Int Math for derived numbers or with Presets for “pick option N” buttons.

Parameters

Parameter	Default	Description
Default Value	0	The state the value is initialized with.
Restrict Value	false	Clamp the state between Minimum Value and Maximum Value.
Minimum Value	0	Lower bound when restricted.
Maximum Value	1	Upper bound when restricted.
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.

With Restrict Value enabled, _Increment() and _Decrement() stop at the bounds instead of wrapping around.

As of v0.7.0, persisted ints do not apply Restrict Value when their state changes; only the inspector shows the restriction settings. Clamp the value before assigning it, or restrict the UI that writes to it (e.g. the slider’s min/max).

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
_Zero()	all	Sets the state to 0.
_Increment()	all	Adds one.
_Decrement()	all	Subtracts one.
_Reset()	local, persisted	Restores Default Value.

Usage

A “next track” / “previous track” pair of buttons for a playlist with five entries:

1. Add a Synchronized Int with Restrict Value enabled, Minimum Value 0 and Maximum Value 4.
2. Wire the buttons’ On Click to SendCustomEvent with _Increment and _Decrement respectively.
3. Read the state from your player script, or drive an animator with an Animator Parameter applicator.