Skip to main content

Check User Variable

Runs on: Frontend (Chatbox) — only available in the Chatbox Flow Editor; runs inside the OBS browser source.

The Check User Variable node compares a User Variable for the current viewer against a value, and forwards the message or event to Pass or Fail based on the result. It rolls reading a variable and comparing it into a single node.

Numeric values are compared as numbers; everything else is compared as text. The exists and does not exist conditions test only whether the viewer has the variable set, and ignore the comparison value.

Inputs​

NameTypeDescription
eventanyThe message or event from a chatbox trigger or an upstream check node.

Outputs​

NameTypeDescription
passanyThe message or event, forwarded if the condition is met.
failanyThe message or event, forwarded if the condition is not met.

Configuration​

  • Variable: The name of the user variable to check.
  • Condition: The comparison to apply — equals, not equals, greater than, less than, at least, at most, exists, or does not exist.
  • Value: The value to compare against. Not used by the exists / does not exist conditions.

Example​

Set the variable to points, the condition to at least, and the value to 1000. Route Pass to a "VIP-style" chatbox variant so your most loyal viewers stand out, while everyone else continues through Fail to the normal layout.