Set shared page state

Set shared page state values and returns the updated state

by @pixiebrix

How to Use

Shared page state can be used to pass data between extensions. Documentation for both getting and setting the page state can be found in the page state documentation.

You can add as many properties as you want to the ‘data’ field when it’s set to ‘object properties’, and add data to each of those properties to be retrieved later by the Get Shared Page State brick. You can also pass in a variable as the whole input instead of using object properties, but note that that will store the contents of that variable and not the variable itself. The ‘namespace’ field controls which blueprints can use this data, and the ‘mergeStrategy’ field controls how that data is added if there is already similar data being stored.

See the page state documentation for details on each of the options for these fields.


Inputs

Name Required Type Description
data object The properties to set on the state.
namespace multiple Where to set the data. If set to Mod and this Starter Brick is not part of a Mod, behaves as Public.
mergeStrategy multiple Strategy for merging the data with existing state.

Outputs

Name Required Type Description
No outputs for this brick defined.

Related Tags