Class UIPresetsConfig

This is a configuration module for UIPresets that will change behaviour across components.

Properties

HighestDisplayOrder OnDisplayOrderChanged ParallelEnabled

Methods

ExcludeDisplay ExcludeDisplays FetchHighestDisplayOrder deleteDisplay excludeDisplay updateDisplayOrder

Properties

Static HighestDisplayOrder

HighestDisplayOrder: number

The highest display order of all the ScreenGui instances within the PlayerGui.

Static OnDisplayOrderChanged

OnDisplayOrderChanged: Signal<[newOrder: number]> = ...

A beacon signal that fires when the highest display order is changed, passing the new highest display order.

Static ParallelEnabled

ParallelEnabled: boolean = false

Whether UIPresets should optimize itself and use parallel lua benefits. WARNING: The calling thread script must be within a Actor Instance.

Methods

Static ExcludeDisplay

  • ExcludeDisplay(ui): void

  • Excludes a ScreenGui from highest display order allowing multiple ScreenGui instances to be drawn on top of all components.

    Parameters

    • ui: ScreenGui

    Returns void

Static ExcludeDisplays

  • ExcludeDisplays(uis): void

  • Excludes multiple ScreenGui instances same behavior as ExcludeDisplay except that the display order is arranged after adding all displays rather then per one. The DisplayOrder changed connection is deferred until the end of the resumption cycle.

    Parameters

    • uis: ScreenGui[]

    Returns void

Static FetchHighestDisplayOrder

  • FetchHighestDisplayOrder(): number

  • Fetches the highest display order of all ScreenGui instances within PlayerGui.

    Returns number

    The highest display order

Static Private deleteDisplay

  • deleteDisplay(ui): void
  • Private

    Deletes the excluded display order ScreenGui reference and connections.

    Parameters

    • ui: ScreenGui

      The ScreenGui to delete from the excluded display orders.

    Returns void

Static Private excludeDisplay

  • excludeDisplay(ui, deferOrderChanged?): void
  • Private

    This method is the internal excludeDisplay and is not meant to be called externally.

    Parameters

    • ui: ScreenGui

      The ScreenGui to exclude

    • deferOrderChanged: boolean = false

      Whether the DisplayOrder property changed signal should be deferred till the end of the resumption cycle. Default(false)

    Returns void

Static Private updateDisplayOrder

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc