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

Table of Contents

Trigger API Reference\DCEI Functions\Tutorial {Trigger-API-ReferenceDCEI-FunctionsTutorial}

void ShowPositionHelper(float x, float z) {void-ShowPositionHelperfloat-x-float-z}

void ShowPositionHelper(float x, float z)

Description

Shows the position helper hand at the specified coordinates. This will replace previous position helpers.

Parameters

  • float x the X coordinate.
  • float z the Z coordinate.

Example Usage

DCEI.ShowPositionHelper(16, 16)

void HidePositionHelper() {void-HidePositionHelper}

void HidePositionHelper()

Description

Hides the position helper.

Example Usage

DCEI.HidePositionHelper()

void BlockGameWorld() {void-BlockGameWorld}

void BlockGameWorld()

Description

Blocks the player from interacting with the game world. Removes any active whitelist(s). An exception to this is joystick input.

Example Usage

DCEI.BlockGameWorld()

void WhitelistUnit(unit u) {void-WhitelistUnitunit-u}

void WhitelistUnit(unit u)

Description

Whitelists a unit for player selection while normal input is blocked with DCEI.BlockGameWorld(). In isolation, this will allow a player to select a unit but not issue movement or other commands to it.

Parameters

  • unit u the unit to whitelist.

Example Usage

DCEI.WhitelistUnit(unit)

void WhitelistPosition(float x, float z, float radius) {void-WhitelistPositionfloat-x-float-z-float-radius}

void WhitelistPosition(float x, float z, float radius)

Description

Whitelists a map position for player interaction while normal input is blocked with DCEI.BlockGameWorld().

Parameters

  • float x the X coordinate.
  • float z the Z coordinate.
  • float radius the radius of the area whitelisted for player interaction.

Example Usage

DCEI.WhitelistPosition(20, 16, 2)

void WhitelistUi(Transform ui) {void-WhitelistUiTransform-ui}

void WhitelistUi(Transform ui)

Description

Whitelists the given UI element while normal input is blocked with DCEI.BlockGameWorld()

Parameters

  • Transform ui the UI element to whitelist.

Example Usage

DCEI.WhitelistUi(button)

void UnblockGameWorld() {void-UnblockGameWorld}

void UnblockGameWorld()

Description

Unblocks the game world, allowing user interaction again.

Example Usage

DCEI.UnblockGameWorld()

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