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

Table of Contents

Trigger API Reference\DCEI Functions\Terrain (2/2) {Trigger-API-ReferenceDCEI-FunctionsTerrain-22}

int AddLineWithSprite(Float3 startPos, Float3 endPos, float width, ColorRGBA color, string spriteName, float tex_multiplier) {int-AddLineWithSpriteFloat3-startPos-Float3-endPos-float-width-ColorRGBA-color-string-spriteName-float-tex_multiplier}

int AddLineWithSprite(Float3 startPos, Float3 endPos, float width, ColorRGBA color, string spriteName, float tex_multiplier)

Description

Parameters

Example Usage

int AddLineWithSpriteColorRGBA(Float3 startPos, Float3 endPos, float width, ColorRGBA color, string spriteName, float tex_multiplier) {int-AddLineWithSpriteColorRGBAFloat3-startPos-Float3-endPos-float-width-ColorRGBA-color-string-spriteName-float-tex_multiplier}

int AddLineWithSpriteColorRGBA(Float3 startPos, Float3 endPos, float width, ColorRGBA color, string spriteName, float tex_multiplier)

⚠️Warning⚠️: This api was deprecated at 7/19/2022, and will be removed after 90 days.

Description

Parameters

Example Usage

void RemoveLine(int lineId) {void-RemoveLineint-lineId}

void RemoveLine(int lineId)

Description

Removes a line.

Parameters

  • int lineId the ID of the line to remove.

Example Usage

DCEI.RemoveLine(1)

void MoveLineWithInterpolation(int lineId, Float3 startPos, Float3 endPos, float duration) {void-MoveLineWithInterpolationint-lineId-Float3-startPos-Float3-endPos-float-duration}

void MoveLineWithInterpolation(int lineId, Float3 startPos, Float3 endPos, float duration)

Description

Moves a line's start and end points (and thus the line itself) to new locations over the given duration.

Parameters

  • int lineId the ID of the line to move.
  • Float3 startPos the new starting coordinates for the line.
  • Float3 endPos the new ending coordinates for the line.
  • float duration the duration of the line's movement.

Example Usage

DCEI.MoveLineWithInterpolation(2, {x = 1, y = 1, z = 15}, {x = 30, y = 1, z = 15}, 3)

void RemoveAllLines() {void-RemoveAllLines}

void RemoveAllLines()

Description

Removes all lines.

Example Usage

DCEI.RemoveAllLines()

void ChangeLineColor(int lineId, ColorRGBA color) {void-ChangeLineColorint-lineId-ColorRGBA-color}

void ChangeLineColor(int lineId, ColorRGBA color)

Description

Parameters

Example Usage

void ChangeLineColorRGBA(int lineId, ColorRGBA color) {void-ChangeLineColorRGBAint-lineId-ColorRGBA-color}

void ChangeLineColorRGBA(int lineId, ColorRGBA color)

⚠️Warning⚠️: This api was deprecated at 7/19/2022, and will be removed after 90 days.

Description

Parameters

Example Usage

void ChangeLineDisplay(int lineId, bool display) {void-ChangeLineDisplayint-lineId-bool-display}

void ChangeLineDisplay(int lineId, bool display)

Description

Toggles the display of a line.

Parameters

  • int lineId the ID of the line.
  • bool display if true, displays the line.

Example Usage

DCEI.ChangeLineDisplay(1, false)

int AddGrid(Float3 center, float width, float height, int xCount, int zCount, float lineWidth, ColorRGBA color, bool rectCap) {int-AddGridFloat3-center-float-width-float-height-int-xCount-int-zCount-float-lineWidth-ColorRGBA-color-bool-rectCap}

int AddGrid(Float3 center, float width, float height, int xCount, int zCount, float lineWidth, ColorRGBA color, bool rectCap)

Description

Parameters

Example Usage

int AddGridColorRGBA(Float3 center, float width, float height, int xCount, int zCount, float lineWidth, ColorRGBA color, bool rectCap) {int-AddGridColorRGBAFloat3-center-float-width-float-height-int-xCount-int-zCount-float-lineWidth-ColorRGBA-color-bool-rectCap}

int AddGridColorRGBA(Float3 center, float width, float height, int xCount, int zCount, float lineWidth, ColorRGBA color, bool rectCap)

⚠️Warning⚠️: This api was deprecated at 7/19/2022, and will be removed after 90 days.

Description

Parameters

Example Usage

int AddGridWithSprite(Float3 center, float width, float height, int xCount, int zCount, float lineWidth, ColorRGBA color, string spriteName, float tex_multiplier) {int-AddGridWithSpriteFloat3-center-float-width-float-height-int-xCount-int-zCount-float-lineWidth-ColorRGBA-color-string-spriteName-float-tex_multiplier}

int AddGridWithSprite(Float3 center, float width, float height, int xCount, int zCount, float lineWidth, ColorRGBA color, string spriteName, float tex_multiplier)

Description

Parameters

Example Usage

int AddGridWithSpriteColorRGBA(Float3 center, float width, float height, int xCount, int zCount, float lineWidth, ColorRGBA color, string spriteName, float tex_multiplier) {int-AddGridWithSpriteColorRGBAFloat3-center-float-width-float-height-int-xCount-int-zCount-float-lineWidth-ColorRGBA-color-string-spriteName-float-tex_multiplier}

int AddGridWithSpriteColorRGBA(Float3 center, float width, float height, int xCount, int zCount, float lineWidth, ColorRGBA color, string spriteName, float tex_multiplier)

⚠️Warning⚠️: This api was deprecated at 7/19/2022, and will be removed after 90 days.

Description

Parameters

Example Usage

void RemoveGrid(int gridId) {void-RemoveGridint-gridId}

void RemoveGrid(int gridId)

Description

Removes a grid.

Parameters

  • int gridId the ID of the grid to remove.

Example Usage

DCEI.RemoveGrid(1)

void SetBlurredScreenCaptureAsBackground(bool set, float duration) {void-SetBlurredScreenCaptureAsBackgroundbool-set-float-duration}

void SetBlurredScreenCaptureAsBackground(bool set, float duration)

Description

Toggles a blurred version of your terrain in the background. Note that this background renders underneath the terrain, so you may need to move your game camera to see it.

Parameters

  • bool set if true, enables the blurred background.
  • float duration the transition duration.

Example Usage

DCEI.SetBlurredScreenCaptureAsBackground(true, 5)

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