Skip to main content
TikTok Effect House Platform Logo
Latest
Download
Log in
Visual Scripting Overview

Visual Scripting Overview

Visual Scripting in Effect House lets you create interactive effects without worrying about writing text-based code. Use nodes and variables to create complex logic.

Get Started

To open the Visual Scripting panel, click the Graph icon on the top-left of the Effect House interface. By default, a navigational mini-map will show up on the top-right corner of the panel.

Visual Scripting Nodes

Visual Scripting is a node-based creation system where each node performs a different function within your logic flow. As you connect each node, they will receive and pass information along the sequence. This system of connections allows you to use Visual Scripting to add triggers, events, controllers, and more to your effects.

Explore Each Node Type

  1. By default, two nodes are automatically added to a project: Start and Update. Start will be called when the effect begins and Update will be called once every frame.
  2. Go to the Visual Scripting panel and click + Add node at the top of the interface. A menu with every node will pop up. Select a node from the menu or type the name to search, and then click the node to add it to the panel.
Tip
Tip

You can also right-click on a blank area of the Visual Scripting panel and select Add node to perform this action.

unaligned-image-0
unaligned-image-1
Adding the Multiply node

View Node Variables

A variable is a symbol which works as a placeholder for expressions or quantities that may vary or change. It only needs to be initiated once and can be reused multiple times throughout the effect creation process.

Add a Variable

  1. Go to the Visual Scripting panel and right click to select Show/Hide variable. This will open the variable menu.
Showing node variables

2. Click + Add variable on the bottom of the menu to add a variable. You can click the text area to rename each variable, open the drop-down list to change the variable data type and assign an initial value to it. You can also click the small trash can icon to delete an existing variable.

Changing a node's name, data type, and initial value

3. You can retrieve or set a variable by clicking + > Get/Set Variable. This will automatically create a variable node and add it to the Visual scripting panel.

Creating a custom node

Make Your First Effect With Visual Scripting

Try making a simple effect by using the Mouth open and Mouth close actions to change the visibility of a cube. You can also follow along in the sections below. Here is a demo of the final result and the project package:

A person opening their mouth to make a box appear and disappear

↓ VisualScriptingDemo.zip

Add an Object and Nodes

  1. To start, add a 3D cube object to the scene by pressing + Add Object > 3D > Cube. Adjust the Position parameters of the cube to place it in the desired position on your screen.
Adding a 3D cube and setting its location in the tool

2. Since you are using mouth open/close actions as triggers, select a Mouth Open demonstration video from the drop-down list in the Preview panel to test the effect.

Selecting a preview video of a person opening and closing their mouth

3. Right click in the Visual Scripting panel, and search for and select the Facial Movement Detection. Set the Facial Movement property to Mouth Open.

Adding the Facial Movement Detection node to the Visual Scripting graph

4. Then find and add the node Set Visibility to the panel.

Adding a Set Visibility node to the Visual Scripting graph

5. In the node information, check the required inputs. Since Set Visibility needs to take an Object, select the cube object from the Hierarchy panel and drag it to the Visual Scripting panel. This will create the cube object node automatically.

6. Set the visibility value. There is a checkbox next to the Value of Visibility On. Check/ unchecked it to set the value to true (visible) or false (invisible).

Unchecking the Value of the Set Visibility node

Link the Nodes

  1. Link the Begin output of Facial Movement Detection to the Enter input of Set Visibility, link the Entity output of Cube to the Target input of Set Visibility, and then unchecked the box next to the Visibility On input of Set Visibility.
Linking the Facial Recognition and Cube nodes to the Set Visibility node

2. Add a new Set Visibility node in order to make the cube visible when the mouth is closed. Link the newly added nodes accordingly and select the Visibility On checkbox this time. You can move the nodes around to clean up and organize your interface.

Duplicating the Set Visibility node, then linking the Facial Recognition Detection node to it

3. Congratulations! Now that you’ve learned the basics of visual scripting, feel free to incorporate it into your own effects.

Node Types

There are eight different types of nodes in Effect House that help you work with interaction, logic, and more.

Node typesIconDescriptionExample(s)
Event
Nodes that detect an event and output triggers accordingly.Screen tap captures a touch event.
Logic
Checks the logic of the input(s), often comparing two values.Greater than checks if one input value is greater than another.
Control
Use these nodes to control the flow of triggers.For loop, If, and Sequence.
Math
These nodes perform math functions.Random, Floor, and Multiply.
Time
Nodes relating to time.Get time tracks the time in seconds since the start of the effect.
Utility
The root level of entity and component statusSet visibility sets the visibility of an object.
Transform
The root level of transform related triggersLocal Transforminfo outputs the local transform data of a scene object.
Head & Face
Nodes related to the head and face.Facial Movement Detection triggers the next node when a particular movement is detected.
Hand
Nodes related to the hand.Hand detection triggers the next node when a hand is detected on screen.
Body
The root level of body triggersBody detection triggers the next node when there is a body detecte in camera view.
Audio
Nodes related to audio.Beat detection outputs the imported audio’s beat.

Node Information

You can view a node’s basic information by following the menu. Let’s use the Body Detection node as an example:

A menu with the Body Detection node's information
  • Name: The name is at the top of the node information.
  • Description: A description of the node’s primary functionality.
  • Inputs and Outputs: Ports along the left side of a node are known as “node inputs”. Ports along the right side of a note are called “node outputs.” You’ll link one node to another by making a connection from an output port to an input port.
Tip
Tip

Right-clicking on an added node and selecting Node info or directly clicking the ⓘ icon will show node info.

unaligned-image-0
unaligned-image-1

Manage the Visual Scripting Panel

Subgraphs

Subgraphs are a set of nodes grouped together that can help organize your Visual Scripting.

Creat a Subgraph

  1. Select the nodes you want to group.
  2. Right-click on the nodes, then select Create subgraph. You can change the name of the subgraph by double-clicking on the name at the top of the node.
Creating a Visual Scripting subgraph

Edit a Subgraph

  1. Double-click the subgraph node to dive into it and edit the grouped nodes.
  2. Click on the Main Graph button on the top-left corner of the Visual Scripting panel to go back to the top-level graph. You can also right-click on a subgraph node to ungroup it.
Editing a subgraph

Use the Mini-Map to Navigate

NameIconDescription
Mini-map
The mini-map icon on the top-right corner of the Visual Scripting panel allows you to toggle the mini-map on and off.

When the mini-map is open, you can drag the rectangle on it to navigate the panel.
Zoom
The zoom button centers the nodes on the panel.