diff --git a/addons/interact_menu/functions/fnc_createAction.sqf b/addons/interact_menu/functions/fnc_createAction.sqf index 75383950f13..f901e66dbc2 100644 --- a/addons/interact_menu/functions/fnc_createAction.sqf +++ b/addons/interact_menu/functions/fnc_createAction.sqf @@ -21,7 +21,7 @@ * Action * * 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 */ diff --git a/docs/wiki/framework/arsenal-framework.md b/docs/wiki/framework/arsenal-framework.md index 2f37e552e1e..7f6e6de6ef1 100644 --- a/docs/wiki/framework/arsenal-framework.md +++ b/docs/wiki/framework/arsenal-framework.md @@ -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`) | @@ -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`) | @@ -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`) | @@ -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`) | @@ -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`) | @@ -185,8 +185,8 @@ 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`) | @@ -194,7 +194,7 @@ Players with Zeus access can save default loadouts ingame, doing so will make th 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 @@ -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 | @@ -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: @@ -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 | @@ -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`). @@ -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 | @@ -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`. @@ -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) | @@ -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"`) | diff --git a/docs/wiki/framework/dragging-framework.md b/docs/wiki/framework/dragging-framework.md index 256d41570d4..c1ea7b62012 100644 --- a/docs/wiki/framework/dragging-framework.md +++ b/docs/wiki/framework/dragging-framework.md @@ -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]`) | @@ -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]`) | diff --git a/docs/wiki/framework/events-framework.md b/docs/wiki/framework/events-framework.md index 8d1940a1213..8569f41a9aa 100644 --- a/docs/wiki/framework/events-framework.md +++ b/docs/wiki/framework/events-framework.md @@ -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 | @@ -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 | @@ -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 | @@ -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 | @@ -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 | @@ -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 | @@ -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`) | @@ -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 | @@ -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`) | diff --git a/docs/wiki/framework/explosives-framework.md b/docs/wiki/framework/explosives-framework.md index 8a026e806ea..533d7a773b7 100644 --- a/docs/wiki/framework/explosives-framework.md +++ b/docs/wiki/framework/explosives-framework.md @@ -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 | @@ -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 | diff --git a/docs/wiki/framework/fastroping-framework.md b/docs/wiki/framework/fastroping-framework.md index 57c6b9055d4..a2a75e9b5a1 100644 --- a/docs/wiki/framework/fastroping-framework.md +++ b/docs/wiki/framework/fastroping-framework.md @@ -87,8 +87,8 @@ 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 | @@ -96,7 +96,7 @@ ACE3 provides two functions that are compatible with most helicopters and all AC `ace_fastroping_fnc_unequipFRIES` -| | Arguments | Type | Optional (default value) | -|----| --------- | ---- | ------------------------ | +| | Arguments | Type(s) | Optional (default value) | +|----| --------- | ------- | ------------------------ | | 0 | Helicopter | Object | Required | | **R** | None | None | Return value | diff --git a/docs/wiki/framework/fire-framework.md b/docs/wiki/framework/fire-framework.md index 147710384cd..ba25d949b0f 100644 --- a/docs/wiki/framework/fire-framework.md +++ b/docs/wiki/framework/fire-framework.md @@ -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 | @@ -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 diff --git a/docs/wiki/framework/interactionMenu-framework.md b/docs/wiki/framework/interactionMenu-framework.md index 56cde5fc2c3..9c3d9d45eee 100644 --- a/docs/wiki/framework/interactionMenu-framework.md +++ b/docs/wiki/framework/interactionMenu-framework.md @@ -144,18 +144,18 @@ Important: `ace_common_fnc_canInteractWith` is not automatically checked and nee ```sqf /* - * Argument: + * Arguments: * 0: Action name * 1: Name of the action shown in the menu - * 2: Icon + * 2: Icon file path or Array of icon file path and hex color ("" for default icon) * 3: Statement * 4: Condition - * 5: Insert children code (Optional) - * 6: Action parameters (Optional) - * 7: Position (Position array, Position code or Selection Name) , or (Optional) - * 8: Distance (Optional) - * 9: Other parameters [showDisabled,enableInside,canCollapse,runOnHover,doNotCheckLOS] (Optional) - * 10: Modifier function (Optional) + * 5: Insert children code (default: {}) + * 6: Action parameters (default: []) + * 7: Position (Position array, Position code or Selection Name) (default: {[0, 0, 0]}) + * 8: Distance (default: 2) + * 9: Other parameters [showDisabled,enableInside,canCollapse,runOnHover,doNotCheckLOS] (default: all false) + * 10: Modifier function (default: {}) */ ``` @@ -165,13 +165,13 @@ Important: `ace_common_fnc_canInteractWith` is not automatically checked and nee ```sqf /* - * Argument: + * Arguments: * 0: TypeOf of the class * 1: Type of action, 0 for actions, 1 for self-actions * 2: Parent path of the new action * 3: Action - * 4: Use Inheritance (Default: False) - * 5: Classes excluded from inheritance (children included) (Default: []) + * 4: Use Inheritance (default: false) + * 5: Classes excluded from inheritance (children included) (default: []) */ ``` By default this function will not use inheritance, so actions will only be added to the specific class. @@ -182,7 +182,7 @@ By default this function will not use inheritance, so actions will only be added ```sqf /* - * Argument: + * Arguments: * 0: Object the action should be assigned to * 1: Type of action, 0 for actions, 1 for self-actions * 2: Parent path of the new action (Example: `["ACE_SelfActions", "ACE_Equipment"]`) @@ -196,7 +196,7 @@ By default this function will not use inheritance, so actions will only be added ```sqf /* - * Argument: + * Arguments: * 0: Parent path of the new action (Example: `["ACE_ZeusActions"]`) * 1: Action */ @@ -207,7 +207,7 @@ By default this function will not use inheritance, so actions will only be added External: ```sqf -_action = ["VulcanPinch","Vulcan Pinch","",{_target setDamage 1;},{true},{},[parameters], [0,0,0], 100] call ace_interact_menu_fnc_createAction; +_action = ["VulcanPinch", "Vulcan Pinch", "", {_target setDamage 1;}, {true}, {}, [parameters], [0, 0, 0], 100] call ace_interact_menu_fnc_createAction; [cursorTarget, 0, ["ACE_TapShoulderRight"], _action] call ace_interact_menu_fnc_addActionToObject; ``` @@ -220,8 +220,8 @@ _condition = { _statement = { [true] call pabst_fnc_radioFinder_action; }; -_action = ["Open RDF","Radio Direction Finder","pabst\RDF.jpg",_statement,_condition] call ace_interact_menu_fnc_createAction; -[(typeOf _unit), 1, ["ACE_SelfActions"], _action] call ace_interact_menu_fnc_addActionToClass; +_action = ["Open RDF", "Radio Direction Finder", "pabst\RDF.jpg", _statement, _condition] call ace_interact_menu_fnc_createAction; +[typeOf _unit, 1, ["ACE_SelfActions"], _action] call ace_interact_menu_fnc_addActionToClass; ``` Using `addActionToClass` inheritance: @@ -236,7 +236,7 @@ _action = ["CheckFuel", "Check Fuel", "", {hint format ["Fuel: %1", fuel _target ["LandVehicle", 0, ["ACE_MainActions"], _action, true, ["MRAP_01_Base"]] call ace_interact_menu_fnc_addActionToClass; // Adds action to check external fuel levels on tanks. Will be a sub action of the previous action. -_action = ["CheckExtTank","Check External Tank","",{hint format ["Ext Tank: %1", 5]},{true}] call ace_interact_menu_fnc_createAction; +_action = ["CheckExtTank", "Check External Tank", "", {hint format ["Ext Tank: %1", 5]}, {true}] call ace_interact_menu_fnc_createAction; ["Tank_F", 0, ["ACE_MainActions", "CheckFuel"], _action, true] call ace_interact_menu_fnc_addActionToClass; ``` @@ -246,7 +246,7 @@ Zeus: _statement = { playSound3D ["alarm.ogg", theBase] }; -_action = ["myMissionEvent1","Mission Event: Play Base Alarm","",_statement,{true}] call ace_interact_menu_fnc_createAction; +_action = ["myMissionEvent1", "Mission Event: Play Base Alarm", "", _statement, {true}] call ace_interact_menu_fnc_createAction; [["ACE_ZeusActions"], _action] call ace_interact_menu_fnc_addActionToZeus; ``` @@ -291,7 +291,7 @@ _modifierFunc = { _actionData set [1, format ["Give Items: %1", count (items player)]]; }; -_action = ["GiveItems", "?","",_statement,_condition,_insertChildren,[123],"",4,[false, false, false, true, false], _modifierFunc] call ace_interact_menu_fnc_createAction; +_action = ["GiveItems", "?", "", _statement, _condition, _insertChildren, [123], "", 4, [false, false, false, true, false], _modifierFunc] call ace_interact_menu_fnc_createAction; [q3, 0, ["ACE_MainActions"], _action] call ace_interact_menu_fnc_addActionToObject; ``` @@ -304,10 +304,10 @@ This is the ideal way to add self interaction actions, as adding them via `addAc // Example: Add radio self-action to all civilian cars ["ace_interact_menu_newControllableObject", { params ["_type"]; // string of the object's classname - if (!(_type isKindOf "Car")) exitWith {}; + if !(_type isKindOf "Car") exitWith {}; if ((getNumber (configFile >> "CfgVehicles" >> _type >> "side")) != 3) exitWith {}; - private _action = ["playRadio","Play Radio","",{playMusic "NeverGonnaGiveYouUp"},{true}] call ace_interact_menu_fnc_createAction; + private _action = ["playRadio", "Play Radio", "", {playMusic "NeverGonnaGiveYouUp"}, {true}] call ace_interact_menu_fnc_createAction; [_type, 1, ["ACE_SelfActions"], _action, true] call ace_interact_menu_fnc_addActionToClass; }] call CBA_fnc_addEventHandler; ``` diff --git a/docs/wiki/framework/laser-framework.md b/docs/wiki/framework/laser-framework.md index fef12a47603..c18e974e0c3 100644 --- a/docs/wiki/framework/laser-framework.md +++ b/docs/wiki/framework/laser-framework.md @@ -18,8 +18,8 @@ version: `ace_laser_fnc_getLaserCode` -| | Arguments | Type | Optional (default value) | -|----| --------- | ---- | ------------------------ | +| | Arguments | Type(s) | Optional (default value) | +|----| --------- | ------- | ------------------------ | | 0 | Unit/Vehicle | Object | Required | | **R** | Laser code | Number | Return value | @@ -27,8 +27,8 @@ version: `ace_laser_fnc_setLaserCode` -| | Arguments | Type | Optional (default value) | -|----| --------- | ---- | ------------------------ | +| | Arguments | Type(s) | Optional (default value) | +|----| --------- | ------- | ------------------------ | | 0 | Unit/Vehicle | Object | Required | | 1 | Laser code | Number | Required | | **R** | None | None | Return value | diff --git a/docs/wiki/framework/medical-framework.md b/docs/wiki/framework/medical-framework.md index c3ec6d31de4..744334f048b 100644 --- a/docs/wiki/framework/medical-framework.md +++ b/docs/wiki/framework/medical-framework.md @@ -219,8 +219,8 @@ Custom wound handlers should follow the same spec as the built-in handler: `ace_medical_damage_fnc_woundsHandlerBase` -| | Arguments | Type | Optional (default value) | -|----| --------- | ---- | ------------------------ | +| | Arguments | Type(s) | Optional (default value) | +|----| --------- | ------- | ------------------------ | | 0 | Unit that was hit | Object | Required | | 1 | Array of damage dealt to each body part | Array | Required | | 2 | Type of damage | String | Required | diff --git a/docs/wiki/framework/rearm-framework.md b/docs/wiki/framework/rearm-framework.md index a4061cb2bc2..e1049919546 100644 --- a/docs/wiki/framework/rearm-framework.md +++ b/docs/wiki/framework/rearm-framework.md @@ -71,8 +71,8 @@ Meant to run on server only. `ace_rearm_fnc_makeSource` -| | Arguments | Type | Optional (default value) | -|----| --------- | ---- | ------------------------ | +| | Arguments | Type(s) | Optional (default value) | +|----| --------- | ------- | ------------------------ | | 0 | Ammo Truck | Object | Required | | 1 | Supply Count | Number | Optional (default: `0`) | | 1 | Add (`true`) or set (`false`) supply | Bool | Optional (default: `false`) | @@ -91,8 +91,8 @@ Meant to run on server only. `ace_rearm_fnc_disable` -| | Arguments | Type | Optional (default value) | -|----| --------- | ---- | ------------------------ | +| | Arguments | Type(s) | Optional (default value) | +|----| --------- | ------- | ------------------------ | | 0 | Ammo Truck | Object | Required | | 1 | Disable rearming, true to disable, false to enable | Boolean | Optional (default: `true`) | | **R** | None | None | Return value | @@ -124,8 +124,8 @@ Enables rearming on the object `tank`. `ace_rearm_fnc_getSupplyCount` -| | Arguments | Type | Optional (default value) | -|----| --------- | ---- | ------------------------ | +| | Arguments | Type(s) | Optional (default value) | +|----| --------- | ------- | ------------------------ | | 0 | Ammo Truck | Object | Required | | **R** | Supply count | Number | Return value | @@ -145,8 +145,8 @@ The remaining supply count of `ammo_truck` will be returned. `ace_rearm_fnc_setSupplyCount` -| | Arguments | Type | Optional (default value) | -|----| --------- | ---- | ------------------------ | +| | Arguments | Type(s) | Optional (default value) | +|----| --------- | ------- | ------------------------ | | 0 | Ammo Truck | Object | Required | | 1 | Supply Count | Boolean | Required | | **R** | None | None | Return value | @@ -166,8 +166,8 @@ This function sets the current supply count of the ammo truck. It can be used to `ace_rearm_fnc_addMagazineToSupply` -| | Arguments | Type | Optional (default value) | -|----| --------- | ---- | ------------------------ | +| | Arguments | Type(s) | Optional (default value) | +|----| --------- | ------- | ------------------------ | | 0 | Ammo Truck | Object | Required | | 1 | Magazine Classname | String | Required | | 2 | Only add content of one ammo box | Boolean | Optional (default: `false`) | @@ -192,8 +192,8 @@ The 32 artillery shells are added to the supply count or the magazine storage of `ace_rearm_fnc_addVehicleMagazinesToSupply` -| | Arguments | Type | Optional (default value) | -|----| --------- | ---- | ------------------------ | +| | Arguments | Type(s) | Optional (default value) | +|----| --------- | ------- | ------------------------ | | 0 | Ammo Truck | Object | Required | | 1 | Any vehicle object or class name | Object or String | Required | | **R** | None | None | Return value | @@ -227,8 +227,8 @@ All magazines found in the config of the vehicle class `B_MBT_01_arty_F` are mad `ace_rearm_fnc_removeMagazineFromSupply` -| | Arguments | Type | Optional (default value) | -|----| --------- | ---- | ------------------------ | +| | Arguments | Type(s) | Optional (default value) | +|----| --------- | ------- | ------------------------ | | 0 | Ammo Truck | Object | Required | | 1 | Magazine Classname | String | Required | | 2 | Number of Rounds to withdraw | Number | Optional (default: `-1`) | diff --git a/docs/wiki/framework/refuel-framework.md b/docs/wiki/framework/refuel-framework.md index 3cf10d72053..523695a6168 100644 --- a/docs/wiki/framework/refuel-framework.md +++ b/docs/wiki/framework/refuel-framework.md @@ -45,8 +45,8 @@ Meant to be called on server only. `ace_refuel_fnc_makeSource` -| | Arguments | Type | Optional (default value) | -|----| --------- | ---- | ------------------------ | +| | Arguments | Type(s) | Optional (default value) | +|----| --------- | ------- | ------------------------ | | 0 | Fuel Source | Object | Required | | 1 | Amount (in liters) | Number | Optional (default: `0`) | | 2 | Hooks positions | Array | Optional (default: `[[0,0,0]]`) | @@ -65,8 +65,8 @@ Meant to be called on server only. `ace_refuel_fnc_getFuel` -| | Arguments | Type | Optional (default value) | -|----| --------- | ---- | ------------------------ | +| | Arguments | Type(s) | Optional (default value) | +|----| --------- | ------- | ------------------------ | | 0 | Fuel Truck | Object | Required | | **R** | Fuel amount left (in liters) | Number | Return value | @@ -82,8 +82,8 @@ Meant to be called on server only. `ace_refuel_fnc_setFuel` -| | Arguments | Type | Optional (default value) | -| ---| --------- | ---- | ------------------------ | +| | Arguments | Type(s) | Optional (default value) | +|----| --------- | ------- | ------------------------ | | 0 | Fuel Truck | Object | Required | | 1 | Amount (in liters) | Number | Required | | **R** | None | None | Return value | @@ -103,8 +103,8 @@ Meant to be run on all clients and server. `ace_refuel_fnc_makeJerryCan` -| | Arguments | Type | Optional (default value) | -|----| --------- | ---- | ------------------------ | +| | Arguments | Type(s) | Optional (default value) | +|----| --------- | ------- | ------------------------ | | 0 | Jerry Can | Object | Required | | 1 | Amount (in liters) | Number | Optional (default: `20`) | | **R** | None | None | Return value | diff --git a/docs/wiki/framework/slideshow-framework.md b/docs/wiki/framework/slideshow-framework.md index 575a81420c4..a54e52d85b8 100644 --- a/docs/wiki/framework/slideshow-framework.md +++ b/docs/wiki/framework/slideshow-framework.md @@ -32,8 +32,8 @@ Important notes: `ace_slideshow_fnc_createSlideshow` -| | Arguments | Type | Optional (default value) | -|----| --------- | ---- | ------------------------ | +| | Arguments | Type(s) | Optional (default value) | +|----| --------- | ------- | ------------------------ | | 0 | Screen Objects | Array | Required | | 1 | Controller Objects | Array | Required (screen objects are used if empty `[]`, none are available with automatic transitions) | | 2 | Image Paths | Array | Required (paths must use backslash `\`) | diff --git a/docs/wiki/framework/tagging-framework.md b/docs/wiki/framework/tagging-framework.md index 126971abf59..bd6b02191b6 100644 --- a/docs/wiki/framework/tagging-framework.md +++ b/docs/wiki/framework/tagging-framework.md @@ -41,8 +41,8 @@ class ACE_Tags { `ace_tagging_fnc_addCustomTag` -| | Arguments | Type | Optional (default value) | -| ---| --------- | ---- | ------------------------ | +| | Arguments | Type(s) | Optional (default value) | +|----| --------- | ------- | ------------------------ | | 0 | Unique Identifier | String | Required | | 1 | Display Name | String | Required | | 2 | Required Item | String | Required | diff --git a/docs/wiki/framework/ui-framework.md b/docs/wiki/framework/ui-framework.md index 095025ffe0b..68c3cd5df00 100644 --- a/docs/wiki/framework/ui-framework.md +++ b/docs/wiki/framework/ui-framework.md @@ -53,8 +53,8 @@ Adding new elements through scripting is currently not possible. `ace_ui_fnc_setElementVisibility` -| | Arguments | Type | Optional (default value) | -|----| --------- | ---- | ------------------------ | +| | Arguments | Type(s) | Optional (default value) | +|----| --------- | ------- | ------------------------ | | 0 | Source | String | Required | | 1 | Set/Unset | Boolean | Required | | 2 | Element Name | String | Required | @@ -79,4 +79,4 @@ It triggers an event that is listenable allowing other mods to hide their displa | Event Key | Parameters | Locality | Type | Description | |---------- |------------|----------|------|-------------| -| `ace_ui_hideHud` | `[_set]` | Local | Listen | _set=true means things should be hidden \ No newline at end of file +| `ace_ui_hideHud` | `[_set]` | Local | Listen | _set=true means things should be hidden diff --git a/docs/wiki/framework/vehiclelock-framework.md b/docs/wiki/framework/vehiclelock-framework.md index d882cab9713..eb8f08e117e 100644 --- a/docs/wiki/framework/vehiclelock-framework.md +++ b/docs/wiki/framework/vehiclelock-framework.md @@ -31,8 +31,8 @@ Sync the module with vehicles and players. Custom keys will be handed to players `ace_vehiclelock_fnc_addKeyForVehicle` -| | Arguments | Type | Optional (default value) | -|----| --------- | ---- | ------------------------ | +| | Arguments | Type(s) | Optional (default value) | +|----| --------- | ------- | ------------------------ | | 0 | Unit | Object | Required | | 1 | Vehicle | Object | Required | | 2 | Use Custom Key | Boolean | Optional (default: `false`, `false` for side key, `true` for custom key) | diff --git a/docs/wiki/framework/vehicles-framework.md b/docs/wiki/framework/vehicles-framework.md index dac52d0cfa9..405f1a5c2fc 100644 --- a/docs/wiki/framework/vehicles-framework.md +++ b/docs/wiki/framework/vehicles-framework.md @@ -38,8 +38,8 @@ class CfgVehicles { `ace_vehicles_fnc_setVehicleStartDelay` Has global effects. -| | Arguments | Type | Optional (default value) | -|----| --------- | ---- | ------------------------ | +| | Arguments | Type(s) | Optional (default value) | +|----| --------- | ------- | ------------------------ | | 0 | Vehicle | Object | Required | | 1 | Delay (in seconds) | Number | Required | | **R** | None | None | Return value |