Class UIResolver

UIResolver

A utility class that allows you to patch any prompt designs into the Prompt class essentially mapping your custom elements into the expected structure.

Properties

AcceptBtn BG Content DeclineBtn Title

Methods

ReassignZIndex Resolve SetAccept SetBG SetContent SetDecline SetTitle Validate ValidateStructure

Properties

AcceptBtn

AcceptBtn: Button

The confirm, yes and accept button that will fulfill as accepted.

BG

BG: Frame

A Frame representing the background of the Prompt.

Content

Content: Frame | ScrollingFrame

A Frame | ScrollingFrame representing the container of the Prompt content.

DeclineBtn

DeclineBtn: Button

The reject, no and decline button that will fulfill as declined.

Title

Title: TextLabel

A TextLabel which will act as the title/header for this Prompt.

Methods

ReassignZIndex

  • ReassignZIndex(): void

  • Reassigns the ZIndex of the Prompt UIResolver elements.

    Returns void

Resolve

  • Resolve(structure): boolean

  • Resolves a structure of UI that is the required structure for Promptifier functionality. This was designed to simplify the assignment when not chaining in roblox-ts.

    Parameters

    • structure: UIStructure

      The UIResolver required structure

    Returns boolean

    • A boolean indicating whether the structure is valid or not.

SetAccept

  • SetAccept(btn): this

  • Sets the accept button of this Prompt.

    Parameters

    • btn: Button

      The TextButton or ImageButton that will represent accepting the Prompt

    Returns this

    • UIResolver for chaining

SetBG

  • SetBG(bg): this

  • Sets the background of this Prompt.

    Parameters

    • bg: Frame

      The background Frame of the Prompt

    Returns this

    • UIResolver for chaining

SetContent

  • SetContent(frame): this

  • Sets the content of this Prompt.

    Parameters

    • frame: Frame | ScrollingFrame

      A ScrollingFrame or Frame that will contain the Prompt content

    Returns this

    • UIResolver for chaining

SetDecline

  • SetDecline(btn): this

  • Sets the decline button of this Prompt.

    Parameters

    • btn: Button

      The TextButton or ImageButton that will represent declining the Prompt

    Returns this

    • UIResolver for chaining

SetTitle

  • SetTitle(tl): this

  • Sets the title of this Prompt.

    Parameters

    • tl: TextLabel

      The title TextLabel of the Prompt

    Returns this

    • UIResolver for chaining

Validate

  • Validate(): void

  • Validates the ui links to ensure they fill the requirements. Errors if any of the elements are missing or invalid types.

    Returns void

ValidateStructure

  • ValidateStructure(): boolean

  • Validates the structure of the UIResolver ensuring the elements are within their background.

    Returns boolean

    • true if the structure is valid, otherwise false

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc