Skip to content

FxVoxelReference โ€‹

This module contains functions for modifying nodes that inherit from VoxelReference, which are nodes of type VoxelSceneReference, VoxelMeshReference, VoxelHeightmapReference and VoxelMovieReference.

Load โ€‹

lua
FxVoxelReference = require "FxVoxelReference";

Functions โ€‹

FunctionDescription
Update (NodeID)Reloads the voxel grid data.

Update (NodeID) โ€‹

This function reloads the voxel grid data of the specified VoxelReference node from the assigned asset.

Parameters โ€‹

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

Since โ€‹

Version 1.0

Errors โ€‹

Possible errors include FX_REQUIRED_ASSET_UNAVAILABLE, FX_NODE_NOT_FOUND

Example โ€‹

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