Tokenizable Strings

BETAS adds 7 new Tokenizable Strings to the game as well. However, unlike vanilla tokenizable strings, the strings added by BETAS can be used within the new Game State Queries and new Actions that BETAS introduces and not just in dialogue.

Please keep in mind that, again, Tokenizable Strings do not work in any Game State Queries or Actions besides those added by BETAS. The game state queries and actions added by BETAS were specifically made to work with tokenizable strings. You can use any tokenizable string, vanilla or otherwise, in BETAS game state queries and actions, but you cannot use any tokenizable strings, vanilla or otherwise, in vanilla game state queries and actions.

If a parameter is wrapped in < > then it is a required parameter. If the parameter is wrapped in [] then it is an optional parameter. If the parameter has a + after it, that means you can provide multiple of that parameter separated by spaces. If a parameter starts with # then it expects a number. If it ends with ? then it expects true/false. If neither, it expects a string.

All of the Tokenizable Strings listed here must be prefixed with `Spiderbuttons.BETAS_`! This prefix was removed in these docs for brevity but they will not work without it! For example, `NumberOffset` MUST be written as `Spiderbuttons.BETAS_NumberOffset` in your actual mod!

FORMAT	OUTPUT
[CharacterLocation `[<Target]>+` `[<DisplayName?]>+`]	The name of the location that the `Target` is in. Possible `Target` values are `Farmer` or any NPC name. If `DisplayName` is set to `true`, the output will be the display name of the location and not the internal name
[CharacterCoordinate `[<Target]>+` `[<Axis]>+`]	The tile coordinate on the given `Axis` (`X` or `Y`) that the `Target` is standing on, wherever they may be. Possible `Target` values are `Farmer` or any NPC name
[NumberOffset `[<#Original]>+` `[<#Offset]>+`]	The `#Original` number after having the `#Offset` added to it. Negative numbers are supported
[VolumeLevel `[<Category]>+`]	The volume level that the given `Category` is set to. `Category` can be `Music`, `Sound`, or `Ambient`, or `Footstep`.
[FarmModData `[<Key]>+`]	The value in the mod data dictionary of the farm stored with the given `Key`.
[GlobalModData `[<UniqueId]>+` `[<Key]>+`]	The value in the global mod data dictionary of your mod, identified by your `UniqueId`, stored with the given `Key`. This tokenizable string requires you to enable certain Advanced Permissions.
[PlayerModData `[<Key]>+`]	The value in the mod data dictionary of the current player stored with the given `Key`.

Please keep in mind that the coordinates for the CharacterCoordinate tokenizable string will be calculated the same way regardless of where the player is when the tokenizable string is parsed. For example, if Haley is currently at X:25, Y:13 in the Beach location, the X and Y coordinates that the token will output will be 25 and 13 respectively, even if the tokenizable string is used while the player is in the FarmHouse and cannot actually see Haley on the current map.

As well, keep in mind that you are allowed to nest tokenizable strings inside of each other. For example, if you wanted to get the coordinate that was 5 tiles above Haley, you would write the following:

[Spiderbuttons.BETAS_NumberOffset [Spiderbuttons.BETAS_CharacterCoordinate Haley Y] -5]

Tokenizable Strings

All of the Tokenizable Strings listed here must be prefixed with Spiderbuttons.BETAS_! This prefix was removed in these docs for brevity but they will not work without it! For example, NumberOffset MUST be written as Spiderbuttons.BETAS_NumberOffset in your actual mod!

All of the Tokenizable Strings listed here must be prefixed with `Spiderbuttons.BETAS_`! This prefix was removed in these docs for brevity but they will not work without it! For example, `NumberOffset` MUST be written as `Spiderbuttons.BETAS_NumberOffset` in your actual mod!