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");