Skip to content

API

Properties

TotalizerUpdated

Totalizers.TotalizerUpdated: Signal<string, number>

Invoked when a totalizer value is updated, either by the server the script is running on or by another server within the experience if SetBroadcastingEnabled is enabled (which it is by default).

This is a server only property.

Methods

:GetAsync

Totalizers:GetAsync(identifier: string): number

Returns the current value of the totalizer.

This is a server only method.

:IncrementAsync

Totalizers:IncrementAsync(identifier: string, incrementBy: number? = 1): (boolean, number)

Increments the current value of the totalizer. Returns true followed by the new value if the increment was successful.

This is a server only method.

:ResetAsync

Totalizers:ResetAsync(identifier: string): boolean

Resets the current value of the totalizer to 0. Returns true when successful.

This is a server only method.

:SetUpdateRate

Totalizers:SetUpdateRate(updateRate: number = >=30): ()

Sets the current update rate.

Default: 60 seconds

This is a server only method.

:GetUpdateRate

Totalizers:GetUpdateRate(): number

Returns the current update rate.

Default: 60 seconds

This is a server only method.

:SetBroadcastingEnabled

Totalizers:SetBroadcastingEnabled(enabled: boolean): ()

Enables or disables the broadcasting feature. When enabled, updates to totalizer values are sent between servers, resulting in more responsive and accurate totalizer values across the entire experience.

This is a server only method.