Skip to content

FxCamera ​

This module contains functions for Camera nodes.

Load ​

lua
FxCamera = require "FxCamera";

Functions ​

FunctionDescription
LoadProfile (NodeID, FileType, FileID)Loads render settings from a profile into a camera.
SaveProfile (NodeID, FileType, FileID)Saves render settings of a camera to a profile.

LoadProfile (NodeID, FileType, FileID) ​

This function loads the render settings of the specified profile into the specified Camera node. The profile must be an Environmental Settings Profile or Render Effects Profile.

Parameters ​

  • NodeID: The NodeID to identify the Camera nodes
  • FileType: The FileType of the profile. Must be either 557 for Environmental Settings Profile or 556 for Render Effects Profile
  • FileID: The FileID of the profile to load settings from

Errors ​

Possible errors include FX_REQUIRED_ASSET_UNAVAILABLE, FX_NODE_NOT_FOUND, FX_FILE_NOT_FOUND

Since ​

Version 1.0

Example ​

lua
FxCamera.LoadProfile("camera1", 556, "default");

SaveProfile (NodeID, FileType, FileID) ​

This function saves the render settings of the specified Camera node to the specified profile. The profile must be an Environmental Settings Profile or Render Effects Profile.

Parameters ​

  • NodeID: The NodeID of the Camera node
  • FileType: The FileType of the profile. Must be either 557 for Environmental Settings Profile or 556 for Render Effects Profile
  • FileID: The FileID of the profile to save settings to

Errors ​

Possible errors include FX_REQUIRED_ASSET_UNAVAILABLE, FX_NODE_NOT_FOUND, FX_FILE_NOT_FOUND

Since ​

Version 1.0

Example ​

lua
FxCamera.SaveProfile("camera1", 556, "default");