stateBagGetters.md

State Bag Getters/Setters

Description

State bag getters are a little bit simpler, they just return the current value that is set in the state bag.

Note: If you're on the client and only using it on the current player, you can replace Player(source) with LocalPlayer

Example for Proximity

local plyState = Player(source).state
local proximity = plyState.proximity
print(proximity.index) -- prints the index of the proximity as seen in Cfg.voiceModes
print(proximity.distance) -- prints the distance of the proximity
print(proximity.mode) -- prints the mode name of the proximity