#Payloads & Data Binding

Interface Director allows passing structured, dynamic data directly into interfaces on Show requests, combined with zero-code data-binding UI components.

#What is a Payload?

A Payload is a typed data packet supplied when opening an interface:

Game Creator Action -> Show Interface(DialogBox, Payload = "Welcome, Hero!")

Supported Payload Data Types:

String: Dialogue text, quest titles, descriptions.
Number: Gold amounts, damage values, countdown timers.
GameObject: Interacted character, loot chest, target prop.
Sprite / Texture: Item icons, character portraits.
Boolean: Flag states, toggles.
Color: Rarity tint, health bar color.
Custom Object: Any C# object or data structure.

#Payload Contracts on Interface Assets

Under Payload Contract on an Interface Asset, define required and optional arguments with default fallback values:

Field	Type	Required	Fallback
`Title`	String	Yes	`"Notification"`
`Message`	String	Yes	`"Default Message"`
`Icon`	Sprite	No	`DefaultIcon.png`

#Zero-Code UI Binding Components

Add these components to child GameObjects inside your View Prefab to automatically display payload data without writing scripts:

Component	Purpose
`InterfacePayloadText`	Binds TextMeshPro or UI Toolkit label text to a String or Number payload field.
`InterfacePayloadImage`	Binds Image or UI Toolkit image element to a Sprite or Texture payload field.
`InterfacePayloadBinding`	Generic property binder supporting formatted strings, numbers, and toggles.

#Visual Scripting Get & Set Payload

Set Interface Payload: Modifies or injects payload values into a running interface instance.
Get Interface Payload: Reads a payload field into a Game Creator Variable.
PropertyGetInterfacePayload*: Use payload values directly inside conditions or other Game Creator instructions.