Scripting conditions

From FleshWorks

See also Scripting Actions

In a fresh editor installation conditions are grouped in the following categories. Click on a category to see which conditions belong to it:

Contents 1 AI 2 Bink 3 Controls 4 Elevators 5 Flags and Messages 6 Frob 7 Global Variables 8 Goals 9 Matinee 10 Objects 11 Player 12 Properties 13 Scripts 14 Volumes 15 Weapons and Inventory 16 Miscellaneous

AI

These are the scripting conditions belonging to the category "AI". They probably need to be categorized further (alertness, health, evidence, etc.).

1. When the AI receives evidence of type [Enum:EEvidenceType]
2. When the AI reaches a patrol point linked to by a TriggerScript link named [String]
3. While the AI is in the behavior state [Enum:EStateType]
4. When the AI is in a context volume of type [ContextVolumeType]
5. When the AI has the inference [Enum:EInferenceType]
6. When this AI is killed by the player
7. DEPRICATED, DO NOT USE: When AI is blackjacked by the player
8. When AI's body is discovered by another AI
9. Query if pawn(s) at end of link [LinkFlavor] has enough inventory space for object(s) at end of link [LinkFlavor]
10. When AI is disabled by the player with [Enum:eStimulusType]
11. When linked AI [LinkFlavor] exits combat
12. When linked AI [LinkFlavor] enters combat
13. When linked AI [LinkFlavor] sees the player
14. When the AI is in a tagged volume named [String]
15. When this AI sees the player threatening it
16. When this AI sees the player with weapon drawn
17. When any AI sees the player and has a disposition of [Enum:EFactionDisposition] towards the player
18. When my behavior state changes to [Enum:EStateType]
19. While I see the player hacking/lockpicking
20. When AI's body is discovered by an AI through [LinkFlavor]
21. When this AI becomes alerted
22. When this AI kills any other AI through [LinkFlavor]
23. When I see a [Enum:eHealthState] body towards which I am [Enum:EFactionDisposition]
24. When I take health damage [Relation] [Float] from [Enum:eStimulusType] at [Enum:eBodyLocation] , and it is caused by culprit(s) [LinkFlavor]
25. When I see the player frob an instance or archetype attached via [LinkFlavor]
26. Query if any AI connected to [LinkFlavor] has disposition [Enum:EFactionDisposition] towards the player

Bink

These are the scripting conditions belonging to the category "Bink":

1. When an FMV begins
2. When an FMV is paused
3. When an FMV is resumed
4. When an FMV ends
5. Query if the FMV from FMVWindow [String] is playing
6. Query if the FMV from FMVWindow [String] is paused
7. Query if the FMV from FMVWindow [String] is named [String]

Controls

These are the scripting conditions belonging to the category "Controls":

1. If this is the Xbox version
2. When a gamepad is plugged in, after having been removed or the game starts without one.
3. When a gamepad is removed or the game starts without one.
4. Query if the number of saved games is [Relation] [Int]

Elevators

These are the scripting conditions belonging to the category "Elevators":

1. When elevator(s) at end of link [LinkFlavor] starts or moves from rest
2. When elevator(s) at end of link [LinkFlavor] stops or comes to rest
3. When Floor Marker at end of link [LinkFlavor] is reached by elevator(s) at end of link [LinkFlavor]

Flags and Messages

These are the scripting conditions belonging to the category "Flags & Messages":

1. When propagated message [String] detected on linked object(s) [LinkFlavor]
2. When [Flag] is set to [Flag]
3. When [Flag] is set to [Bool]
4. Received trigger message [String]
5. Query random stream [String] with range [Int] to [Int] for a number between [Int] and [Int]
6. Query if flag [Flag] is set to [Bool]
7. Query if flag [Flag] is set to [Flag]
8. Query if counter is [Relation] to [Int]

Frob

These are the scripting conditions belonging to the category "Frob":

1. When I am frobbed by a linked object of [LinkFlavor]
2. When I am frobbed by player
3. When I am frobbed by an AI

Global Variables

These are the scripting conditions belonging to the category """GobalVariables""":

1. When [GlobalInt] becomes [Relation] [Int]
2. When [GlobalInt] becomes [Relation] [GlobalInt]
3. Query if [GlobalInt] is [Relation] [Property:floatintbool] of [LinkFlavor] linked object(s)
4. Query if [GlobalInt] is [Relation] [Int]
5. Query if [GlobalInt] is [Relation] [GlobalInt]

Goals

These are the scripting conditions belonging to the category "Goals":

1. When Goal [String] changes from [Enum:eGoalState] to [Enum:eGoalState]
2. Query if all goals are completed or cancelled, exclude hidden [Bool] ? include 'do last' goals [Bool] ?
3. When game has been played for [GlobalInt] minutes, tracked in [GlobalInt]
4. Query if goal [String] is [Relation] [Enum:eGoalState]

Matinee

These are the scripting conditions belonging to the category "Matinee":

1. When matinee sequence tagged [Name] has finished
2. When matinee sequence tagged [Name] is started
3. When matinee sequence tagged [Name] reaches trigger event named [Name]
4. When any linked interpolation point(s) [LinkFlavor] are reached in a matinee sequence tagged [Name]

Objects

These are the scripting conditions belonging to the category "Objects":

1. When linked object(s) [LinkFlavor] named [String] damage level changes to [Enum:eDamageLevel]
2. When linked object(s) [LinkFlavor] take [Relation] [Float] of stimulus [Enum:eStimulusType]
3. When linked object(s) [LinkFlavor] are destroyed.
4. When I come to rest for the first time.
5. When my health state changes to [Enum:eHealthState] from [Enum:eStimulusType]
6. When my object receives [DoorState]
7. When I take health damage [Relation] [Float] from [Enum:eStimulusType] at [Enum:eBodyLocation]
8. Query if I have any links of [LinkFlavor:NoSelf]
9. Query if linked object(s) [LinkFlavor] are within [Float] unreal units from linked object(s) [LinkFlavor]
10. On the event that [Property] changes on any linked objects(s) [LinkFlavor]
11. When linked object(s) [LinkFlavor] hit a notetrack named [String]
12. When linked object(s) [LinkFlavor] are frobbed by [Enum:eObjectCategory]
13. When my object contacts the ground
14. While linked object(s) [LinkFlavor] are within [Float] unreal units from linked object(s) [LinkFlavor]

Player

These are the scripting conditions belonging to the category "Player":

1. When player starts map
2. {{{1}}}
3. Query if pawn(s) at end of link [LinkFlavor] has object(s) at end of link [LinkFlavor] in inventory
4. When player leans
5. NOT YET IMPLEMENTED : When player uses mechanical eye zoom
6. When the player is about to travel to a new level.
7. When the player travels to a new level that is a city section.
8. When the player travels to a new level that is not a city section.

Properties

These are the scripting conditions belonging to the category "Properties":

1. On the event that [Property] is [Relation] [Value] on all linked objects(s) [LinkFlavor]
2. Query if [Property] is [Relation] [Value] on any linked object(s) [LinkFlavor]
3. Query if [Property] is [Relation] [Value] on all linked object(s) [LinkFlavor]

Property List

Scripts

These are the scripting conditions belonging to the category "Scripts":

1. On script startup
2. Logic [Logic] operator: This allows you to specify various logic operations on conditions nested into the Logic condition. Note that the AND operation does not seem to work, but since all of the conditions of the script must be met for the Actions to occur anyway, it is in some ways implied.
3. When map sim starts, either from travel, load, or launcher
4. When map starts, arriving from a different map
5. Query if SimTime is paused
6. On the event that [Property] is [Relation] [Value] on any linked objects(s) [LinkFlavor]

Volumes

These are the scripting conditions belonging to the category "Volumes":

1. When linked volume(s) [LinkFlavor] are breached by [Enum:eObjectCategory]
2. When linked volume(s) [LinkFlavor] are breached by object(s) at end of [LinkFlavor]
3. When linked volume(s) [LinkFlavor] are exited by [Enum:eObjectCategory]
4. Query if linked volume(s) [LinkFlavor] contains the linked object(s) at end of [LinkFlavor]

Weapons and Inventory

These are the scripting conditions belonging to the category "Weapons & Inventory":

1. When my object is fired by the player.
2. When I am used in a way from the inventory
3. When I am activated (currently only valid for augs)
4. When [InventoryClass] count in inventory becaomes [Relation] [Int]

Miscellaneous

1. Fire this condition every [Int] seconds of GAME time
2. If my object's DoorState is currently [DoorState]
3. Query if my current alert level is [Enum:EAlertState]
4. Query if player's current cash is [Relation] [Int] . Count unsold loot as well: [Bool].
5. Query if this object is within view
6. When AI through [LinkFlavor] goes to Criminal Response because of [Enum:WarnReason] ...
7. When linked object(s) [LinkFlavor] are purchased from a store
8. When my alert state changes to [Enum:EAlertState]
9. When the player drops the bodies of linked object(s) [LinkFlavor]
10. When the player sells a loot item with the string tag name [String]
11. When this AI kills the player
12. When this puddle is stepped on.