Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix some event names on wiki #5254

Merged
merged 2 commits into from
Jun 8, 2017
Merged

Fix some event names on wiki #5254

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
402efbd
Fix some event names on wiki
PabstMirror Jun 6, 2017
1c593de
Switch callable events to functions
PabstMirror Jun 8, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions docs/wiki/framework/cargo-framework.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,19 +46,18 @@ class staticBananaLauncher {

### 2.1 Listenable

Event Name | Description | Passed Parameter(s) | Locality
Event Name | Passed Parameter(s) | Locality | Description
---------- | ----------- | ------------------- | --------
`cargoLoaded` | Cargo has been loaded | ` [_item, _vehicle]` | Global
`cargoUnloaded` | Cargo has been unloaded | `[_item, _vehicle]` | Global
`cargoAddedByClass` | Cargo items have been added | `[_itemClass, _vehicle, _amount]` | Global
`ace_cargoLoaded` | [_item, _vehicle] | Global | Cargo has been Loaded into vehicle
`ace_cargoUnloaded` | [_item, _vehicle] | Global | Cargo has been Unloaded from vehicle

### 2.2 Callable

Event Name | Description | Passed Parameter(s) | Locality
Event Name | Passed Parameter(s) | Locality | Description
---------- | ----------- | ------------------- | --------
`LoadCargo` | Load object into vehicle. | `[_object, _vehicle, _showHint]` | Local
`UnloadCargo` | Unload object from vehicle. | `[_object, _vehicle]` | Local
`AddCargoByClass` | Adds a cargo item to the vehicle. | `[_itemClass, _vehicle, _amount, _showHint]` | Local
`ace_addCargo` | [_item (CLASSNAME or OBJECT), _vehicle, _cargoCount] | Target | Scripted way to add cargo to vehicle
`ace_loadCargo` | `[_object, _vehicle, _showHint]` | Target | Load object into vehicle.
`ace_unloadCargo` | `[_object, _vehicle]` | Target | Unload object from vehicle.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd really say get rid of those "Callable" events, we should promote public functions instead (I wrote this back when I wasn't totally sure what I was doing :P).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with this, I think events should only be publicly listenable and public functions should take care of calling things where appropriate



## 3. Scripting
Expand Down
4 changes: 2 additions & 2 deletions docs/wiki/framework/goggles-framework.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,5 @@ class CfgGlasses {

Event Name | Description | Passed Parameter(s) | Locality
---------- | ----------- | ------------------- | --------
`GlassesChanged` | Glasses Changed | `[_glassesClass]` | Local
`GlassesCracked` | Glasses Cracked | `[_unit]` | Local
`ace_glassesChanged` | Glasses Changed | `[_unit, _glassesClass]` | Local
`ace_glassesCracked` | Glasses Cracked | `[_unit]` | Local
2 changes: 1 addition & 1 deletion docs/wiki/framework/overpressure-framework.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ class CfgWeapons {

Event Name | Description | Passed Parameter(s) | Locality
---------- | ----------- | ------------------- | --------
`overpressure` | Overpressure damage inflicted | `[_firer, _position, _direction, _weapon]` | Target
`ace_overpressure` | Overpressure damage inflicted | `[_firer, _posASL, _direction, _weapon, _magazine, _ammo]` | Target
2 changes: 1 addition & 1 deletion docs/wiki/framework/reloadlaunchers-framework.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ class CfgWeapons {

Event Name | Description | Passed Parameter(s) | Locality
---------- | ----------- | ------------------- | --------
`reloadLauncher` | Launcher reloaded | `[_unit, _target, _weapon, _magazine]` | Target
`ace_reloadlaunchers_reloadLauncher` | Launcher reloaded | `[_unit, _target, _weapon, _magazine]` | Target