Mission Elements (WIP)

Here this page will talk about the Mission Elements in Payday2. There are hundreds of elements to use for your levels so you can get very creative with some of these.

Here I will explain all the elements as they are listed in-game (Alphabetical Order).

AiArea

On Execution AiArea will connect selected Navigation Segments together to act as a single 'Room'.

Keep in mind Navigation Segments will still work like they normally do so this can be used to cut a room in half to forbid navigation with an AiGraph element in only a specific area.

AiAttention

On Execution AiAttention will apply the selected attention settings to the instigator unit(s).

• Manage Instigator IDs List, Select unit IDs to apply attention operations to.
• Use Instigator, Toggle if this element should apply to the instigating unit.
• Preset, Select an attention preset for the unit to use.
• Operation, Select how the attention preset should operate.
  • Set: Sets the current instigators attention to the preset attention.
  • Add: Add attention rules to the instigator unit.
  • Override: Replace current rules with selected preset.
• Override, only used with Override Operation to override the current attention rules to the preset rules.

AiForceAttention

ToDo

AiForceAttentionOperator

ToDo

AiGraph

On Executed AiGraph will operate on Navigation Graph.

• Graph Units, Select what Navigation Graphs to operate on.
• Operation, select an operation.
  • allow_access: Enables navigation associated with selected Graphs
  • forbid_access: Disables navigation associated with selected Graphs
  • forbid_custom: Disables navigation only for the type of AI selected in the Filter Group.
• Filter Group, Select the type of AI to use in the forbid_custom operation.

AiRemove

On Executed AiRemove will remove (or kill if selected) instigating Ai.

• Manage Elements, select Ai spawning elements to remove all that have been spawned by them.
• Use Instigator, will remove the instigating Ai.
• True Death, will make Ai look like they have died instead of being deleted entirely.
• Force Ragdoll, requires True Death enabled, Does nothing.

AccessCamera

Does nothing on execution, Access will be available based on the Enabled state.

• Camera Unit, Select what camera to use. If the camera is broken access will not be available.
• Text ID, A written string ID. Leaving it as debug_none will show a generic camera number.
• Yaw Limit, Horizontal freedom.
• Pitch Limit, Vertical freedom.

AccessCameraOperator

On Execution AccessCameraOperator will operate on selected AccessCamera elements.

• Manage Elements, select AccessCamera elements to operate.
• Operation, select an operation.
  • none: Does nothing.
  • destroy: Makes the AccessCamera "Lose Feed" as if the camera had been destroyed.

AccessCameraTrigger

Will trigger from AccessCamera elements when a certain condition is met.

• Manage Elements, select AccessCamera elements to be triggered from.
• Trigger Type, select a trigger.
  • accessed: When a camera is accessed by a player.
  • destroyed: When a camera is destroyed
  • alarm: When a camera has been alarmed

ActionMessage

Unused element.

ActivateScript

Unknown.

AiGlobalEvent

On Execution AiGlobalEvent will apply the selected rules to the match.

• Wave Mode, select the games current assault state. (besiege is often used on alarm.)
• Ai Event, select the games Ai Event. (police_called is often used on alarm.)
• Blame, select the pop-up message on why the global event changed.

AlertTrigger

Will trigger from specified sound rules, Used on one occasion for gunshots calling the police on Big Oil Day1- But it not longer used. Use an Operator element to add and remove the trigger.

ApplyJobValue

On Execution a Key (and a Value) will applied to selected JobValue Elements.

AreaMinPoliceForce

When Operated on by an Operator element a selected amount of enemy groups will focus on being in the nearby Graph. Element Operator Required to use this element.

Operation:

• add: Will enable the minimal force.
• remove: Will disable the minimal force.

AreaOperator

On Executed AreaOperator will operate on selected AreaTriggers.

• Manage Elements, select AreaTrigger to operate.
• Interval, change the rate that the AreaTrigger triggers.
• Use Disabled Shapes, Toggle if the AreaTrigger uses disabled Shape elements.
• Apply On Interval, Toggle if the AreaTrigger applies the change in interval.
• Apply On Use Disabled Shapes, Toggle if the AreaTrigger applies the change to use disabled shapes.

AreaReportTrigger

An advanced version of the AreaTrigger, includes more trigger options. Use AreaTrigger for less complex requirements.

• Manage Unit IDs, Unknown
• Manage Spawn Unit Elements, Select SpawnUnit elements. (Unknown use)
• Manage Use Shape Elements, Select Shape elements to trigger from instead of the AreaReportTrigger shape.
• Manage Rules Element IDs, Select an InstigatorRules element to filter what triggers.
• Interval, Select the time in seconds for it to check what's inside the AreaReportTriggers shape.
• Instigator, Broad filter of rules for the trigger. (Must still align with the InstigatorRules if used)
• Amount, Select an amount. 1-4 is for a loose counting and All is often used for escape areas to check if all players are inside.
• Use Disabled Shapes, Toggle if you want to still trigger from Shape elements that are disabled.
• Shape Type, Select a shape.
• Width/Depth/Height/Radius, Self explanatory.

AreaTrigger

A simple trigger element for units entering/exiting/ect.

• Manage Unit IDs, Unknown
• Manage Spawn Unit Elements, Select SpawnUnit elements. (Unknown use)
• Manage Use Shape Elements, Select Shape elements to trigger from instead of the AreaReportTrigger shape.
• Manage Rules Element IDs, Select an InstigatorRules element to filter what triggers.
• Interval, Select the time in seconds for it to check what's inside the AreaReportTriggers shape.
• Trigger On, Select enter/exit/ect rules.
  • on_enter: On entering the area.
  • on_exit: On exiting the area.
  • both: On entering and exiting the area.
  • on_empty: When empty.
  • while_inside: Trigger on interval while inside the area.
• Instigator, Broad filter of rules for the trigger. (Must still align with the InstigatorRules if used)
• Amount, Select an amount. 1-4 is for a loose counting and All is often used for escape areas to check if all players are inside.
• Use Disabled Shapes, Toggle if you want to still trigger from Shape elements that are disabled.
• Shape Type, Select a shape.
• Width/Depth/Height/Radius, Self explanatory.

AssetTrigger

Executes when selected asset ID is unlocked.

• ID, Select asset ID to trigger from.

AwardAchievment

On Executed awards selected steam achievement.

• Achievment, Achievement ID to be unlocked.
• Award Instigator, Toggle is only the instigator of this element is given the achievement.
• Players From Start, Toggle if the players needed to be in the lobby when it started to be awarded achievement.

B...

BLCustomAchievement

Used for custom Beardlib achievements.

• Package ID, set the package ID of the related achievement.
• Achievement ID, set the achievement ID to unlock on executed.
• Amount Increase, if the achievement has an amount to reach for unlock, increase the amount value by this..
• Award Instigator, Toggle to only apply to the player that instigates the element.
• Players From Start, Toggle to only apply to players who have been in the game from the start.

BainState

Used to toggle bain dialogue.

• State, Toggle if Bain should speak.

BlackscreenVariant

Used to change the 'outro_event' variant in the level tweak data.

• Variant 1-30

BlurZone

Used to apply a visual blur effect in a shape.

• Mode:
  • 0: Off
  • 1: Enabled
  • 2: Enabled, Flashes players inside when executed
• Radius/Height, Shape the blur zone area.
• Operator Element Operations:
  • Remove, use a remove operation to deactivate the BlurZone after it's been executed. Can be executed again afterwards.

C...

Carry

Used to typically operate on Lootbag units. Applies to all unit instigators.

• Operation, most operations are self explanatory.
  • add_to_respawn is used to remove bags until they are respawned by a LootBag element.
  • filter_only is used to do nothing to the lootbag but still execute the element.
  • poof is used on lootbags with 'can_poof = true' to make them visually poof out of existance. Used on Cloaker lootbags to make them vanish.

ChangeVanSkin

Used to change the heister van skin.

• Manage Unit IDs, Select player van units to update paint job.
• Target Skin, Select a van skin to apply.

CharacterDamage

Crashes when used. (Noted: 11d/09m/2020y)

CharacterOutline

Seems to do nothing, Use SetOutline element instead.

CharacterSequence

Run a sequence from the selected character.

• Manage Elements List, Select Character spawning elements to apply to.
• Use Instigator, Apply sequence to instigating character.
• Sequence, Type in the name of the sequence you want to apply.

CharacterTeam

Change the team of the selected character.

• Manage Elements List, Select Character spawning elements to apply to.
• Use Instigator, Apply sequence to instigating character.
• Ignore Disabled, Dont apply effects to disabled elements.
• Team, Select the team you want the character to change to.

CheckDLC

Filter based on DLC ownership.

• Require All, Toggle if you require all selected DLC instead of just the ones listed.
• Invert, Toggle if the selected DLC IDs should apply backwards.
• DLC IDs, Select DLC IDs to filter.

Counter

Holds a number value and takes 1 every execution. Executes when it reaches 0.

• Timer Units, Select visual timer units to show the current number in the world.
• Counter Target, The default value of the Counter element.
  • Counter can be operated on with a CounterOperator element.

CounterFilter

Filters execution based on counter values.

• Manage Elements List, Select Counter elements to filter.
• Needed To Execute, Select if either Any or All need to be a checked value.
• Value, a number to compare to.
• Check Type, Self explanatory math options.
  • 'counters_...' account for multiple selected Counter elements.

CounterOperator

Modify a Counter element value.

• Operation, self explanatory options for adding, subtracting and more.
  • reset doesnt need a value, uses default Counter value.
• Amount, a value to operate with.

CounterReset

Unused. Use CounterOperator element.

CounterTrigger

Execute when a counter reaches the trigger number.

• Trigger Type, select a trigger type for the selected Counters.
• Amount, a value to trigger.

CustomSafehouseAwardTrophy

Award a trophy for the Safehouse.

• Trophy, select a trophy ID to award.
• Objective ID, select a specific objective from the Trophy.
• Award Instigator, Toggle to only apply to the player that instigates the element.
• Players From Start, Toggle to only apply to players who have been in the game from the start.

CustomSafehouseFilter

Filter execution based on safehouse room tiers.

• Room ID, Select whos room ID to filter.
• Room Tier, Select what tier the room needs to be.
• Tier Check, Unknown
• Check Type, Self explanatory math types.

CustomSafehouseTrophyFilter

Filter executed based on trophy unlocks.

• Trophy, Select a trophy ID to filter.
• Check Type, Select if the trophy is locked/unlocked.

CustomSound

ToDo

D...

DangerZone

When executed by an area trigger (using 'both') instigating players will be targeted fasted by enemies. Delay multiplier set in tweak_data is in this order: 0.6, 0.5, 0.35, 0.1 from a default of 1.

• Level, 1-4.

Debug

On execution Debug elements will show a debug string and some information if you choose. Will only show in editor playtesting.

• Debug String, write in a string to show a message.
• As Subtitle, Toggle to show it as yellow subtitle text.
• Show Instigator, Toggle to show instigators.

Dialogue

Play dialogue on execution. Remember to load the required packages or dialogue will not play.

• Dialogue, sound ID dropdown.
• Force Quit Current, Toggle if it should quit any currently playing dialogue.
• Execute On Executed When Done, Toggle if the element should execute once the dialogue is completed.
• Use Position, Play in 3D space instead of in the players ears.

Difficulty

Set the current assault difficulty.

• Difficulty, 0-1. Commonly used values are 0.5, 0.75 and 1.
  • 0, will not spawn enemies
  • 0.5, common starting point on police called
  • 0.75, usually set after the first assault wave ends
  • 1, full assault

DifficultyLevelCheck

Simpler version of the Filter element. Will only check for 1 difficulty.

• Difficulty, select what difficulty is required to execute.
  • normal: Normal
  • hard: Hard
  • overkill: Very Hard
  • overkill_145: Overkill
  • easy_wish: Mayhem
  • overkill_290: Deathwish
  • sm_wish: Death Sentence

DisableShout

Disable or ReEnable shouting for Ai.

• Manage Elements List, Select what Ai spawning elements should (or should not) be shouted at by players.
• Disable Shout, Toggle if you can or cannot shout at selected Ai.

DisableUnit

Disable selected units. Bare in mind interactable units may need to be disabled with a sequence manager beforehand or else floating interactions may get in the way.

• Manage Unit IDs, Select what units to be disabled/hidden.

DropInState

Toggle if players can or cannot drop into the game. Often used for secrets or sections that will cause problems if a player spawns.

• State, Toggle on or off if a player can join.

E...

EnableSoundEnvironment

ToDo

EnableUnit

Enable selected units that have previously been disabled.

• Manage Unit IDs, Select what units to be enabled/shown.

EndScreenVariant

ToDo (Not working in editor)

EnemyDummyTrigger

Trigger on certain rules for Ai.

• Manage Elements List, Select what Ai are to trigger this element.
• Event, What event to use.
  • anim_act_## are used for certain timings in SO animations.

EnemyPreferedAdd

Add enemy groups to spawn during assaults.

• Manage Spawn Groups List, Select what EnemyGroups to add
• Manage Spawn Points List, Select what EnemyDummys to use

EnemyPreferedRemove

Undo added Prefereds.

• Manage Elements List, Select EnemyPreferedAdd to remove spawns from.

Environment

Change colorgrading and other camera filters. Not recomended to use in proper maps.

EnvironmentOperator

Change active environments with an optional blend time.

• Operation, choose what operation to use for environment changes.
• Environment, select an environment to change to.
• Blend Time, set a transition length in seconds.

Equipment

Give instigators equipment.

• Equipment, Select the equipment ID to give.
• Amount, Select how many of that equipment to give.

A list with all ids + icons and localized strings can be found here.

ExecuteCode

Can link to a lua file and run the code inside.

• File: Path to the .lua file.
• Use Path
  • mod
  • level
  • full

ExecuteInOtherMission

Can execute elements regardless of what script they are in. Opening the "On Executed" list shows all elements in the level, not just the ones in the same script.

Experience

Give a base amount of experience to the players for the current level. Applied at the end of the level.

• Amount, Number value for how much experience to give.

Explosion

Explode with effects and sounds.

• Manage Orientation Elements List, Select where the explosions should play instead of on the element.
  • Will only use 1 element randomly.
• Damage, Number value for how much damage to do to beings/props.
• Player Damage, Number value for how much damage to do to players.
• Explosion Effect, Select an effect to explode with.
• Sound Event, Select a sound to play when exploding.
• No Raycast Check Characters, Dont use a ray to make sure there arent obstacles in the way of the explosion.
• Range, Distance in cm. Includes falloff (Green Sphere is maximum effect)

The Following Options afterwards are duplicates of the Feedback Element.

ExplosionDamage

When executed, will act similar to the regular Explosion element, except there's no effects or sounds, just the damage. Seems to work only on players.

• Range, Distance in cm.
• Damage, Amount of damage to give to players

F...

FadeToBlack

Fade in or out, takes 3 seconds. Hardcore. Applies to ALL players.

• State...
  • True: Fade FROM Black
  • False: Fade TO Black

FakeAssaultState

Set the fake assault state in GroupAi to fake an assault. (Music/Ui)

• State...
  • True: Fake assault enabled
  • False: Fake assault disabled

Feedback

Camera effects on players near the executed element.

• Manage Orientation Elements List, Select a different orientation to play at away from the Feedback element.
• Range, Distance in cm.
• Use Camera Shake, Toggle to use following Camera Shake options.
  • Amplitude:
  • Frequency:
  • Attack:
  • Sustain:
  • Decay:
• Use Rumble, Toggle to use following Rumble options.
  • Peak:
  • Attack:
  • Sustain:
  • Release:
• Above Camera Effect, Select an effect to play when a player is inside the effect distance (Green Sphere)
  • Distance, 0-1 how far inside the range of the feedback element to have this effect play.

Filter

Filter execution based on many rules.

• Difficulty IDs, True will allow execution when playing that difficulty
• Player 1-4, Filter execution when that player is the instigator.
• Mode Control/Assault, Filter execution when the assault is in control or assault state.

Flashlight

Unused- Flashlight effect faces the wrong direction.

Using this mod, this element can actually be used to enable and disable flashlights on enemies.

• Flashlight state: Set if flashlights should be on or off when executed.
• Toggle if the player's flashlight should also turn on/off, not practical since the effect faces the wrong direction.

FleePoint

Used to designate points where Ai will despawn or drop lootbags.

• Functionality, Select what point it will be on execution.

G...

GameDirection

Unused.

GlobalEventTrigger

Executes on global events

• Global Event, select on what global event to trigger on.

H...

Heat

Unused.

HeistTimer

Make a countdown timer show on the players HUD. Identical to the regular Timer element, set a time and use a TimerOperator to start/stop/modify the time.

• Timer Units, Select timer GUI units to show the time.
• Timer, Set a value for how long the timer should go in seconds before executing.

Hint

Force a Hint pop-up on instigators.

• Hint ID, Select what hint to pop-up on executed.

I...

InstanceInput

Used inside instances to receive inputs.

• Event, custom event ID name. Dont use the same names inside the instance.

InstanceInputEvent

Used outside of instances to send inputs.

• Manage Event List, Select instances to take inputs.

InstanceOutput

Used inside instances to send outputs.

• Event, custom event ID name. Dont use the same names inside the instance.

InstanceOutputEvent

Used outside of instances to receive outputs.

• Manage Event List, Select instances to execute on outputs.

InstanceParams

Instance parameter element for controlling certain values inside instances.

• FULL GUIDE NEEDED!

InstancePoint

Spawn a mission spawned instance here. Warning: Only spawn once!

• Instance, Select an instance that has been set to mission spawned.

InstanceSetParams

Set the parameters of an instance that uses InstanceParams Often used for 'obj_link' instances.

• Instance, Select an instance that uses Params.
• Apply On Execute, Toggle if it should apply these parameters on execution.
• Instance Params List will show params of the instance.

Instigator

Holds instigator information. Read InstigatorOperator and InstigatorTrigger elements for more details.

InstigatorOperator

Operate on an Instigator element. Operations that start with "use" will have the operator use those instigators for proceeding elements. Operations that start with "add" will add instigators who execute the operator

• Manage Elements List, Select what Instigator elements are operated on.
• Operation,
  • none, does nothing.
  • set, sets the instigator list to the instigators of this operator.
  • clear, clear the instigators from the Instigator element.
  • add_first, Add the first instigator of the element if there are more than one instigator.
  • add_last, Add the last instigator of the element if there are more than one instigator.
  • use_first, When executed the first instigator of the list will act as the instigator of the proceeding elements.
  • use_last, When executed the last instigator of the list will act as the instigator of the proceeding elements.
  • use_random, When executed a random instigator of the list will act as the instigator of the proceeding elements.
  • use_all, When executed all instigators of the list will act as the instigators of the proceeding elements.

InstigatorTrigger

This element executes when certain conditions are met.

• Manage Elements List, Select what Instigator elements are triggering.
• Trigger Type,
  • set, Executes when a new instigator is set.
  • death, Executes when an instigator dies.
  • changed, Executes when the instigator element changes.
  • cleared, Executes when the instigator element is cleared.

InstigatorRule

Set rules for applicable elements to filter.

• Instigator, Select the instigator type.
  • Different rules will show for different types.
• Invert, Toggle to invert selected rules.

Interaction

Floating element interaction with filtered execution. Requires an interaction unit to be loaded, If its not loaded the editor will ask you to load it.

Manage On Executed List:

• Alternative should be set to 'interacted' to only trigger once interaction is completed.

  • interupt will trigger on letting go.
  • start will trigger when you start interaction.

• Tweak Data ID, Interaction ID.

• Override Timer, Override the timer of the selected interaction

  • -1 will not override.
  • 0 will set to instant interaction

If the interaction doesn't show up for clients, try adding this to your add.xml or custom package:

<unit load="true" from_db="true" path="units/dev_tools/mission_elements/point_interaction/interaction_dummy"/>

InventoryDummy

Spawn prop versions of your inventory weapons. Used in the safehouse.

• Category, Select what inventory category to use.
• Slot, Select what inventory number to use. (1-9)

Invulnerable

Makes a unit invulnerable or immortal.

• Manage Elements List, Select Ai to modify.
• Invulnerable, Toggle if selected Ai should be invulnerable to damage. (Can be killed in some ways)
• Immortal, Toggle if selected Ai should be completely immortal.

J...

JobStageAlternative

Used to apply bonus or escape heists to the level chain.

• Alternative, ToDo
• Interupt, Select Job ID to interrupt the level chain.
  • Any heist can be used but the list is preset and most jobs there do not work as they do not exist.

JobValue

Apply a temporary key and a value to the current match. Can be saved to the save file to be used on reload of the game.

• Key, a key id to use.
• Value, a value to use with the key.
• Save, Toggle to save to the save file.

JobValueFilter

Filter based on JobValues.

• Key, a key id to filter execution.
• Value, a value to filter execution.
• Save, Toggle if its a saved key.
• Check Type, Basic math filters for the value.
  • Does not have to be a number, if the Value is the same word equal will work for example.

K...

KillZone

Hurt instigator with a selected damage type.

• Type, Select a damage type.
  • sniper - player only, damages the instigator over time while spawning bullet impacts all around
  • gas - player only, damages the instigator over time.
  • fire - player only, pretty much identical to gas but with slightly less damage.
  • kill - any instigator, simply kills any enemy or civilian units, puts player and team ai into bleedout.
  • laser - player only, seems to be similar to kill but only affects players.
  • electricity - any instigator, electrifies the instigator for a few seconds with a chance of killing enemies and civilians.

L...

LaserTrigger

Spawn and control tripwire laser beams in this element. Toggling LaserTrigger off with a Toggle element will disable the lasers.

• Edit Points, Toggle on to edit laser points.
  • Left-Mouse Button to add new points at your cursor location.
  • Right-Mouse Button to connect points
  • Middle-Mouse Button to move the nearest point to your cursor location.
    • Middle-Mouse Button again to place the chosen point.
    • Left-Mouse Button to end moving points.
• Connections, a numbered list of connections.
  • Deselect, deselects selected connection.
  • Connection #0, select connection to open Selected Connection panel.
• Selected Connections, modify the location/rotation of a selected connection.
  • From Position, Vector3 values of the starting laser point location.
  • From Rotation, Vector3 values of the starting laser point rotation.
  • To Position, Vector3 values of the ending laser point location.
  • To Rotation, Vector3 values of the ending laser point rotation.
• Interval, The delay between each check of the laser.
• Instigator, Select what instigator should trigger the laser.
• Color, Laser beam color (Red/Green/Blue)
• Cycle Type, pop/flow seem to do the same thing.
• Visual Only, Toggle if these lasers should not function.
• Skip Dummies, Toggle if the lazer dome units should show or not.
• Flicker Remove, When disabled the lasers will flicker on and off for a moment.
• Cycle Interval, Time delay in seconds when a new set of lasers should show if cycling is possible.
• Cycle Active Amount, Amount of active lasers in the cycle.
• Cycle Random, Toggle if random lasers should be cycled or if they should follow their connection order.

LoadDelayed

Select units with the Delay Loading unit option to spawn them after a level starts up. On Executed all units in the list will be spawned into the level.

• Manage Unit IDs, Select units that have the Delay Loading setting.

LogicChance

Set a percent chance for the element to execute elements in its On Executed List.

• Chance, 0-100% chance.

LogicChanceOperator

Operate on an existing LogicChance element.

• Manage Elements List, Select LogicChance elements to operate on.
• Operation, Simple options for what should happen to the LogicChance element.
  • none, nothing happens
  • add_chance, add the value in the LogicChanceOperators Chance value to the selected LogicChance elements.
  • subtract_chance, remove the value in the LogicChanceOperators Chance value to the selected LogicChance elements.
  • set_chance, set the value of a LogicChance element to the current value in the LogicChanceOperator.
  • reset, reset the LogicChance element to its default value listed in the element.
• Chance, 0-100% chance.

LogicChanceTrigger

An alternative way to execute something from a LogicChance element.

• Manage Elements List, Select LogicChance elements to trigger from.
• Outcome, On what outcome should this trigger excute.
  • fail
  • success

LookAtTrigger

A trigger for if a player is looking at the element.

• Interval, the delay in seconds where it checks if a player is looking at the element.
• Sensitivity, 0.5 being needs to be roughly on the screen to trigger and 0.999 is almost directly looking at the element.
• Distance, distance in cm for the element to trigger when looked at.
• In Front, players must be infront of the element for it to trigger.

LootBag

Spawns a lootbag unit.

• Manage Orientation Elements List, Select a location(s) where the lootbag will spawn from, using multiple orientations will randomise.
• Push Multiplier, push the bags instead of dropping them.
• Carry ID, Select what loot item should spawn with this element.
• From Respawn, Toggle if this element should only spawn bags that have been set to respawn using a Carry element.
• Arrow Keys to change the direction of the bag throwing.

LootBagTrigger

Trigger depending on what happens to a spawned lootbag.

• Manage Elements List, Select what elements the bags must come from to execute.
• Trigger Type,
  • load, when a player collects the bag
  • spawn, when the bag is spawned

LootPile

Activate a point where enemies will attempt to take bags from, Must be near Navigation. When a bag is taken the global event "loot_lost" will be called.

• Manage Orientation Elements List, Select orientation elements to choose lootpiles from.
• Max Loot, Set a maximum amount of bags that can spawn from the Loot Pile.
• Carry ID, Pick a lootbag item to be taken from the pile
• Retry Delay, Delay where enemies will attempt to take a bag again.
• Reissue Delay, Delay where enemies will desire to take bags from the pile.

LootSecuredTrigger

Trigger once a specified cash amount of loot is secured.

• Amount, Cash value that needs to be secured.
• Include Instant Cash, Select if loose money items should also be counted.
• Report Only, Unknown.

M...

MandatoryBags

Set the objective amount of mandatory loot bags when executed.

• Carry ID, Select the loot id required.
• Amount, Amount of lootbags required.

MissionEnd

Select how a mission should end when executed.

• State,
  • none, Nothing happens
  • success, Mission wins.
  • failed, Mission fails.
  • leave_safehouse, Leaves the level and enters crime net.

MissionFilter

Filter based on the stages mission filter (1-5).

• Mission Filter Toggles 1-5, when enabled that filter will continue execution.

MissionScript

Barebones element. Used for keeping things organised and synced.

Missions

Unknown

ModifyPlayer

Modifies the instigator player.

• Damage Fall Disabled, Disable fall damage.
• Invulnerable, Disable damage.

Money

Add/Remove money from Spending or Offshore. Can be set to instigator only for not-gambling mechanics.

• Action, choose what happens to what.
  • none, Nothing
  • AddOffshore, Adds Amount to offshore cash
  • DeductOffshore, Removes Amount from offshore cash
  • AddSpending, Adds Amount to Spending cash
  • DeductSpending, Removes Amount from Spending cash
• Amount, amount in cash.
• Only Local Player, Toggle if only the instigating player is affected.
• Remove All, REMOVES ALL SPENDING OR OFFSHORE MONEY. (Be careful with this)

MoveUnit

Move selected units using this element. Note, Some units may not move properly if they have certain Sync options enabled in the unit.

Music

Control the music in a level using this element.

• Music Event, Select the event name for the set song.
• Use Instigator, Only apply the song changes to the instigating player.

N...

NavObstacle

Used to block navigation in a level. Make sure you set this stuff up properly or else navigation issues and crashes can occur. Rebuild navigation frequently when using these.

• Operation,
  • add, Add obstacles to the navigation
  • remove, Remove obstacles from the navigation
• Manage Obstacle List, Select units that will block navigation.
  • Due to the way beardlib works we dont have a way to see the real names of the objects so make sure to look at existing examples ingame for the correct Idstrings!!

O...

Objective

Start/Complete/Fail objectives with this element. Objectives can have experience weights tied to them to make failing an objective cost XP.

• State, Depending on the amount some options may act differently.
  • complete_and_activate, This will complete whatever objective(s) are active and start a new one.
  • activate, This will add a new objective.
  • complete, This will complete and objective, if the objective uses amounts it will tick once.
  • update, This will update the objective and re-show the objective animation.
  • remove, This will remove the current objective. (used for failing)
  • remove_and_activate, This will remove the current objective and replace it with a new one.
• Objective, Select an objective ID to show on the HUD.
• Amount, Override the amount part of the objective, used for difficulty changes.
• Countdown, Instead of starting from 0 the objective will start from the amount and go down.

Operator

A generic operating unit, typically used for Waypoints and SpecialObjectives to remove them. In the Lua this will execute 'operation_remove' and 'operation_add' functions inside the selected elements.

• Manage Elements List, Select what elements to be operated on.

• Operation,

  • none, Does nothing.
  • add, Add function for the selected elements.
  • remove, Remove function for the selected elements.

  Some Avaliable Operations:

  • remove operation can be applied to:
    • PlaySound
    • AlertTrigger
    • AreaMinPoliceForce
    • BlurZone
    • FleePoint
    • LaserTrigger
    • PONR
    • ScenarioEvent
    • SpecialObjective
    • SpecialObjectiveGroup
    • Waypoint
  • add operation can be applied to:
    • TimerTrigger
    • AlertTrigger
    • AreaMinPoliceForce
    • FleePoint
    • LaserTrigger
    • PONR
    • ScenarioEvent

OverlayEffect

Complex version of FadeToBlack, Applies to all players.

• Effect, Select a fade effect.
  • Most effects can be modified in the following options below.
• Fade In, Time in seconds for effect to fade in.
• Fade Out, Time in seconds for effect to fade out.
• Sustain, Time in seconds for effect to stay completely solid on screen.

OverrideInstigator

Unknown

P...

PhysicsPush

Unknown

Pickup

Used to give and take items from npc instigators.

• Pickup, Set the item NPCs will drop when tied/killed.
  • remove, will remove items from that npc and set it to none.
  • ammo, will drop an ammo pickup.
  • Everything else is self explanatory.

pickupCriminalDeployables

Unknown

PlayEffect

Play an effect.

• Manage Orientation Elements List, Select random locations for the effect to play from.
• Screen Space, Plays effect in space space (Unsure what this means or does)
• Effect, Select the effect you want to play.
• Base Time, Seems to do nothing.
• Random Time, Seems to do nothing.
• Max Amount, Seems to do nothing.

PlaySound

Play a sound. Emmiter sounds can also be spawned from these if you need abient sounds to play from randomised positions.

• Manage Elements List, Select special units to play the sound from, usually npc characters.
• Sound Event, Select a sound event ID.
• Append Prefix, Unknown.
• Use Instigator, Play from the instigator unit.

PlayerCharacterTrigger

This element will trigger on a heister joining or leaving the level.

• Character, Select character ID.
• Trigger on Left, Toggle to trigger execution when this heister leaves.

PlayerNumberCheck

This element will only execute if the set number of players is in the match.

• Num 1-4, Only those amounts enabled will continue execution from this element.

PlayerSpawner

This element will become a spawnpoint for players and TeamAi who begin the level.

• State, select the player state to spawn in.
  • mask_off, no mask but can mask up.
  • standard, masked up.
  • clean, no mask but cannot mask up.
  • civilian, no mask and cannoy mask up you also cannot be spotted and can only interact with civilian interactions.
  • everything else is not often needed or should be spawned as.

PlayerState

Sets players to the selected player state.

• State, select the player state to change to.
  • Same player states as PlayerSpawner.
• Use Instigator, Toggle if only the instigating player should change state.

PlayerStateTrigger

Triggers execution when a player enters selected state.

• State, select the player state to listen for.
  • Same player states as PlayerSpawner.

PlayerStyle

Set the instigators suit style if one isnt already applied.

PointOfNoReturn

Start a PONR countdown based on difficulty.

• ManageElementsList: Leftover from PDTH, will crash when used.
• Tweak ID: Choose a PONR ID from the list, defines text and color of the UI elements.
  You can create a custom PONR ID by hooking into tweakdatapd2.lua. For a guide, click here.
• Normal - Death Sentence: Set how long the PONR is in seconds on each difficulty.

PrePlanning

Preplanning asset location, Preplanning maps use the world space to determine the location of assets on the maps.

• Upgrade Lock, Override the update requirements for additional_assets skills.
• DLC Lock, Set a DLC requirement for Preplanning options (unused)
• Location Group, Set a letter for what section of the PrePlanning map that asset is located on.
• Select Allowed Types, Select what 'Type' of planning options can be there.
• Select Disables Types, Unknown.

PrePlanningExecuteGroup

On Executed will activate all assets that need to be spawned by preplanning in a different group.

• Location Groups To Activate, Select letter groups that will be activated.

Pressure

Not used for Payday2.

ProfileFilter

Filter execution based on player stats like money, xp and achievements.

• Player Level, Player level 0-100
• Money Earned, Spending Cash
• Money Offshore, Offshore Cash
• Achievement, Has achievement unlocked?

PushInstigator

Push instigator a direction depending on settings. Avoid using it on non-player units, often causes crashes.

• Mass, Push strength.
• Multiply, Push Multiplier.
• No Z, Enable to disable vertical (Z Axis) push.
• Forward, Enable to push in the direction the instigator is looking.
• Velocity, Push Velocity in vector3 directions.

R...

Random

Randomly executes elements based on settings.

• Counter Element, Select to use a Counter element as the Amount.
• Amount, Set an amount of random elements to choose (Will not choose the same elements twice)
• Amount Random, Random amount from 0 to a chosen number to be added onto the Amount.
• Ignore Disabled, Enable to not attempt to execute elements that are disabled.

RotateUnit

Rotates a unit based on settings.

S...

ScenarioEvent

This element goes unused in Payday2, but seems to still work in some way.

• Amount, Should be set to the amount of enemies that will be created from this event.
• Used to specify chance to happen (1 = 100%)
• Chance Inc, Used to specify an incremental chance to happen.
• Task, Select a task.

SecurityCamera

Control security cameras with this element.

• Camera Unit, Select a single camera unit to control.
• Ai Enabled, Enable to make the Camera spot things. (After alarm all cameras should be set to Ai Disabled)
• Apply Settings, Enabling this will apply all the following settings.
• Yaw/Pitch, The right/left/up/down turning of the camera.
• FOV, Field Of View for the camera.
• Detection Range, The minimum range before the min/max delay starts
• Suspicion Range, The minimum range before detection is starts
• Detection Delay Min/Max, the minimum and maximum time before a camera begins seeing something in the detection range.

SequenceCharacter

This element is used to force a sequence from a units sequence_manager.

• Sequence, the sequence name you want to execute.
• Manage Sequence List, Select a unit spawning element.

SetOutline

Force a yellow contour around instigators.

• Manage Elements List, Select npc spawning elements to make this apply to.
• Set Outline, Enable to have contours on.

Shape

A basic shape for AreaTriggers to use.

• Shape Type, Select a shape.
• Width/Depth/Height/Radius, Self explanatory.

SideJobAward

Awards sidejobs to players.

• Challenge, side job ID.
• Objective ID, Seems to only have the option for 'all'.
• Award Instigator, Enable to only award the instigator.
• Players From Start, Only award to players who were around from the start of the level.

SideJobFilter

Checks if you have certain side jobs done.

• Challenge, side job ID.
• Objective ID, Seems to only have the option for 'all'.
• Check Type, Check if its awarded or not.

SlowMotion

Unknown (Incomplete)

SmokeGrenade

Spawn a Smoke or Flash at the elements location.

• Duration, How long the smoke should show for.
• Immediate, will instantly spawn Smoke or Flashbangs
• Ignore Control, Will still spawn grenades if the global event is 'control'
• Effect Type, Select what grenade to spawn.

SpawnCivilian

Spawns civilian Ai.

• Manage Orientation Elements List, Select elements for the Civilian to be spawned instead of the SpawnCivilian elements location. Mutliple selections will be randomly chosen each execution.
• Enemy, Select a Civilian unit to spawn from this element.
• State, Select an animation state to spawn in. Animation prefix is important.
  • cm: Civilian Male
  • cmf: Civilian Male/Female
  • cf: Civilian Female
• Force Pickup, Select an item for the unit to drop when tied or killed.
• Team, Select a team for this civilian to be on.

SpawnCivilianGroup

Spawn groups of civilians all at once from a single element with different settings.

• Manage Elements List, Select what civilian elements to use to spawn civilians.
• Random, Select if random SpawnCivilian should be chosen.
• Ignore Disabled, Toggle to have the element try to use SpawnCivilian elements that have been toggled off.
• Amount, How many civilians to spawn from this group.
• Team, Select a team for this civilian to be on.

SpawnDeployable

Spawn besic deployable units.

• Deployable ID, select a deployable to spawn.

SpawnEnemyDummy

Spawns enemy Ai.

• Manage Orientation Elements List, Select elements for the Enemy to be spawned instead of the SpawnEnemyDummy elements location. Mutliple selections will be randomly chosen each execution.
• Enemy, Select a Enemy unit to spawn from this element.
• Spawn Action, Select an animation state to spawn in.
• Interval, Delay before spawning another enemy unit in seconds.
• Voice, Changes spawned enemies voice (mostly goes unused)
• Accessibility, Set the movement type for spawned enemies. (mostly goes unused)
• Force Pickup, Select an item for the unit to drop when tied or killed.
• Team, Select a team for this civilian to be on.

SpawnEnemyGroup

Spawn enemy groups.

• Manage Elements List, Select what enemy dummy elements to use to spawn groups.
• Spawn Type, Select how a group will be spawned.
  • Ordered, used for prefered assault spawns.
  • Random, used to pick a random spawn with the chosen amount.
  • Group, spawn a group of enemies.
  • Group_guaranteed, spawn a guaranteed group of enemies.
• Ignore Disabled, Toggle to have the element try to use EnemyDummy elements that have been toggled off.
• Amount, How many enemies to spawn from this group.
• Team, Select a team for this enemy to be on.

SpawnGageAssignment

Spawn gage packages, 2-10 based on difficulty.

• Manage Elements List, Select where gage packages should be randomly spawned.
  • Note: you should only use MissionScript elements for the locators of these packages!

SpawnGrenade

Spawn a thrown grenade.

• Grenade Type: Select what grenade its throwing
  • Note, currently only "frag" grenade type works.
• Strength: How fast the grenade is thrown from the elements position
• Note: This elements strength can be directed using the Arrow Keys.

SpawnUnit

Will spawn a selected unit at the location of the element.

• Unit Name: Holds the file path of the unit you wish to spawn.
  • Browse units can be used to easilly find loaded units you wish to spawn.
• Unit Spawn Velocity/Mass: Spawn the unit as if it were being pushed.
• Note: This elements Velocity/Mass can be directed using the Arrow Keys.

SpecialObjective

A highly modular element that can control Ai actions in many ways. SpecialObjectives may often be called "SO's".

• Access Flags Preset:
  • select all: Applies all access flags to the SO
  • clear all: Removes all access flags to the SO
• Manage Access Flags: The flags are identifiers for what types of enemies can use this SO.
  • teamAi1-4: These are your friendly Ai.
  • civ_male/civ_female: These are your basic civilian Ai and most escorts.
  • security/security_patrol: will often be used for security guard patrols.
  • Many other tags exist and should be self explanatory.
• Manage Followup Elements List: Select what element (or random enabled element if there's more than 1) to use once this SO is completed.
• Manage Spawn Instigator IDs List: Select what characters in the level should be called to do whatever actions the SO is set up for. No instigating elements are required.
• Search Position: Used for Navlinks as the end location or Scanning setups search position.
• Is Navigation Link: Should this element be used as a navigation link (for teleports or animations).
• Align Rotation: Should the user of this SO look in the same direction of this element.
• Align Position: Should the user of this SO stand in the same position of this element.
  • Note: This is not needed for Navigation Links and causes Ai to idle before animating.
• Needs Pos Rsrv: Toggle if this SO need to be completed/failed before allowing another instigator to use it.
• Repeatable: ToDo
• Use Instigator: Toggle if the instigating unit be the one to use this SO.
• Forced: Toggle if the user of the SO should immedietly stop his previous action before using this SO.
• NO Arrest: ToDo
• Scan: Toggle if this SO should use the scan radius when searching for an instigator.
• Allow Followup Self: ToDo
• Ai Group: Set what instigator type will use this SO, mostly used in pairing with a Special Objective Trigger.
• SO Action: What animation or special action the instigator of this SO should use.
  • AI_NAME actions are unique Ai modes for instigators.
• Patrol Path: Use with Patrol Paths for custom pathing
• Patrol Style: Modifies how Ai path.
• Patrol Haste: Set if the instigator should walk/run.
• Patrol Stance:
  • ntl: Neutral
  • hos: Hostile
  • cbt: Combat
• Pose: Standing or Crouching poses.
• Attitude: Set a combat attitude.
• Trigger On: ToDo
• Interaction Voice: ToDo
• Search Distance: Distance in cm to search for around the Search Position.
• Interrupt Dis: Distance in meters before a unit will stop when a threat is nearby.
  • Note: -1 will stop if a threat is any distance away.
• Interrupt Dmg: Damage ratio before a unit will stop.
• Interval: Set how often in seconds this SO will search for an actor.
  • Note: -1 will only search once.
• Base Chance: Chance set to 1 will have a 100% chance of an actor using this SO.
• Chance Inc: Add chance to base chance when failed.
• Action Duration Min/Max: Set the time in seconds for an actor to wait until continuing to the followup SO

SpecialObjectiveGroup

ToDo.

SpecialObjectiveTrigger

Triggers and executes when the specified event plays on the linked SpecialObjective element.

• Manage Element List: Select a SpecialObjective element to trigger from.
• Event: Select which event to trigger from. You can see what events an animation has available by finding it in the std.animation_state file: anims\units\enemies\cop\std.animation_states.

Spotter

ToDo.

Statistics

ToDo.

StatisticsContact

ToDo.

StatisticsJobs

ToDo.

StopEffect

Will stop the linked effect.

• Manage Element List: Select PlayEffect elements to stop.
• Operation:
  • fade_kill: Will fade out the effect.
  • kill: Immediately stops the effect without a fade.

StopWatch

ToDo.

StopWatchFilter

ToDo.

StopWatchOperator

ToDo.

StopWatchTrigger

ToDo.

T...

TangoAward

Used for the Arbiter Grenade Launcher challenge. You probably don't need this for custom heists.

TangoFilter

Used for the Arbiter Grenade Launcher challenge. You probably don't need this for custom heists.

TeamAICommands

ToDo.

TeamRelation

ToDo.

TeammateComment

ToDo.

TeleportPlayer

Teleport the instigator player to the elements position and rotation. Bug: Trigger times will not work properly, use a mission script before it if you want to include a trigger times. Bug: Teleports for VR players have issues, avoid using it in normal gameplay.

TerminateAssault

ToDo.

Timer

Set a countdown for the element to execute. Needs a TimerOperator element to start the timer. Starting the timer in edit-mode will crash the game, so make sure to start a playtest. If a TimerTrigger is linked, it will get priority over the "On Executed" list.

• Timer Units: Lets you connect a timer gui unit to visually display the countdown.
• Timer: Set the amount of time in seconds.

TimerOperator

Operates on Timer elements.

• Operation
  • pause: Pauses the timer until it gets started again
  • start: Starts the timer. If the timer was paused before it will continue from where it got paused.
  • add_time: Will add additional time to the timer element.
  • subtract_time: Will subtract time from a timer element.
  • reset: Will reset the timer to its original value.
  • set_time: Will set the timer element to a specific value.
• Time: Set the amount of time the element uses. Only used for add_time, subtract_time and set_time.

TimerTrigger

Executes when the connected Timer element reaches the specified value.

Toggle

Enables or disables elements mid-game.

• Manage Elements List: Select the elements to toggle.
• Toggle
  • On: Enables all selected elements.
  • Off: Disables all selected elements.
  • Toggle: Flips the current state of all selected elements.
• Set Trigger Times: Optional, can be used to also change trigger times of the selected elements.
  • Set to -1 to not use.

U...

UnitDamage

ToDo.

UnitSequence

Connects to units and runs sequences on them when executed.

• Only For Local Player: /shrug
• Manage Trigger List: Opens a list of all units in the level. Green highlighted units are connected to the element.
  • Time To Trigger: Adds a delay before the sequence gets run.
  • Sequence To Trigger: Select the sequence that should be run.

UnitSequenceTrigger

Connects to units and executes when specified sequences run on any of the units in the list. Used to trigger other elements, for example when a door gets lockpicked.

• Manage Sequence List: Opens a list of all units in the level. Green highlighted units are connected to the element.
  • Sequence: Select the sequence of the unit that should trigger the element.

UnloadStatic

ToDo.

V...

Variable

Unused, use VariableSet and VariableGet.

VariableGet

Basically a variable filter, only executes if the variable and the state match. Use in combination with VariableSet.

• Variable: Set the variable string to check
• Activated: Check if the variable is active or disabled.

VariableSet

Lets you set any variable to active or disabled. Use in combination with VariableGet. Variable states will be shared between instances/levels and remain in the last set state even after restarting your game.

• Variable: Can be any combination of numbers and letters. Should be something unique to your heist to not interfere with other heists. (Example: "your-level-id_power")
• Activated: If your variable should be active or disabled.

VehicleBoarding

ToDo.

VehicleOperator

ToDo.

VehicleSpawner

ToDo.

VehicleTrigger

ToDo.

W...

Waypoint

When executed, will show a waypoint icon pointing towads the position of the element. Waypoints can be removed using Operator Elements. In theory you can use any hud icon as a waypoint if you type in the id manually.

Icons listed in the element:

Icon	ID		Icon	ID		Icon	ID		Icon	ID
	pd2_c4			pd2_car			pd2_chainsaw			pd2_computer
	pd2_defend			pd2_door			pd2_drill			pd2_escape
	pd2_fire			pd2_fix			pd2_generic_interact			pd2_generic_look
	pd2_generic_saw			pd2_goto			pd2_kill			pd2_ladder
	pd2_loot			pd2_lootdrop			pd2_melee			pd2_methlab
	pd2_phone			pd2_power			pd2_question			pd2_talk
	pd2_water_tap			pd2_wirecutter

WhisperState

Used to change between loud and stealth.

• Whisper State: Toggle Whisper state on or off.
• Disable HUD: Disables the detection meter in stealth. Only visual, you can still get detected.

X...

XAudio

ToDo.

XAudioOperator

ToDo.