Read Field

Read Field

Copy a value (like a user stat) into a variable

Fields

FieldTypeRequiredDescription
pathstringyesA dot path rooted at user, vars, event, guild, or now.
saveAs{scope, name}yes
targetUserId{path: 'event.option.<name>'}noMust reference a USER-type option declared on the same trigger — no literal id or arbitrary variable path allowed here, unlike the modify_* steps.

Example

{
  "id": "01H8XGJVBWX7Y5Z3K9M2N4P6Q1",
  "type": "read_field",
  "path": "user.coins",
  "saveAs": {
    "scope": "run",
    "name": "coins"
  }
}

Did this page help you?