Skip to content

Commit adcf7b0

Browse files
johnb432johnb432
authored
Docs - Improve (#11258)
Improve docs
1 parent c4143b5 commit adcf7b0

File tree

2 files changed

+20
-14
lines changed

2 files changed

+20
-14
lines changed

‎docs/wiki/framework/events-framework.md‎

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,18 @@ E.G.: If you only need to do action when player's weapon fires, this will be fas
2323
The vehicle events will also have the following local variables available `_gunner (OBJECT), _turret (ARRAY)`.
2424

2525
| Event Key | Parameters | Locality | Type | Description |
26-
|----------|---------|---------|---------|---------|
26+
|---------- |------------|----------|------|-------------|
2727
|`ace_firedPlayer` | [_unit, _weapon, _muzzle, _mode, _ammo, _magazine, _projectile] | Local | Listen | ACE_player fires |
2828
|`ace_firedPlayerNonLocal` | [_unit, _weapon, _muzzle, _mode, _ammo, _magazine, _projectile] | Local | Listen | Any other player fires |
2929
|`ace_firedNonPlayer` | [_unit, _weapon, _muzzle, _mode, _ammo, _magazine, _projectile] | Local | Listen | AI fires |
3030
|`ace_firedPlayerVehicle` | [_vehicle, _weapon, _muzzle, _mode, _ammo, _magazine, _projectile] | Local | Listen | ACE_player turret fires |
3131
|`ace_firedPlayerVehicleNonLocal` | [_vehicle, _weapon, _muzzle, _mode, _ammo, _magazine, _projectile] | Local | Listen | Any other player turret fires |
3232
|`ace_firedNonPlayerVehicle` | [_vehicle, _weapon, _muzzle, _mode, _ammo, _magazine, _projectile] | Local | Listen | AI turret fires |
33-
|`ace_versioning_clientCheckDone` | [[_missingAddonsClient, _additionalAddonsClient, _olderVersionsClient, _newerVersionsClient]] | Local | Listen | When PBO checking has finished on a client |
34-
|`ace_versioning_serverCheckDone` | [[_serverFiles, _serverVersions]] | Local | Listen | When PBO checking has finished on the server |
3533

3634
### 2.2 Medical (`ace_medical`)
3735

3836
| Event Key | Parameters | Locality | Type | Description |
39-
|----------|---------|---------|---------|---------|
37+
|---------- |------------|----------|------|-------------|
4038
|`ace_unconscious` | [_unit, _state(BOOL)] | Global | Listen | Unit's unconscious state changed |
4139
|`ace_placedInBodyBag` | [_target, _bodyBag, _isGrave, _medic] | Global | Listen | Target placed into a bodybag Note: (Target will soon be deleted, target could be a bodybag) |
4240
|`ace_placedInGrave` | [_target, _grave, _medic] | Global | Listen | Target placed into a grave, _grave will be objNull if `Create Grave Markers` is disabled Note: (Target will soon be deleted) |
@@ -51,23 +49,23 @@ The vehicle events will also have the following local variables available `_gunn
5149
MenuType: 0 = Interaction, 1 = Self Interaction
5250

5351
| Event Key | Parameters | Locality | Type | Description |
54-
|----------|---------|---------|---------|---------|
52+
|---------- |------------|----------|------|-------------|
5553
|`ace_interactMenuOpened` | [_menuType] | Local | Listen | Interaction Menu Opened
5654
|`ace_interactMenuClosed` | [_menuType] | Local | Listen | Interaction Menu Closed
5755
|`ace_interact_menu_newControllableObject` | [_typeOf] | Local | Listen | New controlable object, only fires once per type (add self interactions)
5856

5957
### 2.4 Cargo (`ace_cargo`)
6058

6159
| Event Key | Parameters | Locality | Type | Description |
62-
|----------|---------|---------|---------|---------|
60+
|---------- |------------|----------|------|-------------|
6361
|`ace_addCargo` | [_item (CLASSNAME or OBJECT), _vehicle, _cargoCount] | Target | Callable | Scripted way to add cargo to vehicle |
6462
|`ace_cargoLoaded` | [_item, _vehicle] | Global | Listen | Cargo has been Loaded into vehicle |
6563
|`ace_cargoUnloaded` | [_item, _vehicle, _unloadType] | Global | Listen | Cargo has been Unloaded from vehicle |
6664

6765
### 2.5 Captives (`ace_captives`)
6866

6967
| Event Key | Parameters | Locality | Type | Description |
70-
|----------|---------|---------|---------|---------|
68+
|---------- |------------|----------|------|-------------|
7169
|`ace_captiveStatusChanged` | [_unit, _state(BOOL), _reason ("SetHandcuffed" or "SetSurrendered"), _caller] | Global | Listen | Unit's captivity state changed |
7270
|`ace_captives_setSurrendered` | [_unit, _state(BOOL)] | Target | Callable | Sets a unit to either start or stop surrendering |
7371
|`ace_captives_setHandcuffed` | [_unit, _state(BOOL)] | Target | Callable | Sets a unit to either start or stop being handcuffed |
@@ -76,20 +74,20 @@ MenuType: 0 = Interaction, 1 = Self Interaction
7674
### 2.6 Settings (`ace_common`)
7775

7876
| Event Key | Parameters | Locality | Type | Description |
79-
|----------|---------|---------|---------|---------|
77+
|---------- |------------|----------|------|-------------|
8078
|`ace_settingsInitialized` | [] | Local | Listen | All modules are read and settings are ready |
8179
|`ace_settingChanged` | [_name,_value] | Local | Listen | A setting has been changed |
8280

8381
### 2.7 Tagging (`ace_tagging`)
8482

8583
| Event Key | Parameters | Locality | Type | Description |
86-
|----------|---------|---------|---------|---------|
84+
|---------- |------------|----------|------|-------------|
8785
|`ace_tagCreated` | [_tagObject, _texture, _tagAttachedTo (can be null), _unitThatCreated] | Global | Listen | Tag is created |
8886

8987
### 2.8 Explosives (`ace_explosives`)
9088

9189
| Event Key | Parameters | Locality | Type | Description |
92-
|----------|---------|---------|---------|---------|
90+
|---------- |------------|----------|------|-------------|
9391
|`ace_allowDefuse` | [_mine, _allow] | Global or Target | Callable | Set allowance of the dynamic defusal action on a mine |
9492
|`ace_tripflareTriggered` | [_flareObject, _posAGL] | Global | Listen | Tripflare triggered |
9593
|`ace_explosives_clackerAdded` | [_unit, _explosive, _id] | Local | Listen | Clacker added to explosive |
@@ -102,21 +100,21 @@ MenuType: 0 = Interaction, 1 = Self Interaction
102100
### 2.9 Logistics Wirecutter (`ace_logistics`)
103101

104102
| Event Key | Parameters | Locality | Type | Description |
105-
|----------|---------|---------|---------|---------|
103+
|---------- |------------|----------|------|-------------|
106104
|`ace_wireCuttingStarted` | [_unit, _fence] | Global | Listen | Fence cutting started |
107105

108106
### 2.9 Refuel (`ace_refuel`)
109107

110108
| Event Key | Parameters | Locality | Type | Description |
111-
|----------|---------|---------|---------|---------|
109+
|---------- |------------|----------|------|-------------|
112110
|`ace_refuel_started` | [_source, _target, _nozzle, _unit] | Local | Listen | Refuelling has started |
113111
|`ace_refuel_tick` | [_source, _target, _amount, _refuelContainer, _nozzle] | Local | Listen | Amount of fuel transferred in a tick |
114112
|`ace_refuel_stopped` | [_source, _target, _nozzle] | Local | Listen | Refuelling has stopped |
115113

116114
### 2.10 Cook Off (`ace_cookoff`)
117115

118116
| Event Key | Parameters | Locality | Type | Description |
119-
|----------|---------|---------|---------|---------|
117+
|---------- |------------|----------|------|-------------|
120118
|`ace_cookoff_cookOff` | [_vehicle, _intensity, _instigator, _smokeDelayEnabled, _ammoDetonationChance, _detonateAfterCookoff, _fireSource, _canRing, _maxIntensity, _canJet] | Global | Listen | Vehicle cook-off has started |
121119
|`ace_cookoff_cookOffBox` | [_box, _source, _instigator, _delay] | Global | Listen | Ammo box cook-off has started |
122120
|`ace_cookoff_engineFire` | [_vehicle] | Global | Listen | Engine fire has started |
@@ -204,6 +202,13 @@ MenuType: 0 = Interaction, 1 = Self Interaction
204202
| `ace_minedetector_detectorDisabled` | [_unit, _detectorType] | Local | Listen | Called when local unit turned off their mine detector
205203
| `ace_minedetector_mineDetected` | [_unit, _mine, _distance, _detectorType] | Local | Listen | Called when local unit has detected a mine
206204

205+
#### 2.21 PBO checking (`ace_common`)
206+
207+
| Event Key | Parameters | Locality | Type | Description |
208+
|---------- |------------|----------|------|-------------|
209+
|`ace_versioning_clientCheckDone` | [[_missingAddonsClient, _additionalAddonsClient, _olderVersionsClient, _newerVersionsClient]] | Local | Listen | When PBO checking has finished on a client |
210+
|`ace_versioning_serverCheckDone` | [[_serverFiles, _serverVersions]] | Local | Listen | When PBO checking has finished on the server |
211+
207212
## 3. Usage
208213
Also Reference [CBA Events System](https://github.com/CBATeam/CBA_A3/wiki/Custom-Events-System){:target="_blank"} documentation.
209214

‎docs/wiki/framework/medical-framework.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -286,7 +286,8 @@ private _state = profileNamespace getVariable ["MyPlayerMedicalState", ""];
286286
## 6.1 Extending with custom handling
287287

288288
You can save additional data or add custom handling by hooking into the events:
289+
289290
| Event Name | Params | Description |
290291
| ---------- | ------ | ----------- |
291292
| ace_medical_serializeState | Unit, Namespace | Raised locally after ACE Medical's serialization has taken place |
292-
| ace_medical_deserializeState | Unit, Namepsace | Raised locally after ACE Medical's deserialization has taken place |
293+
| ace_medical_deserializeState | Unit, Namespace | Raised locally after ACE Medical's deserialization has taken place |

0 commit comments

Comments
 (0)