Type alias PromptPayload<TimerT>

PromptPayload<TimerT>: {
prompt: Prompt<TimerT>;
promptContent: Map<string, string>;
}

The PromptPayload that is sent during accepted fullfillment of the prompt.

Type Parameters

TimerT extends TimerType | null = null

Type declaration

prompt: Prompt<TimerT>
The Prompt that this payload belongs too.
promptContent: Map<string, string>
A map of the extracted content of this prompt. { [InstanceName]: Content }

Example

prompt.OnFulfill.Connect((accepted: boolean,payload?: PromptPayload) => {
    if (accepted && payload) {
        print(payload.promptContent);
    }
});

Assuming we had a Prompt with a ScrollingFrame as the Content and it contains 1 TextLabel named 'Money' and 1 TextBox named 'Nickname'

Your output would look like this

{
    ["Money"] = "350",
    ["Nickname"] = "Jen"
}

Generated using TypeDoc