Trigger API Reference DCEI Functions UI1 - BLKTower/TestWiki GitHub Wiki

Table of Contents

Trigger API Reference\DCEI Functions\UI (2/2) {Trigger-API-ReferenceDCEI-FunctionsUI-22}

void ShowObjectiveText(string text) {void-ShowObjectiveTextstring-text}

void ShowObjectiveText(string text)

Description

Show objective text.

Parameters

  • string text the text of the objective.

Example Usage

DCEI.ShowObjectiveText("Objective")

void HideObjective() {void-HideObjective}

void HideObjective()

Description

Hides any active objectives.

Example Usage

DCEI.HideObjective()

void ShowScreenMask(float alpha, ScreenBackgroundOptions options) {void-ShowScreenMaskfloat-alpha-ScreenBackgroundOptions-options}

void ShowScreenMask(float alpha, ScreenBackgroundOptions options)

Description

Shows a screen mask (overlay tint). This will block interaction with everything. This will also overwrite previous screen masks.

Parameters

Example Usage

local screen_options = {color = {r = 255, g = 0, b = 255, a = 255}, duration = 5}
DCEI.ShowScreenMask(0.5, screen_options)

void HideScreenMask() {void-HideScreenMask}

void HideScreenMask()

Description

Hides any active screen mask.

Example Usage

DCEI.HideScreenMask()

void ShowSlowMotionEffect() {void-ShowSlowMotionEffect}

void ShowSlowMotionEffect()

Description

Shows the slow motion effect on the screen.

Example Usage

DCEI.ShowSlowMotionEffect()

void HideSlowMotionEffect() {void-HideSlowMotionEffect}

void HideSlowMotionEffect()

Description

Hides the slow motion effect on the screen.

Example Usage

DCEI.HideSlowMotionEffect()

⚠️ **GitHub.com Fallback** ⚠️