Docs/Atom library/Actions (DO)
Actions (DO)
Every action atom — 154 side effects you can chain in the DO slot of a rule.
Last updated 2026-06-06
Some actions need a player (per-player effects like show_hud); others broadcast globally (end_game, toggle_device). The card lists each action's device (the UEFN actor it needs wired) and its full param list.
💡 Tip
advanced3
Call Binding Port
call_binding_portCalls a public method on another device via a binding port. Used for cross-device communication in modular setups.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
bindingName | string | "Inventory" | Binding Name |
portVerseName | string | "AddItem" | Port Method Name |
args | string | "" | Arguments |
captureMode | select | "none" | Return Value |
inlineVarName | string | "Result" | Name of the local variable (available in subsequent actions of this rule). |
targetVariable | string | "" | Variable ID to store the result into (e.g. my_score). |
Call Device Function
call_device_functionCalls a custom helper function generated by a preset (visible in "Custom Methods & Messages"). Safer alternative to Custom Verse for invoking internal device logic.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
functionName | string | "" | The Verse function name to call (e.g. RefreshBackpackHUD). |
passPlayer | boolean | true | When enabled, the current Player is passed as the first argument. |
argsadv | string | "" | Additional arguments (comma-separated). E.g. "3, true" → MyFunc(Player, 3, true). |
Custom Verse
custom_verseInjects raw Verse code directly into the handler. No validation — for advanced users who need functionality not covered by atoms.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
code | string | "" | Verse code |
imports | string | "" | Imports (comma-separated) |
audio3
Play Sound
play_soundPlays audio from the Audio Player device. Targets a specific player or broadcasts to all.
audio_player_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
target | select | "player" | Target |
Set Audio State
set_audio_stateEnables or disables the Audio Player device.
audio_player_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
action | select | "enable" | Action |
Stop Sound
stop_soundStops audio playback from the Audio Player device. Targets a specific player or stops for all.
audio_player_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
target | select | "player" | Target |
collectible3
Hide Collectible
hide_collectibleMakes a collectible object invisible in the world.
collectible_object_deviceUEFN39.50+Respawn Collectible
respawn_collectibleRespawns a collectible object for one agent or for all agents.
collectible_object_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
mode | select | "agent" | Respawn for |
Show Collectible
show_collectibleMakes a collectible object visible in the world.
collectible_object_deviceUEFN39.50+device1
Enable/Disable Device
toggle_deviceEnables or disables a generic creative device.
trigger_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
mode | string | "enable" | Mode |
economy5
Consume Entitlement
consume_entitlementConsumes a quantity of an entitlement from a player.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
entitlement | string | "qa_test_item" | Entitlement class name (snake_case, from define_entitlement) |
count | int | 1 | Count |
Give Currency
give_currencyAdds currency to a player variable and optionally shows a notification.
hud_message_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
variableId | string | "player_coins" | Variable |
amount | int | 50 | Amount |
showNotification | boolean | true | Show Notification |
notificationText | string | "" | Notification Text |
Grant Entitlement
grant_entitlementGrants an entitlement to a player. Returns logic (failable).
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
entitlement | string | "qa_test_item" | Entitlement class name (snake_case, from define_entitlement) |
count | int | 1 | Count |
Show Shop
show_shopOpens the in-island shop dialog with the specified offers.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
offers | string | "" | Offers (comma-separated) |
title | string | "" | Title (optional) |
Spend Currency
spend_currencyChecks if the player has enough currency, decrements the variable, or shows a failure message.
hud_message_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
variableId | string | "player_coins" | Variable |
amount | int | 100 | Amount |
failMessage | string | "Not enough coins!" | Fail Message |
environment3
Barrier Clear Ignore List
barrier_remove_all_ignoreRemoves all players from the barrier ignore list. Players on an ignored team or class are still ignored.
barrier_deviceUEFN39.50+Barrier Ignore Agent
barrier_ignore_agentAdds or removes a player from the barrier ignore list. Ignored players can pass through freely. Has no effect on bullets.
barrier_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
action | select | "add" | Action |
Set Barrier State
set_barrier_stateEnables or disables the barrier device. A disabled barrier no longer blocks movement or projectiles.
barrier_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
action | select | "enable" | Action |
game-flow5
End Game
end_gameEnds the round/game. Uses the agent's team when Activating Team is enabled.
end_game_deviceUEFN39.50+End Round
end_roundEnds the current round. The triggering player's team wins the round.
round_settings_deviceUEFN39.50+End Round (Team)
end_round_teamEnds the round with the device's configured team as the winner.
team_settings_and_inventory_deviceUEFN39.50+Set End Game State
set_end_game_stateEnables or disables the end game device. A disabled device cannot trigger game end.
end_game_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
action | select | "enable" | Action |
Set Round Settings State
set_round_settings_stateEnables or disables the round settings device.
round_settings_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
action | select | "enable" | Action |
inventory3
Buy Item (Safe)
inventory_buyAtomically checks coins + inventory space before buying. Prevents money loss when inventory is full.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
currencyVariableId | string | "coins" | Currency Variable |
price | int | 50 | Price |
inventoryId | string | "inv_slot" | Inventory ID |
itemId | int | 1 | Item ID |
qty | int | 1 | Quantity |
successPopupTag | string | "PopupBuyOK" | Success Popup Tag |
failurePopupTag | string | "PopupBuyFail" | Failure Popup Tag |
Collect Item to Inventory
inventory_collectChecks if the inventory has room (matching stack or empty slot), adds the item if possible, and shows a feedback popup. If full, shows an "inventory full" popup instead.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
inventoryId | string | "inv_slot" | Inventory ID |
itemId | int | 1 | Item ID |
qty | int | 1 | Quantity |
successPopupTag | string | "PopupCollect" | Success Popup Tag |
fullPopupTag | string | "PopupFull" | Full Popup Tag |
Reset Inventory Array
reset_inventoryResets all slots of an inventory array to empty (ItemId=0, Qty=0). Replaces multiple set_variable calls.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
inventoryId | string | "inv_slot" | Inventory ID |
slotCount | int | 8 | Slot Count |
item15
Clear Item Save Data
clear_item_save_dataClears saved item granter data for the player. Only works when "Grant While Offline" is enabled.
item_granter_deviceUEFN39.50+Cycle Next Item
cycle_next_itemCycles to the next item on the Item Granter device. If Grant on Cycle is set, the agent receives the item.
item_granter_deviceUEFN39.50+Cycle Previous Item
cycle_previous_itemCycles to the previous item on the Item Granter device. If Grant on Cycle is set, the agent receives the item.
item_granter_deviceUEFN39.50+Cycle Random Item
cycle_random_itemCycles to a random item on the Item Granter device. If Grant on Cycle is set, the agent receives the item.
item_granter_deviceUEFN39.50+Disable Item Granter
disable_item_granterDisables the Item Granter device.
item_granter_deviceUEFN39.50+Enable Item Granter
enable_item_granterEnables the Item Granter device.
item_granter_deviceUEFN39.50+Grant Item
grant_itemGrants the configured item(s) to the agent using the Item Granter device.
item_granter_deviceUEFN39.50+Grant Item at Index
grant_item_indexGrants the item at a specific index. Index is 0-based.
item_granter_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
itemIndex | int | 0 | Item index (0-based) |
target | select | "player" | Target |
Grant Item To All
grant_item_to_allGrants an item to all players without requiring an agent. Only works when Receiving Players is set to All or Team Index.
item_granter_deviceUEFN39.50+Grant Random Item
grant_random_itemGrants a random item from a weighted list of Item Granter devices.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
items | string | "" | Item Granters |
weights | string | "" | Weights |
Remove Item (Item Remover)
remove_itemRemoves the configured items from the player's held Fortnite items via the Item Remover device. Not related to the Game Data slot Inventory.
item_remover_deviceUEFN39.50+Restock Item Granter
restock_itemsRestocks the Item Granter device back to its starting stock count. Not related to the Game Data slot Inventory.
item_granter_deviceUEFN39.50+Set Item Grant Count
set_item_grant_countSets the quantity of items to grant at a specific index in the Item Granter device.
item_granter_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
itemIndex | int | 0 | Item Index |
count | int | 1 | Count |
Set Item Remover State
set_item_remover_stateEnables or disables the item remover device.
item_remover_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
action | select | "enable" | Action |
Set Next Item
set_next_itemSets the next item to be granted by index (0-based). Invalid index does nothing.
item_granter_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
itemIndex | int | 0 | Item index (0-based) |
movement3
Enable/Disable Teleporter
set_teleporter_stateEnables or disables a teleporter device.
teleporter_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
state | select | "enable" | State |
Teleport
teleportTeleports the agent to the target group or to this device.
teleporter_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
direction | select | "to_target" | Direction |
Teleporter Link
teleporter_linkActivates, deactivates, or resets the link between this teleporter and its target.
teleporter_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
action | select | "activate" | Action |
npc4
Despawn NPC
despawn_npcDespawns guards from the Guard Spawner. Can target all guards or only those hired by a specific player.
guard_spawner_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
target | select | "all" | Target |
Force Guard Attack Target
force_guard_attack_targetForces guards from this spawner to attack a specific agent.
guard_spawner_deviceUEFN39.50+Set Guard Spawner State
set_guard_spawner_stateEnables, disables, or resets the Guard Spawner device.
guard_spawner_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
action | select | "enable" | Action |
Spawn NPC
spawn_npcSpawns a guard/NPC at the Guard Spawner device location.
guard_spawner_deviceUEFN39.50+phase1
Start Phase
start_phaseTriggers a specific game phase by calling its RunPhase function. Requires define_phase.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
phaseId | string | "" | Phase ID |
player4
Apply Damage
apply_damageEnables the Damage Volume and sets the damage per tick. Agents inside the volume take damage automatically.
damage_volume_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
amount | int | 25 | Amount |
Apply Speed Boost
apply_speed_boostApplies a speed effect to the agent using the Movement Modulator device. Speed multiplier is configured in UEFN device settings.
movement_modulator_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
duration | float | 0 | Duration (seconds) |
For Each Player
for_each_playerModifier: executes all subsequent actions for every player in the playspace.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
filter | select | "all" | Filter |
Heal Player
heal_playerHeals the agent by the specified amount using the Health Powerup device.
health_powerup_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
amount | int | 50 | Amount |
quest2
Activate Quest
activate_questActivates a quest for the player so it starts tracking progress.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
questId | string | "my_quest" | Quest ID |
Deactivate Quest
deactivate_questDeactivates a quest for the player so it stops tracking progress.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
questId | string | "my_quest" | Quest ID |
score7
Add Score
add_scoreAwards points to the agent using the Score Manager device.
score_manager_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
amount | int | 1 | Score Amount |
Decrement Score
decrement_scoreDecrements the score manager value for a player or globally.
score_manager_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
target | select | "player" | Target |
Increment Score
increment_scoreIncrements the score manager value for a player or globally.
score_manager_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
target | select | "player" | Target |
Reset Score
reset_scoreResets all scores on the Score Manager device.
score_manager_deviceUEFN39.50+Set Score Manager State
set_score_manager_stateEnables or disables the score manager device.
score_manager_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
action | select | "enable" | Action |
Set To Agent Score
set_to_agent_scoreSets the score manager's value to the agent's current score.
score_manager_deviceUEFN39.50+Show Leaderboard
show_leaderboardDeprecatedDisplays a leaderboard ranking players by a variable. Generates sort + display code.
hud_message_deviceUEFN39.50+Deprecated: Only displays the title via hud_message_device (which does not support multi-line text). For a real ranking, use the Leaderboard widget in the HUD tab (bound to your variable) — it iterates over all players and shows each rank in its own text block.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
variableId | string | "player_kills" | Variable |
top | int | 5 | Top N players |
title | string | "Leaderboard" | Title |
duration | float | 15 | Display time (seconds) |
spatial1
Get Player Position
get_player_positionReads the player position and stores X/Y/Z coordinates in player variables (as integers in cm).
tags4
Collect Tagged Item
collect_tagged_itemFinds the nearest prop with the specified tag, adds to inventory variable, and hides or destroys the prop.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
tagName | tag | "pickup_gold" | Tag Name |
maxDistance | float | 200 | Pickup Range (cm) |
inventoryVariableId | string | "inv_gold" | Inventory Variable |
amount | int | 1 | Amount |
destroyMode | select | "hide" | After Pickup |
Find All Tagged Objects
find_all_tagged_objectsFinds all creative objects with the specified tag within max distance. Stores the count in a variable.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
tagName | tag | "my_tag" | Tag Name |
maxDistance | float | 1000 | Max Distance (cm) |
countVariableId | string | "tagged_count" | Count Variable |
Find Nearest Tagged Object
find_nearest_tagged_objectFinds the nearest creative object with the specified tag within max distance. Stores position in variables.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
tagName | tag | "my_tag" | Tag Name |
maxDistance | float | 1000 | Max Distance (cm) |
Interact With Tagged Object
interact_with_tagged_objectFinds the nearest object with the specified tag and performs an action on it (activate, disable, toggle, hide, dispose).
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
tagName | tag | "my_tag" | Tag Name |
maxDistance | float | 1000 | Max Distance (cm) |
action | select | "activate" | Action |
team1
Assign Team
assign_teamSets a team tracking variable for the player. Team assignment in UEFN is handled by device settings.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
team | select | "team_1" | Team |
timer15
Clear Timer Data
clear_timer_dataClears the timer device's saved persistence data.
timer_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
target | select | "player" | Target |
Complete Timer
complete_timerForces the timer to complete immediately (triggers SuccessEvent).
timer_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
target | select | "global" | Target |
Delay
delayFires remaining actions after a delay, without blocking the event handler. Use Wait if you need sequential timing.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
seconds | float | 5 | Duration (seconds) |
Disable Timer
disable_timerDisables the timer device completely. While disabled, it ignores all signals (Start, Pause, Reset). Use Enable Timer to reactivate.
timer_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
target | select | "global" | Target |
Enable Timer
enable_timerEnables the timer device so it can receive Start/Pause/Reset signals. Does NOT start the countdown — use Start Timer for that.
timer_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
target | select | "global" | Target |
Load Timer
load_timerLoads the timer device's saved data for the player (persistence).
timer_deviceUEFN39.50+Pause Timer
pause_timerPauses the timer without resetting it. Use Resume Timer to continue from where it stopped.
timer_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
target | select | "global" | Target |
Reset Timer
reset_timerResets the timer back to its initial duration and stops it. Use Start Timer to begin a new countdown.
timer_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
target | select | "global" | Target |
Resume Timer
resume_timerResumes a paused timer from where it stopped. Has no effect if the timer is not paused.
timer_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
target | select | "global" | Target |
Save Timer
save_timerSaves the timer device's data for the player (persistence).
timer_deviceUEFN39.50+Set Lap Time
set_lap_timeSets the lap time indicator on the timer device.
timer_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
target | select | "player" | Target |
Set Timer Duration
set_timer_durationSets the remaining time (in seconds) on the timer, if active.
timer_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
seconds | float | 30 | Duration (seconds) |
target | select | "global" | Target |
Set Timer Max Duration
set_timer_max_durationSets the maximum duration of the timer device.
timer_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
seconds | float | 120 | Max duration (seconds) |
Start Timer
start_timerBegins the timer countdown. The timer must be enabled first with Enable Timer.
timer_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
target | select | "global" | Target |
Wait
waitPauses between actions for a duration. All following actions in this rule run after the wait completes.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
duration | float | 2 | Duration (seconds) |
tracker8
Complete Tracker
complete_trackerMarks the tracker as complete for the triggering player.
tracker_deviceUEFN39.50+Increment/Decrement Tracker
increment_trackerIncreases or decreases the tracker value for an agent.
tracker_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
mode | select | "increment" | Direction |
Remove Tracker
remove_trackerRemoves the tracker assignment from a player or all players.
tracker_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
target | select | "player" | Target |
Reset/Assign Tracker
reset_trackerResets tracker progress for an agent, or assigns the tracker to agents.
tracker_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
mode | select | "reset" | Action |
Save/Load Tracker
save_trackerSaves, loads, or clears persistent tracker data for a player.
tracker_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
action | select | "save" | Action |
Set Tracker Target/Value
set_tracker_targetSets the target value or current tracked value of a tracker device.
tracker_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
mode | select | "target" | Set |
amount | int | 5 | Amount |
Set Tracker Text
set_tracker_textUpdates the tracker title or description text displayed to players.
tracker_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
field | select | "title" | Field |
text | string | "Objective" | Text |
Update Tracker Target
update_tracker_targetIncreases or decreases the tracker target value by 1 for a player.
tracker_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
action | select | "increase" | Action |
trade-system26
Activate Player Reference
activate_player_referenceActivates the Player Reference device, triggering its ActivatedEvent with the stored agent. Use Device Tag to target a specific instance.
player_reference_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
deviceTag | string | "" | Device Tag |
Clear Player Reference
clear_player_referenceClears the player tracked by the Player Reference device. Use Device Tag to target a specific instance.
player_reference_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
deviceTag | string | "" | Device Tag |
For Each Player In Zone
get_agents_in_volumeModifier: runs the following actions for every player currently inside a volume/zone — per-player actions (scoring, HUD) auto-cast to the player. The canonical loop for zone-control modes: King of the Hill, hold-the-hill, capture/control point — award points per second to each player standing in the zone, score while in the area.
volume_deviceUEFN39.50+Register Player Reference
register_player_referenceRegisters an agent as the player tracked by the Player Reference device. Use Device Tag to target a specific instance.
player_reference_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
deviceTag | string | "" | Device Tag |
Set Player Reference State
set_player_reference_stateEnables or disables the Player Reference device.
player_reference_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
action | select | "enable" | Action |
Trade: Allocate Pool Slot
trade_allocate_slotFinds a free slot in the device pool and registers both players for pooled trade mode. Part of the P2P Trade system (pool mode).
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
playerSlotVarIdadv | string | "player_slot" | PlayerSlot Variable ID |
sideVariableIdadv | string | "trade_side" | Trade Side Variable |
tradingVariableIdadv | string | "is_trading" | Trading State Variable |
partnerFoundVariableIdadv | string | "trade_partner_found" | Partner Found Variable |
stationTagNameadv | tag | "trade_station" | Station Tag Name |
maxDistance | number | 1500 | Max Distance |
hudGroupId | hudGroup | "" | HUD Group to show for both players |
fullMessage | string | "All trade stations busy" | Message when pool is full |
noPartnerMessage | string | "No partner nearby" | Message when no partner nearby |
Trade: Cancel (Proximity)
trade_cancel_proximityCancels the trade for both players: resets all variables, hides HUD, clears refs. Part of the P2P Trade system.
hud_message_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
sideVariableIdadv | string | "trade_side" | Side Variable |
tradingVariableIdadv | string | "is_trading" | Trading State Variable |
offerVariableIdadv | string | "trade_offer" | Offer Variable |
validationVariableIdadv | string | "trade_validated" | Validation Variable |
partnerOfferVariableIdadv | string | "partner_offer" | Partner Offer Variable |
partnerValidationVariableIdadv | string | "partner_validated" | Partner Validation Variable |
hudGroupId | hudGroup | "" | HUD Group |
cancelMessage | string | "Trade cancelled" | Cancel Message |
offerVariableIdsadv | variableList | "" | Offer Variable IDs (comma-separated, multi-item) |
partnerOfferVariableIdsadv | variableList | "" | Partner Offer Variable IDs (comma-separated, multi-item) |
globalTradeActiveIdadv | string | "" | Global Trade Active Variable |
Trade: Check & Swap
trade_check_and_swapChecks if both players validated their trade, then executes the currency swap atomically. Part of the P2P Trade system — use the Trade preset for the full setup.
hud_message_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
sideVariableIdadv | string | "trade_side" | Side Variable |
currencyVariableIdadv | string | "trade_coins" | Currency Variable |
offerVariableIdadv | string | "trade_offer" | Offer Variable |
validationVariableIdadv | string | "trade_validated" | Validation Variable |
successMessage | string | "Trade complete!" | Success Message |
partnerOfferVariableIdadv | string | "" | Partner Offer Mirror Variable |
partnerValidationVariableIdadv | string | "" | Partner Validation Mirror Variable |
globalTradeActiveIdadv | string | "" | Global Trade Active Variable |
Trade: Check & Swap (Multi-Item)
trade_check_and_swap_multiMulti-item trade swap: checks both players validated, then swaps multiple item types atomically. Part of the P2P Trade system.
hud_message_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
sideVariableIdadv | string | "trade_side" | Side Variable |
validationVariableIdadv | string | "trade_validated" | Validation Variable |
itemSlotsadv | string | "inv_sword:offer_sword:partner_offer_sword,inv_potion:offer_potion:partner_offer_potion" | Item Slots (currency:offer:partnerOffer, ...) |
successMessage | string | "Trade complete!" | Success Message |
partnerValidationVariableIdadv | string | "" | Partner Validation Mirror Variable |
Trade: Find Nearby Player
trade_find_nearby_playerScans nearby players at a trade station and registers the closest one as trade partner. Part of the P2P Trade system.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
stationTagNameadv | tag | "trade_station" | Station Tag (for position vars) |
maxDistance | float | 1500 | Max Distance (cm) |
partnerFoundVariableIdadv | string | "trade_partner_found" | Partner Found Variable |
sideVariableIdadv | string | "trade_side" | Trade Side Variable |
tradingVariableIdadv | string | "is_trading" | Trading State Variable |
hudGroupId | hudGroup | "" | HUD Group to show for partner |
Trade: Find Nearest Station
trade_find_nearest_stationFinds the nearest trade station device and stores its position in variables. Part of the P2P Trade system.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
tagNameadv | tag | "trade_station" | Station Tag |
maxDistance | float | 1500 | Max Distance (cm) |
Trade: Proximity Check (loop)
trade_proximity_checkMonitors both players distance to the trade station in a loop. Auto-cancels with full cleanup if either walks away. Part of the P2P Trade system.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
stationTagNameadv | tag | "trade_station" | Station Tag (for position vars) |
maxDistance | float | 1500 | Max Distance (cm) |
tradingVariableIdadv | string | "is_trading" | Trading State Variable |
checkIntervaladv | float | 1 | Check Interval (seconds) |
sideVariableIdadv | string | "trade_side" | Side Variable |
offerVariableIdadv | string | "trade_offer" | Offer Variable |
validationVariableIdadv | string | "trade_validated" | Validation Variable |
partnerOfferVariableIdadv | string | "partner_offer" | Partner Offer Variable |
partnerValidationVariableIdadv | string | "partner_validated" | Partner Validation Variable |
hudGroupId | hudGroup | "" | HUD Group |
cancelMessage | string | "Trade cancelled" | Cancel Message |
offerVariableIdsadv | variableList | "" | Offer Variable IDs (comma-separated, multi-item) |
partnerOfferVariableIdsadv | variableList | "" | Partner Offer Variable IDs (comma-separated, multi-item) |
globalTradeActiveIdadv | string | "" | Global Trade Active Variable |
Trade: Refund All Trade Slots to Inventory
trade_refund_to_inventoryReturns all items from trade slots back to the player inventory on cancel. Part of the P2P Trade system (inventory mode).
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
tradeSlotCountadv | int | 4 | Trade Slot Count |
invSlotCountadv | int | 8 | Inventory Slot Count |
invPrefixadv | string | "inv_slot" | Inventory Var Prefix |
tradePrefixadv | string | "trade_slot" | Trade Var Prefix |
inventoryModeadv | boolean | false | Use Inventory Arrays |
Trade: Release Pool Slot
trade_release_slotReleases the pool slot after trade completes, clearing both player references. Part of the P2P Trade system (pool mode).
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
playerSlotVarIdadv | string | "player_slot" | PlayerSlot weak_map Variable ID |
sideVariableIdadv | string | "trade_side" | Trade Side Variable |
tradingVariableIdadv | string | "is_trading" | Trading State Variable |
offerVariableIdadv | string | "trade_offer" | Offer Variable |
validationVariableIdadv | string | "trade_validated" | Validation Variable |
partnerOfferVariableIdadv | string | "partner_offer" | Partner Offer Variable |
partnerValidationVariableIdadv | string | "partner_validated" | Partner Validation Variable |
hudGroupId | hudGroup | "" | HUD Group |
offerVariableIdsadv | variableList | "" | Offer Variable IDs (comma-separated, multi-item) |
partnerOfferVariableIdsadv | variableList | "" | Partner Offer Variable IDs (comma-separated, multi-item) |
Trade: Reset Partner Validation
trade_reset_partner_validationResets partner validation when an offer changes, so they must re-confirm. Part of the P2P Trade system.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
sideVariableIdadv | string | "trade_side" | Side Variable |
validationVariableIdadv | string | "trade_validated" | Validation Variable |
Trade: Swap Slots (Atomic)
trade_swap_slotsExecutes the final swap of trade slots between both players. Part of the P2P Trade system (inventory mode).
hud_message_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
sideVariableIdadv | string | "trade_side" | Side Variable |
validationVariableIdadv | string | "trade_validated" | Validation Variable |
tradeSlotCountadv | int | 2 | Trade Slot Count |
invSlotCountadv | int | 4 | Inventory Slot Count |
invPrefixadv | string | "inv_slot" | Inventory Var Prefix |
tradePrefixadv | string | "trade_slot" | Trade Var Prefix |
partnerPrefixadv | string | "partner_slot" | Partner Var Prefix |
partnerValidationVariableIdadv | string | "" | Partner Validation Mirror Variable |
successMessage | string | "Trade complete!" | Success Message |
inventoryModeadv | boolean | false | Use Inventory Arrays |
Trade: Sync Offer to Partner
trade_sync_offer_to_partnerSyncs the player offer amount to the partner mirror variable. Part of the P2P Trade system.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
sideVariableIdadv | string | "trade_side" | Side Variable |
offerVariableIdadv | string | "trade_offer" | Offer Variable |
partnerOfferVariableIdadv | string | "partner_offer" | Partner Offer Variable |
Trade: Sync Offers to Partner (Multi-Item)
trade_sync_offer_to_partner_multiSyncs multiple item offers to the partner mirror variables. Part of the P2P Trade system (multi-item).
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
sideVariableIdadv | string | "trade_side" | Side Variable |
itemSlotsadv | string | "offer_sword:partner_offer_sword,offer_potion:partner_offer_potion" | Item Slots (offerVar:partnerOfferVar, ...) |
Trade: Sync Slots to Partner
trade_sync_slotsSyncs trade slot contents to partner mirror variables. Part of the P2P Trade system (inventory mode).
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
sideVariableIdadv | string | "trade_side" | Side Variable |
tradeSlotCountadv | int | 2 | Trade Slot Count |
tradePrefixadv | string | "trade_slot" | Trade Var Prefix |
partnerPrefixadv | string | "partner_slot" | Partner Var Prefix |
inventoryModeadv | boolean | false | Use Inventory Arrays |
Trade: Sync Validation to Partner
trade_sync_validation_to_partnerSyncs the player validation state to the partner mirror variable. Part of the P2P Trade system.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
sideVariableIdadv | string | "trade_side" | Side Variable |
validationVariableIdadv | string | "trade_validated" | Validation Variable |
partnerValidationVariableIdadv | string | "partner_validated" | Partner Validation Variable |
Trade: Transfer Item from Trade Slot
trade_transfer_from_tradeMoves an item from a trade slot back to the player inventory. Part of the P2P Trade system (inventory mode).
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
tradeSlotIndexadv | int | 0 | Trade Slot Index |
invSlotCountadv | int | 4 | Inventory Slot Count |
invPrefixadv | string | "inv_slot" | Inventory Var Prefix |
tradePrefixadv | string | "trade_slot" | Trade Var Prefix |
inventoryModeadv | boolean | false | Use Inventory Arrays |
Trade: Transfer Item to Trade Slot
trade_transfer_to_tradeMoves an item from the player inventory to a trade slot. Part of the P2P Trade system (inventory mode).
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
sourceSlotIndexadv | int | 0 | Source Inventory Slot Index |
tradeSlotCountadv | int | 2 | Trade Slot Count |
invPrefixadv | string | "inv_slot" | Inventory Var Prefix |
tradePrefixadv | string | "trade_slot" | Trade Var Prefix |
inventoryModeadv | boolean | false | Use Inventory Arrays |
ui22
Clear All HUD Messages
clear_hud_messagesClears all queued HUD messages from all players.
hud_message_deviceUEFN39.50+Disable Popup
disable_popupDisables the Popup Dialog device. While disabled, Show Popup has no effect.
popup_dialog_deviceUEFN39.50+Enable Popup
enable_popupEnables the Popup Dialog device so it can be shown. This does NOT display the popup — use Show Popup for that.
popup_dialog_deviceUEFN39.50+Hide HUD Group
hide_hud_groupHides all widgets in a HUD group.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
groupId | hudGroup | "inventory" | Group name |
Hide HUD Message
hide_hudHides the currently displayed HUD message.
hud_message_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
target | select | "player" | Target |
Hide Popup
hide_popupHides the popup dialog. Does not disable the device — it can still be shown again.
popup_dialog_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
target | select | "player" | Target |
Set Billboard Text
set_billboardSets the text on a Billboard device using a localizable message, then shows it to the player.
billboard_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
text | string | "Hello!" | Display Text |
Set HUD Display Time
set_hud_display_timeSets the duration (in seconds) the HUD message is displayed. 0 = persistent.
hud_message_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
seconds | float | 5 | Duration (seconds, 0 = persistent) |
Set HUD Text
set_hud_textSets the HUD message text to display when activated (max 150 chars).
hud_message_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
text | string | "Hello!" | Message text |
Set Popup Description
set_popup_descriptionSets the popup description text (max 350 characters).
popup_dialog_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
text | string | "Description" | Description text |
Set Popup Title
set_popup_titleSets the popup title text (max 32 characters).
popup_dialog_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
text | string | "Title" | Title text |
Show HUD Group
show_hud_groupShows all widgets in a HUD group.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
groupId | hudGroup | "inventory" | Group name |
Show HUD Message
show_hudDisplays a HUD message. Targets a specific player or broadcasts to all.
hud_message_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
text | string | "" | Message text |
target | select | "player" | Target |
displayTime | float | 0 | Display time (seconds, 0 = persistent) |
Show Popup
show_popupShows a popup dialog to the player. The popup device must be enabled first (see Enable Popup).
popup_dialog_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
target | select | "player" | Target |
Switch Exclusive HUD Group
switch_hud_exclusive_groupSwitches to a specific page in an exclusive HUD group set. Hides all sibling groups and shows only the target — like tabs.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
exclusiveSetId | hudExclusiveSet | "pages" | Exclusive set name |
groupIndex | int | 0 | Group index (0-based) |
Toggle HUD Group
toggle_hud_groupToggles visibility of all widgets in a HUD group (show if hidden, hide if visible).
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
groupId | hudGroup | "inventory" | Group name |
Update Billboard Text
update_billboard_textUpdates the text on a Billboard device without changing its visibility. Use Set Billboard to also show it.
billboard_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
text | string | "Hello!" | Text |
variable4
Decrement Variable
decrement_variableDecreases a variable by a specified amount (minimum 0).
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
variableId | string | "my_var" | Variable |
amount | int | 1 | Amount |
Increment Variable
increment_variableIncreases a variable by a specified amount.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
variableId | string | "my_var" | Variable |
amount | int | 1 | Amount |
Set Variable
set_variableSets a variable to a specific value.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
variableId | string | "my_var" | Variable |
value | int | 0 | Value |
Show Variable HUD
show_variable_hudDisplays the current value of a variable on a HUD message device.
hud_message_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
variableId | string | "my_var" | Variable |
format | string | "{value}" | Texte affiché (utilise {value} pour la valeur) |
other11
Compute Variable
compute_variableWrites a variable from a formula: target = A <op> B (or += ). Each side is a variable or a number. Operators: add, subtract, multiply.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
variableId | string | "my_var" | Target Variable |
mode | select | "set" | Mode |
variableIdA | string | "my_var" | Left variable |
valueA | int | 0 | Left number (if no variable) |
operator | select | "*" | Operator |
variableIdB | string | "" | Right variable |
valueB | int | 2 | Right number (if no variable) |
Disable Device at Index
disable_device_at_indexDisables the Nth element in an array device (e.g. Chairs[round_number]). The index is read from a global variable and incremented afterwards.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
deviceType | string | "chair_device" | Device Type |
deviceVarNameadv | string | "IndexedDevices" | Name of the []device editable to index into. Use a dedicated name (default) or an existing array editable (e.g. "Chair" with an array chair event). |
indexVariable | string | "round_number" | Index Variable |
autoIncrement | boolean | true | Auto-Increment Index |
Eject from Chair
chair_ejectEjects the occupant from the Chair. Targets a specific player or ejects whoever is sitting.
chair_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
target | select | "all" | Target |
Eliminate Player
eliminate_playerEliminates the targeted agent by dealing lethal damage (9999 HP) via fort_character.Damage(). Works per-player — no device needed.
End Game If Last Standing
end_game_if_last_standingChecks if 1 or fewer players remain. If so, declares the last player as winner and ends the game. Does nothing otherwise.
end_game_deviceUEFN39.50+For Each Player If
for_each_player_ifModifier: executes subsequent actions for every player matching a variable condition. Example: eliminate all players where is_safe == 0.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
variableId | string | "my_var" | Variable |
operator | select | "==" | Operator |
value | int | 0 | Value |
Prop Manipulator
call_prop_manipulatorControls a prop manipulator device: show/hide affected props, or enable/disable the device.
prop_manipulator_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
selectedAction | select | "ShowProps" | Action |
Seat Player on Chair
chair_seatForces a player to sit on the Chair device. Useful for musical chairs, cinematics, or waiting rooms.
chair_deviceUEFN39.50+Set Chair State
set_chair_stateEnables, disables, or controls exit behavior of the Chair device. Disable ejects any seated player.
chair_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
action | select | "enable" | Action |
Set VFX State
set_vfx_stateEnables, disables, or restarts the VFX Spawner device. Use Restart to re-trigger burst effects.
vfx_spawner_deviceUEFN39.50+Parameters
| Name | Type | Default | Description |
|---|---|---|---|
action | select | "enable" | Action |
Transfer Variable
transfer_variableTransfers the full value of a source variable into a destination variable, then resets the source to 0.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
sourceVariableId | string | "bank" | Source Variable |
destVariableId | string | "wallet" | Destination Variable |
See also