Skip to content

FxPixelReference โ€‹

This module contains functions for modifying nodes that inherit from PixelReference, which are nodes of type PixelHeightmapReference.

Load โ€‹

lua
FxPixelReference = require "FxPixelReference";

Functions โ€‹

FunctionDescription
Update (NodeID)Reloads the pixel grid data.

Update (NodeID) โ€‹

This function reloads the pixel grid data of the specified PixelReference node from the assigned asset.

Parameters โ€‹

  • NodeID: The NodeID to identify the PixelReference nodes to update

Since โ€‹

Version 1.0

Errors โ€‹

Possible errors include FX_REQUIRED_ASSET_UNAVAILABLE, FX_NODE_NOT_FOUND

Example โ€‹

lua
-- assign Heightmap1 to Reference1
FxNode.Set1s("Reference1", "assetid", "Heightmap1");
-- ...
-- make changes to Heightmap1 
-- ...
-- update Heightmap1 so the changes made to Model1 are loaded
FxPixelReference.Update("Heightmap1");