Skip to content

Commit

Permalink
Docs - Minor cleanup (#10747)
Browse files Browse the repository at this point in the history 
Minor doc fixes
  • Loading branch information
@johnb432
johnb432 authored Feb 17, 2025
1 parent 4f86527 commit 4800097
Show file tree
Hide file tree
Showing 17 changed files with 126 additions and 126 deletions.
2 changes: 1 addition & 1 deletion addons/interact_menu/functions/fnc_createAction.sqf
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
* Action <ARRAY>
*
* Example:
* ["VulcanPinch","Vulcan Pinch","",{_target setDamage 1;},{true},{},[parameters], [0,0,0], 100] call ace_interact_menu_fnc_createAction;
* ["VulcanPinch", "Vulcan Pinch", "", {_target setDamage 1;}, {true}, {}, [parameters], [0, 0, 0], 100] call ace_interact_menu_fnc_createAction;
*
* Public: Yes
*/
Expand Down
62 changes: 31 additions & 31 deletions docs/wiki/framework/arsenal-framework.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ To quickly add a full ACE Arsenal to a box for all clients use the following cod

`ace_arsenal_fnc_initBox`

| | Argument | Type | Optional (default value) |
|----| -------- | ---- | ------------------------ |
| | Arguments | Type(s) | Optional (default value) |
|----| --------- | ------- | ------------------------ |
| 0 | Box | Object | Required |
| 1 | Items | Array of strings or boolean | Required |
| 2 | Initialize globally | Boolean | Optional (default: `false`) |
Expand All @@ -51,8 +51,8 @@ Please note that at least one virtual item needs to be added otherwise ACE Arsen

`ace_arsenal_fnc_openBox`

| | Argument | Type | Optional (default value) |
|----| -------- | ---- | ------------------------ |
| | Arguments | Type(s) | Optional (default value) |
|----| --------- | ------- | ------------------------ |
| 0 | Box | Object | Required |
| 1 | Unit to open ACE Arsenal on | Object | Required |
| 2 | Ignore virtual items and fill ACE Arsenal | Boolean | Optional (default: `false`) |
Expand All @@ -67,8 +67,8 @@ In the second example a full ACE Arsenal will be opened on the player.

`ace_arsenal_fnc_removeBox`

| | Argument | Type | Optional (default value) |
|----| -------- | ---- | ------------------------ |
| | Arguments | Type(s) | Optional (default value) |
|----| --------- | ------- | ------------------------ |
| 0 | Box | Object | Required |
| 2 | Remove globally | Boolean | Optional (default: `false`) |

Expand All @@ -81,8 +81,8 @@ Example:

`ace_arsenal_fnc_addVirtualItems`

| | Argument | Type | Optional (default value) |
|----| -------- | ---- | ------------------------ |
| | Arguments | Type(s) | Optional (default value) |
|----| --------- | ------- | ------------------------ |
| 0 | Box | Object | Required |
| 1 | Items | Array of strings or boolean | Required |
| 2 | Add globally | Boolean | Optional (default: `false`) |
Expand All @@ -97,8 +97,8 @@ Examples:

`ace_arsenal_fnc_removeVirtualItems`

| | Argument | Type | Optional (default value) |
|----| -------- | ---- | ------------------------ |
| | Arguments | Type(s) | Optional (default value) |
|----| --------- | ------- | ------------------------ |
| 0 | Box | Object | Required |
| 1 | Items | Array of strings or boolean | Required |
| 2 | Remove globally | Boolean | Optional (default: `false`) |
Expand Down Expand Up @@ -185,16 +185,16 @@ Players with Zeus access can save default loadouts ingame, doing so will make th

`ace_arsenal_fnc_addDefaultLoadout`

| | Argument | Type | Optional (default value) |
|----| -------- | ---- | ------------------------ |
| | Arguments | Type(s) | Optional (default value) |
|----| --------- | ------- | ------------------------ |
| 0 | Name of loadout | String | Required |
| 1 | getUnitLoadout array or CBA extended loadout array | Array | Required |
| 2 | Add loadout globally | Boolean | Optional (default: `false`) |

Example:
`["Squad Leader", getUnitLoadout sql1, true] call ace_arsenal_fnc_addDefaultLoadout`

If a loadout with the same name exists, it will be overwritten.
If a loadout with a similar name exists (case insensitive), it is overwritten.

## 5. Stats

Expand Down Expand Up @@ -229,8 +229,8 @@ The arguments passed to the bar, text and condition statements are:
`ace_arsenal_fnc_addStat`
| | Argument | Type | Optional (default value) |
| --- | -------- | ---- | ------------------------ |
| | Arguments | Type(s) | Optional (default value) |
| --- | --------- | ------- | ------------------------ |
| 0 | Tabs to add the stat to | Array of arrays | Required |
| 0.1 | Left tab indexes | Array of numbers | Required |
| 0.2 | Right tab indexes | Array of numbers | Required |
Expand Down Expand Up @@ -263,8 +263,8 @@ If a stat already exists (so same class ID and tab), it will ignore the new addi

`ace_arsenal_fnc_removeStat`

| | Argument | Type | Optional (default value) |
|----| -------- | ---- | ------------------------ |
| | Arguments | Type(s) | Optional (default value) |
|----| --------- | ------- | ------------------------ |
| 0 | Array of IDs | Array | Required |

Stats IDs are unique, IDs are generated as follows:
Expand Down Expand Up @@ -345,8 +345,8 @@ The argument passed to the condition is:
`ace_arsenal_fnc_addSort`
| | Argument | Type | Optional (default value) |
| --- | -------- | ---- | ------------------------ |
| | Arguments | Type(s) | Optional (default value) |
| --- | --------- | ------- | ------------------------ |
| 0 | Tabs to add the sort to | Array of arrays | Required |
| 0.1 | Left tab indexes | Array of numbers | Required |
| 0.2 | Right tab indexes | Array of numbers | Required |
Expand Down Expand Up @@ -382,8 +382,8 @@ If a sorting method already exists (so same class ID and tab), it will ignore th

`ace_arsenal_fnc_removeSort`

| | Argument | Type | Optional (default value) |
|----| -------- | ---- | ------------------------ |
| | Arguments | Type(s) | Optional (default value) |
|----| --------- | ------- | ------------------------ |
| 0 | Array of IDs | Array | Required |

Sorting method IDs are unique and are generated in the same fashion as the stat IDs (see `5.3 Removing stats via a function`).
Expand Down Expand Up @@ -438,8 +438,8 @@ The focused unit object is passed to the condition and statement functions.
`ace_arsenal_fnc_addAction`
| | Argument | Type | Optional (default value) |
| --- | -------- | ---- | ------------------------ |
| | Arguments | Type(s) | Optional (default value) |
| --- | --------- | ------- | ------------------------ |
| 0 | Tabs to add the sort to | Array of numbers | Required |
| 1 | Action class ID | String | Required |
| 2 | Title | String | Required |
Expand Down Expand Up @@ -474,8 +474,8 @@ If an action already exists (so same class ID and tab within an action), it will

`ace_arsenal_fnc_removeAction`

| | Argument | Type | Optional (default value) |
|----| -------- | ---- | ------------------------ |
| | Arguments | Type(s) | Optional (default value) |
|----| --------- | ------- | ------------------------ |
| 0 | Array of IDs | Array | Required |

Action IDs are unique and their generation is explained in `7.2 Adding sorting methods via a function`.
Expand All @@ -496,10 +496,10 @@ All are local.
| `ace_arsenal_boxRemoved` | Arsenal box (OBJECT) |
| `ace_arsenal_displayOpened` | Arsenal display (DISPLAY) |
| `ace_arsenal_displayClosed` | None |
| `ace_arsenal_leftPanelFilled` | Arsenal display (DISPLAY), current left panel IDC (SCALAR), current right panel IDC (SCALAR) |
| `ace_arsenal_rightPanelFilled` | Arsenal display (DISPLAY), current left panel IDC (SCALAR), current right panel IDC (SCALAR) |
| `ace_arsenal_onLoadoutSave` | Loadout index (SCALAR), [loadout name (STRING), loadout data (ARRAY)] |
| `ace_arsenal_onLoadoutSaveExtended` | Loadout index (SCALAR), [loadout name (STRING), CBA extended loadout data (ARRAY)] | 3.15.1
| `ace_arsenal_leftPanelFilled` | Arsenal display (DISPLAY), current left panel IDC (NUMBER), current right panel IDC (NUMBER) |
| `ace_arsenal_rightPanelFilled` | Arsenal display (DISPLAY), current left panel IDC (NUMBER), current right panel IDC (NUMBER) |
| `ace_arsenal_onLoadoutSave` | Loadout index (NUMBER), [loadout name (STRING), loadout data (ARRAY)] |
| `ace_arsenal_onLoadoutSaveExtended` | Loadout index (NUMBER), [loadout name (STRING), CBA extended loadout data (ARRAY)] | 3.15.1
| `ace_arsenal_onLoadoutLoad` | loadout data (ARRAY), loadout name (STRING) |
| `ace_arsenal_onLoadoutLoadExtended` | CBA extended loadout data (ARRAY), loadout name (STRING) | 3.15.1
| `ace_arsenal_onLoadoutDelete` | loadout name (STRING) |
Expand All @@ -521,8 +521,8 @@ All are local.

`ace_arsenal_fnc_addRightPanelButton`

| | Argument | Type | Optional (default value) |
|----| -------- | ---- | ------------------------ |
| | Arguments | Type(s) | Optional (default value) |
|----| --------- | ------- | ------------------------ |
| 0 | Misc. items | Array of strings | Required |
| 1 | Tooltip | String | Optional (default: `""`) |
| 2 | Picture path | String | Optional (default: `"\z\ace\addons\arsenal\data\iconCustom.paa"`) |
Expand Down
8 changes: 4 additions & 4 deletions docs/wiki/framework/dragging-framework.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ You will **not** be able to carry / drag objects that are too heavy, the mass is
`ace_dragging_fnc_setDraggable`
| | Arguments | Type | Optional (default value) |
|----| --------- | ---- | ------------------------ |
| | Arguments | Type(s) | Optional (default value) |
|----| --------- | ------- | ------------------------ |
| 0 | Any object | Object | Required |
| 1 | Enable dragging, true to enable, false to disable | Boolean | Required |
| 2 | Position to offset the object from player | Array | Optional (default: `[0, 1.5, 0]`) |
Expand Down Expand Up @@ -78,8 +78,8 @@ You will **not** be able to carry / drag objects that are too heavy, the mass is
`ace_dragging_fnc_setCarryable`
| | Arguments | Type | Optional (default value) |
|----| --------- | ---- | ------------------------ |
| | Arguments | Type(s) | Optional (default value) |
|----| --------- | ------- | ------------------------ |
| 0 | Any object | Object | Required |
| 1 | Enable carrying, true to enable, false to disable | Boolean | Required |
| 2 | Position to offset the object from player | Array | Optional (default: `[0, 1, 1]`) |
Expand Down
36 changes: 18 additions & 18 deletions docs/wiki/framework/events-framework.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -202,8 +202,8 @@ Also Reference [CBA Events System](https://github.com/CBATeam/CBA_A3/wiki/Custom

`CBA_fnc_addEventHandler` - Adds an event handler with the event name and returns the event handler ID.

| | Arguments | Type | Optional (default value) |
|----| --------- | ---- | ------------------------ |
| | Arguments | Type(s) | Optional (default value) |
|----| --------- | ------- | ------------------------ |
| 0 | Event name | String | Required |
| 1 | Code block | Code | Required |
| **R** | Event ID | Number | Return value |
Expand All @@ -212,8 +212,8 @@ Also Reference [CBA Events System](https://github.com/CBATeam/CBA_A3/wiki/Custom

`CBA_fnc_removeEventHandler` - Removes a specific event handler of the given event name, using the ID returned from `CBA_fnc_addEventHandler`.

| | Arguments | Type | Optional (default value) |
|----| --------- | ---- | ------------------------ |
| | Arguments | Type(s) | Optional (default value) |
|----| --------- | ------- | ------------------------ |
| 0 | Event name | String | Required |
| 1 | Event ID | Number | Required |
| **R** | None | None | Return value |
Expand All @@ -224,8 +224,8 @@ Also Reference [CBA Events System](https://github.com/CBATeam/CBA_A3/wiki/Custom

`CBA_fnc_localEvent` - Calls an event only on the local machine, useful for inter-module events.

| | Arguments | Type | Optional (default value) |
|----| --------- | ---- | ------------------------ |
| | Arguments | Type(s) | Optional (default value) |
|----| --------- | ------- | ------------------------ |
| 0 | Event name | String | Required |
| 1 | Arguments | Any | Required |
| **R** | None | None | Return value |
Expand All @@ -234,8 +234,8 @@ Also Reference [CBA Events System](https://github.com/CBATeam/CBA_A3/wiki/Custom

`CBA_fnc_targetEvent` - Calls an event only on the target machine or list of target machines.

| | Arguments | Type | Optional (default value) |
|----| --------- | ---- | ------------------------ |
| | Arguments | Type(s) | Optional (default value) |
|----| --------- | ------- | ------------------------ |
| 0 | Event name | String | Required |
| 1 | Arguments | Any | Required |
| 2 | Target(s) | Object OR Number OR Array | Required |
Expand All @@ -245,8 +245,8 @@ Also Reference [CBA Events System](https://github.com/CBATeam/CBA_A3/wiki/Custom

`CBA_fnc_serverEvent` - Calls an event only on the server machine (dedicated or self-hosted).

| | Arguments | Type | Optional (default value) |
|----| --------- | ---- | ------------------------ |
| | Arguments | Type(s) | Optional (default value) |
|----| --------- | ------- | ------------------------ |
| 0 | Event name | String | Required |
| 1 | Arguments | Any | Required |
| **R** | None | None | Return value |
Expand All @@ -255,8 +255,8 @@ Also Reference [CBA Events System](https://github.com/CBATeam/CBA_A3/wiki/Custom

`CBA_fnc_globalEvent` - Calls an event on all machines - the local machine, and the server machine.

| | Arguments | Type | Optional (default value) |
|----| --------- | ---- | ------------------------ |
| | Arguments | Type(s) | Optional (default value) |
|----| --------- | ------- | ------------------------ |
| 0 | Event name | String | Required |
| 1 | Arguments | Any | Required |
| **R** | None | None | Return value |
Expand All @@ -270,8 +270,8 @@ Adds a globally synchronized event handler which will expire events after the pr

`ace_common_fnc_addSyncedEventHandler`

| | Arguments | Type | Optional (default value) |
|----| --------- | ---- | ------------------------ |
| | Arguments | Type(s) | Optional (default value) |
|----| --------- | ------- | ------------------------ |
| 0 | Event name | String | Required |
| 1 | Code block | Code | Required |
| 2 | Time to live | Number OR Code | Optional (default: `0`) |
Expand All @@ -283,8 +283,8 @@ Removes a specific event handler of the given event name, using the ID returned

`ace_common_fnc_removeSyncedEventHandler`

| | Arguments | Type | Optional (default value) |
|----| --------- | ---- | ------------------------ |
| | Arguments | Type(s) | Optional (default value) |
|----| --------- | ------- | ------------------------ |
| 0 | Event name | String | Required |
| **R** | None | None | Return value |

Expand All @@ -294,8 +294,8 @@ Calls a globally synchronized event, which will also be run on JIP players unles

`ace_common_fnc_syncedEvent`

| | Arguments | Type | Optional (default value) |
|----| --------- | ---- | ------------------------ |
| | Arguments | Type(s) | Optional (default value) |
|----| --------- | ------- | ------------------------ |
| 0 | Event name | String | Required |
| 1 | Arguments | Any | Required |
| 2 | Time to live for this call | Number OR Code | Optional (default: `0`) |
Expand Down
8 changes: 4 additions & 4 deletions docs/wiki/framework/explosives-framework.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -137,8 +137,8 @@ class CfgWeapons {
`ace_explosives_fnc_scriptedExplosive`
| | Arguments | Type | Optional (default value) |
|----| --------- | ---- | ------------------------ |
| | Arguments | Type(s) | Optional (default value) |
|----| --------- | ----- | ------------------------ |
| 0 | Explosive objects | Array | Required |
| 1 | Delay before detonation | Number | Optional (default: `0`, randomized up to given number if negative) |
| **R** | None | None | Return value |
Expand All @@ -156,8 +156,8 @@ class CfgWeapons {
`ace_explosives_fnc_connectExplosive`
| | Arguments | Type | Optional (default value) |
|----| --------- | ---- | ------------------------ |
| | Arguments | Type(s) | Optional (default value) |
|----| --------- | ------- | ------------------------ |
| 0 | Unit to connect to | Object | Required |
| 1 | Explosive object to connect to | Object | Required |
| 2 | Detonator type class name (must be present on unit) | String | Required |
Expand Down
8 changes: 4 additions & 4 deletions docs/wiki/framework/fastroping-framework.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,16 +87,16 @@ ACE3 provides two functions that are compatible with most helicopters and all AC

`ace_fastroping_fnc_equipFRIES`

| | Arguments | Type | Optional (default value) |
|----| --------- | ---- | ------------------------ |
| | Arguments | Type(s) | Optional (default value) |
|----| --------- | ------- | ------------------------ |
| 0 | Helicopter | Object | Required |
| **R** | None | None | Return value |

### 4.2. Remove FRIES from helicopter

`ace_fastroping_fnc_unequipFRIES`

| | Arguments | Type | Optional (default value) |
|----| --------- | ---- | ------------------------ |
| | Arguments | Type(s) | Optional (default value) |
|----| --------- | ------- | ------------------------ |
| 0 | Helicopter | Object | Required |
| **R** | None | None | Return value |
8 changes: 4 additions & 4 deletions docs/wiki/framework/fire-framework.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ Use `CBA_fnc_serverEvent` to use the following features. Events are defined only

`ace_fire_addFireSource`

| | Arguments | Type | Optional (default value) |
|----| --------- | ---- | ------------------------ |
| | Arguments | Type(s) | Optional (default value) |
|----| --------- | ------- | ------------------------ |
| 0 | Source of flame | Object/Position ASL | Required |
| 1 | Radius of fire | Number | Required |
| 2 | Intensity of fire (1, 10] | Number | Required |
Expand All @@ -34,8 +34,8 @@ Use `CBA_fnc_serverEvent` to use the following features. Events are defined only

`ace_fire_removeFireSource`

| | Arguments | Type | Optional (default value) |
|----| --------- | ---- | ------------------------ |
| | Arguments | Type(s) | Optional (default value) |
|----| --------- | ------- | ------------------------ |
| 0 | Fire source ID | Array/Boolean/Code/Config/Group/Namespace/NaN/Number/Object/Side/String | Required |

## 2. Variables
Expand Down
Loading

0 comments on commit 4800097

Please sign in to comment.