Skip to content

Commit

Permalink
Docs - Add missing info to Interaction Menu Framework (#10160)
Browse files Browse the repository at this point in the history
* Interaction Exceptions

* Additional Action Parameters
  • Loading branch information
mrschick authored Aug 5, 2024
1 parent c31ef9e commit f4f2dba
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/wiki/framework/interactionMenu-framework.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,10 @@ class CfgVehicles {
| `distance` | Number | External Base Actions Only, Max distance player can be from action point |
| `position` | String (of code) | External Base Actions Only, Code to return a position in model cords (priority over `selection`) |
| `selection` | String | External Base Actions Only, A memory point for `selectionPosition` |
| `doNotCheckLOS` | Number | (1=true) - Ignores blocked LOS to the interaction node even when beyond 1.2m |
| `showDisabled` | Number | Currently has no effect |
| `enableInside` | Number | Currently has no effect |
| `canCollapse` | Number | Currently has no effect |
Actions can be inserted anywhere on the config tree, e.g. hearing's earplugs is a sub action of `ACE_Equipment`:
Expand All @@ -72,6 +76,25 @@ class CAManBase: Man {
};
```

Interaction exceptions are defined by several components:

| Component | Exception | Description |
| ---------- | ----------- | ------------------- |
| `captives` | `"isNotEscorting"` | Can interact while escorting a captive |
| | `"isNotHandcuffed"` | Can interact while handcuffed |
| | `"isNotSurrendering"` | Can interact while surrendering |
| `common` | `"isNotDead"` | Can interact while dead |
| | `"notOnMap"` | Can interact while in Map |
| | `"isNotInside"` | Can interact while inside a vehicle |
| | `"isNotInZeus"` | Can interact while in the zeus interface |
| | `"isNotUnconscious"` | Can interact while unconscious |
| `dragging` | `"isNotDragging"` | Can interact while dragging |
| | `"isNotCarrying"` | Can interact while carrying |
| `interaction` | `"isNotSwimming"` | Can interact while swimming/diving |
| | `"isNotOnLadder"` | Can interact while climbing a ladder |
| `refuel` | `"isNotRefueling"` | Can interact while carrying refueling nozzle |
| `sitting` | `"isNotSitting"` | Can interact while sitting in a chair |

## 3. Adding actions via scripts

Two steps, creating an action (array) and then adding it to either a class or object.
Expand Down

0 comments on commit f4f2dba

Please sign in to comment.