Unreal Engine 5 Documentation has been moved to the Epic Developer Community

Switch Nodes

A switch node reads in a data input, and based on the value of that input, sends the execution flow out of the matching (or optional default) execution output. There are several types of switches available: Int , String , Name , and Enum .

In general, switches have an execution input, and a data input for the type of data they evaluate. The outputs are all execution outputs. Enum switches automatically generate the output execution pins from the Enum 's properties, while Int , String , and Name switches have customizable output execution pins.

Editing Switch Nodes

When an Int , String , or Name switch node is added to a Blueprint, the only output execution pin available is the Default pin. The Default output execution pin will fire if the input fails to match any of the other specified output pins. It can be removed by either right-clicking on the pin and selecting Remove Execution Pin or by unchecking the Has Default Pin option in the Details tab for the switch node.

Editing an Int Switch:

1. Select the switch node in the Graph tab to bring up its properties in the Details tab.

2. Change the Start Index to the lowest integer value that you want to check against.

3. Click on Add Pin on the switch node to add the pin with your Start Index value.

Clicking on Add Pin further will add more pins, with the value incremented by 1 each time. To delete an execution pin, right-click on the pin and select Remove Execution Pin . Note that removing an output execution pin on a Switch on Int node causes any higher-valued pins to decrease their value by 1 to fill the gap.

Editing a Name or String Switch:

1. Select the switch node in the Graph tab to bring up its properties in the Details tab.

2. Click on the icon to the right of Pin Names .

3. Type the value you would like your String or Name to compare to in the text box that appears.

   
   

Repeat the process for any other pins you would like to add. Pins can also be duplicated, inserted, or deleted by clicking on the icon by the desired pin in the Details tab. To delete an execution pin, you can also right-click on the pin and select Remove Execution Pin .

Standard Flow Control Nodes

These nodes provide a variety of means to control the flow of execution.

Branch

The Branch node serves as a simple way to create decision-based flow from a single true/false condition. Once executed, the Branch node looks at the incoming value of the attached Boolean, and outputs an execution pulse down the appropriate output.

In this simple example, the branch is checking the current state of a boolean variable. If true, it sets the color of a light to be red. If false, it sets it to blue.

DoN

The DoN node will fire off an execution pulse N times. After the limit has been reached, it will cease all outgoing execution until a pulse is sent into its Reset input.

For example, you could have a vehicle start twenty times, and then fail to start until a refueling event tied to the Reset input was activated.

DoOnce

The DoOnce node - as the name suggests - will fire off an execution pulse just once. From that point forward, it will cease all outgoing execution until a pulse is sent into its Reset input. This node is equivalent to a DoN node where N = 1 .

For example, you could have the network for an opening door run through a DoOnce, and that door would open only one time. However, you could tie a trigger event into the Reset, which will cause the door to be accessible once the trigger has been activated.

FlipFlop

The FlipFlop node takes in an execution output and toggles between two execution outputs. The first time it is called, output A executes. The second time, B. Then A, then B, and so on. The node also has a boolean output allowing you to track when Output A has been called.

ForLoop

The ForLoop node works like a standard code loop, firing off an execution pulse for each index between a start and end.

In this simple example, the loop is triggered when the player touches a simple level trigger. The loop iterates 10 times, each time calling a Print String, which logs a prefix message along with the current iteration.

ForLoopWithBreak

The ForLoopWithBreak node works in a very similar manner to the ForLoop node, except that it includes an input pin that allows the loop to be broken.

In this simple example, the loop is triggered when the player touches a simple level trigger. The loop iterates 1,000 times, each time hitting a Branch which checks to see if the loop has hit 500 iterations. If it has not, then a message with the current iteration count is broadcast to the screen. Once it exceeds 500, the Branch calls a Custom Event, which in turn breaks the loop. A Custom Event is used for visual clarity, to eliminate the need to have the wire wrap back around to the Break input pin.

Gate

A Gate node is used as a way to open and close a stream of execution. Simply put, the Enter input takes in execution pulses, and the current state of the gate (open or closed) determines whether those pulses pass out of the Exit output or not.

In this simple example, a timeline with no tracks, with both auto-play and looping activated, updates the Enter input pin of a gate. In the level are two triggers. One trigger opens the gate, the other closes it. If the gate is open, then execution pulses leave the Exit pin and a Print String is called that logs a message to the screen. Once the player touches the Close trigger, the gate closes and the message stops displaying. If they then touch the Open trigger, the message starts to appear again.

MultiGate

The MultiGate node takes in a single data pulse and routs it to any number of potential outputs. This can take place sequentially, at random, and may or may not loop.

In this example, a simple looping and auto-playing timeline is outputting a pulse every half-second. That pulse hits the MultiGate and is routed accordingly, triggering one of a series of Print String nodes, which, when played in order, reveal a special message.

Sequence

The Sequence node allows for a single execution pulse to trigger a series of events in order. The node may have any number of outputs, all of which get called as soon as the Sequence node receives an input. They will always get called in order, but without any delay. To a typical user, the outputs will likely appear to have been triggered simultaneously.

In this example, the sequence node is called at the beginning of the level. It then fires off 5 Print String nodes in order. However, without a meaningful delay, it will seem as if the messages appear at almost the same time as one another.

WhileLoop

A test condition and a body are all that make up a WhileLoop . Before executing the statement(s) in its body, the Blueprint evaluates WhileLoop's test condition to determine if it is true. After executing the statement(s) in its body, the Blueprint re-evaluates the test condition, and if the condition remains true, it keeps executing the statement(s) in the loop's body. Otherwise, if the test condition returns false, the Blueprint terminates the loop and exits the loop's body.

The following table describes the node's pins:

Example Usage

The following example shows a Blueprint printing Start WhileLoop to the Viewport (1) before entering the WhileLoop body and evaluating whether Counter is less than Count Limit (2). While the test condition (2) evaluates true , the Blueprint remains in the WhileLoop body and increments the counter integer before printing Counter Value: [Counter] to the Viewport (3). When the test condition (2) evaluates false , the Blueprint exits the WhileLoop body, and prints WhileLoop Completed to the Viewport.