Trigger API Reference DCEI Functions Tutorial0 - funovus/editor-wiki 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 HidePositionHelper()](#void-hidepositionhelper)
* [void BlockGameWorld()](#void-blockgameworld)
* [void WhitelistUnit(unit u)](#void-whitelistunitunit-u)
* [void WhitelistPosition(float x, float z, float radius)](#void-whitelistpositionfloat-x-float-z-float-radius)
* [void WhitelistUi(Transform ui)](#void-whitelistuitransform-ui)
* [void UnblockGameWorld()](#void-unblockgameworld)
|
Trigger API Reference\DCEI Functions\Tutorial {Trigger-API-ReferenceDCEI-FunctionsTutorial}
void ShowPositionHelper(float x, float z)
Shows the position helper hand at the specified coordinates. This will replace previous position helpers.
DCEI.ShowPositionHelper(16, 16)
void HidePositionHelper()
DCEI.HidePositionHelper()
void BlockGameWorld()
Blocks the player from interacting with the game world. Removes any active whitelist(s). An exception to this is joystick input.
DCEI.BlockGameWorld()
void WhitelistUnit(unit u)
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.
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)
Whitelists a map position for player interaction while normal input is blocked with DCEI.BlockGameWorld()
.
-
float
x
the X coordinate. -
float
z
the Z coordinate. -
float
radius
the radius of the area whitelisted for player interaction.
DCEI.WhitelistPosition(20, 16, 2)
void WhitelistUi(Transform ui)
Whitelists the given UI element while normal input is blocked with DCEI.BlockGameWorld()
DCEI.WhitelistUi(button)
void UnblockGameWorld()
Unblocks the game world, allowing user interaction again.
DCEI.UnblockGameWorld()