Show/Hide Object (Flowgraph Node)

Overview

• Node Name: Show/Hide Object
• Category: repeat_instant
• File: extensions/flowgraph/nodes/scene/hide.lua

Shows or hides a scene object by toggling its hidden property.

Pin Schema

Input Pins

Behavior

• work() - Each frame:
  1. Validates objID is provided (sets a node error if missing).
  2. Finds the object via scenetree.findObjectById(objID).
  3. Sets obj.hidden to the hide pin value (defaults to false).
  4. Calls obj:updateInstanceRenderData() if available to refresh rendering.

Key Dependencies

• scenetree.findObjectById(id) - Finds the target scene object
• obj.hidden - Boolean property controlling visibility
• obj:updateInstanceRenderData() - Forces a render data refresh

How It Works

A simple visibility toggle node. Sets the object's hidden flag and refreshes its render data. The updateInstanceRenderData() call ensures the change takes effect immediately for objects that use instanced rendering (like TSStatic). The node reports an error in the editor if objID is not connected.

Example Usage

-- Hide an object during a cutscene
-- Wire objID from an ID by Name node
-- Wire hide = true to hide, false to show
-- Useful for revealing/hiding mission props, barriers, triggers

Additional Methods

C:init()

Initializes the node, setting up pins and default properties.

See Also

• Collection Marker (Flowgraph Node) - Related reference
• Custom Lua Command (Flowgraph Node) - Related reference
• Get Object Field (Flowgraph Node) - Related reference
• FlowGraph Guide - Guide