Commit Graph

102 Commits

Author SHA1 Message Date
commy2
e289acbb4e
Merge branch 'master' into adv_fatigue_sway_factor 2018-05-19 02:43:11 +02:00
Josuan Albin
704dd66d38 Ace arsenal doc improvement (#6251)
* Add a part of the stats documentation

* Finish documenting stats

It's barebone but it'll do.

* Add EH list to ace arsenal framework doc

* Remove I form in framework doc, capitalize default loadouts

* Add section about importing BI VA loadouts
2018-04-19 14:03:53 -05:00
Brunius
cc503e041b Add pylon whitelist option (#6080)
* Adding pylon whitelist option

* Changing tabs to spaces :(

* Changing to use QGVAR

* Changing name in QGVAR to more clearly reflect function of variable

* Docs for the magazine whitelist function in pylons

* Changes to match style guide

* More docs

* More tabs

* Update pylons-framework.md

* Update pylons-framework.md
2018-01-28 15:38:48 -06:00
xrufix
1b38139009 Fix typos in missile guidance framework wiki page (#5999) 2018-01-01 10:51:59 -06:00
PabstMirror
e4836c9601 Fix Jekyll 2017-12-20 15:09:36 -06:00
ulteq
11926fc9dc Docs - Added ATragMX framework documentation (#5919)
* Docs - Added ATragMX framework documentation
* Explains how to add custom gun list entries via config classes

* Docs - Fixed typos

* Docs - Improved ATragMX framework layout

* Docs - Improved ATragMX Framework description
2017-12-20 14:31:16 -06:00
Josuan Albin
26fddc34a2 Arsenal framework doc (#5892)
* Add first draft of framework doc

* Finish ACE arsenal framework first draft

* Rename framework file

* Add quick start

* Add default loadouts entry

* Add init box warning

* Fix typo and linebreak on the quickstart lines

* Fix some typos in arsenal framework doc

* Capitalize Arsenal, fix minor typos

* Fix more typos, change quickstart

* Add a newline to the single line example

* beautify warnings at the top of the page and quickstart
2017-12-20 14:24:56 -06:00
Tittoffer
82913af107 Rewrite night vision documentation (#5715)
* First draft rewrite nightvision doc.

* Minor phrasing fixes.
2017-12-20 14:21:55 -06:00
ulteq
42cb8cab97 Documentation - Weather module update (#5748)
* First draft

* Shorter Framework description
2017-12-20 14:20:20 -06:00
PabstMirror
b86ef91d7a
Disable cookoff on RCWS turrets (#5605)
* Disable cookoff on RCWS turrets

* getNumber

* Change config name, add doc
2017-11-30 17:07:46 -06:00
Tim Beswick
e85c752ca6 Cook-off probability and cook-off tweaks (#5585)
* Added cookoff probability for vehicles. Tweaks to cookoff to stop total blocking of destruction in some cases.

* Changed var name to probability. Better method for getting config value.

* Fixed naming error

* Changed setting to be a global coefficient. Added some info to cookoff doc

* Reverted hitfuel check

* Reverted damage threshold for cook-off

* Tweaked probability calculation

* Update fnc_handleDamage.sqf
2017-11-30 16:54:47 -06:00
ulteq
040b9bf627 Advanced Ballistics - wiki/framework update 2017-11-23 14:36:36 +01:00
ulteq
5db7be4488
Scopes - wiki/framework update (#5799) 2017-11-22 11:28:54 +01:00
John Lillis
947b89d5aa Update docs and stringtable.xml 2017-11-15 12:22:56 -05:00
PabstMirror
cd30b09b4f Convert ACE_settings to CBA_settings (#4895)
* Convert ACE_settings to CBA_settings

* Run Modules Globaly, BWC for SetSetting

* Add support for string settings

* ACE_ServerSettings warning

* Add handler for global setting being changed

* Add deprecated and replaced not to Settings Framework doc

* Remove options menu UI, Move Debug and HeadBug Fix to Options in Pause Menu

* Change modules scope to 1

* Disable debug
2017-11-11 20:21:55 +01:00
Tittoffer
f1ca76669f Fortify Documentation (#5676)
* Added featurex documentation for fortify.

* Updated to correct version.

* Correct version (3.3.0) 

Not released yet. Will be released in 3.3.0.

* Grammar and phrasing fix.

* Updated dependencies. 

changed dependencies_list to dependenciesx_list. Also switched out components to "acex_fortify".

* Removed acex_ before component.

* Fixed syntax.

* Added fortify-framework.md. Redirect sitting.md from framework to frameworkx.

* Minor syntax fixes to fortify-framework.md and fortify.md. Deleted old sitting-framework.md

* Corrected header numbering.

* Added fortify to dependenciesx_list.md

* Fixed syntax errors. Added func. args. for adding custom presets.

* Minor fix to args.

* Fixed fnc. args.

* Removed public part.

* Removed public part.

* Finalizing fortify-framework.md. Removed outdated note from sitting-framework.md.
2017-10-26 18:22:31 +02:00
commy2
0fe25b3c9c fix wiki suggesting activatedAddon to export addon list 2017-10-26 09:05:30 +02:00
jonpas
914ea66b2f Fix refuel framework page build failure (#5664)
Jekyll thinks {{}} is a variable in code blocks too
2017-10-24 11:14:25 -05:00
Dystopian
1936343428 Fix refuel documentation (#5547)
* Update refuel.md

* Update refuel-framework.md

* Fix refuel-framework.md

* Fix refuel.md

* Add version note

* Fix version note

* Fix hooks
2017-10-24 15:39:32 +02:00
SilentSpike
51a61653f4 Update spectator docs (#5362)
* Add player initilization safety to setSpectator

Public function which should wait for player unit to exist before running.
With this change an additional variable is now set on the player unit which
can be used to check whether players are spectators or not (part of
grander plans).

* Add UI initalization safety to setSpectator

Should make it so that calling the public function before the main display
has initalized will correctly wait until it has before starting spectator

* Overhaul spectator

Initial WIP overhaul of spectator component. Based on BI's End Game
Spectator and AACO's work on POTATO spectate. The essential functionality
is in place, but some things are broken and some are still to be
transferred.

* Remove redundant canInteract condition

Spectator UI will be open anyway so this is pointless.

* Fix follow camera controls

Also ensure unit camera modes have a target more consistently

* Fix widget weapon icon for unarmed

* Fix follow camera zooming

* Fix entity list not updating correctly

* Remove redundant conditions

* Fix list click behaviour

* Remove a bunch of old debug

* Alter behaviour of camera speed

* Restructure the spectator addon

* Fix camera tracking behaviour

* Fix very fast camera toggle

* Fix initial camera mode

* Fix double click behaviour

* Make AI name display consistent

* Add UI toggle

* Fix current camera mode button highlighting

* Fix focus info widget when clicked on in 3D world

* Improve key handling

Use of `inputAction` could result in weirdness when multiple keys pressed
at the same time. Hardcoded for now.

* Implement dynamic help UI element

* Remove some redundant code

* Fix follow camera jitter

* Add projectile drawing

Technically the capability to draw projectiles has been in since the
start. However it took me a bit of time to figure out how best to
add/remove the required event handlers.

I decided to add them during the process of finding things to draw, since
I'm iterating over the list of spectatable entities here anyway. With an
additional GVAR containing up to date entities, the fired EHs can remove
themselves when applicable. This avoids any granularity issues with adding
EHs en masse.

* Improve naming convention related to drawing

* Remove outdated unit and side settings

Also re-add unit whitelisting/blacklisting support

* Rename public function for consistency

Adds a deprecated warning to the old function name.

* Update stringtable

Some entries are replaced with BI translations, others are no longer
needed. I pieced together one of the camera mode settings by combining the
BI translations of the individual versions.

* Add location public functions and list population

Just need to take care of drawing and then camera interaction now

* Add location 2D and 3D drawing

* Respect whitelist and blacklist correctly

* Add location camera focus capability

* Fix local helicopters follow mode bug

* Add compatibility with `counter` template

Simply repositions the counter UI to the top of the screen out of the way

* Update respawn template

This template is only compatible with respawn types 2 & 3

* Rename compatibility function

* Add compatibility for respawn types 1,4 and 5

* Update setCameraAttributes function

* Fix draw3D for respawn types 1,4 and 5

* Fix screeching seagulls #4265

* Fix script command typo

* SQF Linter Pass

* Add obsolete warning for public func params

* Deprecate interrupt function

* Fix incorrect function call

* Make playable virtual spectator work

* Improve focus handling in public function

- User might want to reset focus for free cam, in which case objNull
  cannot be reserved for random
- Focus is still required for unit camera
- Update some function headers

* Note explicitly the use of `player`

* Remove unused base classes

* Improve seagull culling

* Add projectile drawing to vehicles

* Fix same tab selection clearing list

* Make projectile lines last 1 frame longer

* Add true zeus compatibility

- Re-opens spectator when zeus closes
- Transfers the curator module over in the respawn template
- Only handle uiForced in setSpectator to avoid issues with esc key
- Add safety to setFocus so that it only updates the UI when applicable

* Fix player moving in FPP

* Fix zeus transfer and re-opening

* Consolidate icon definitions

* Fix AI setting for player groups

* Improve handling of alive spectators

Instead of disabling simulation, just stage them automatically if alive.

* Fix respawn template for types 2 & 3

* Fix pre-set camera mode with no focus

- Improve handling of UI updates in camera related functions
- More explicit UI initalisation
- Find a focus if one wasn't pre-set for a camera mode which requires a
  focus

* Localise key names

* Fix camera mode and vision settings on init

When spectator starts the available camera modes and vision modes should
be consulted to ensure they are respected upon opening.

* Fix key localisation

* Add next/prev entity keys

* Fix vision modes update while camera active

- Updates the camera vision mode in case the current was removed

* Add public getCameraAttributes function

* Fix spectator zeus compatibility

- Camera control wasn't returned on exit due to change in fnc_ui

* Improve vision mode handling

- Curator now resets vision mode on entry
- First person also reset vision mode so that it is consistent between
  camera changes

* Improve location handling

- It makes more sense to specifiy the position ATL since the text is going
  to be rendered there and a z of 0 is then ground height.
- Updates the ui immediately if the list is already on locations

* Disable list keyboard search

* Fix handling of forced camera mode with no focus

* Fix handling of free mode removal while no target

* Fix locations respecting available modes

* Fix list entry removal code

- Replace getTargetGroups with getTargetEntities for consolidated
  filtering.
- Fix the step of the removal loops and make them go to index 0 instead of
  1

* Improve side handling of unit list

- Accounts for possibly of whitelisted random objects that belong to other
  sides
- Move the index decrement to loop, not within every loop

* Add linter ignore directive

* Fix list code

* Improve entity fetching

- Change whitelist/blacklist application to optimize the code

* Include dead units in the list

- Allow getTargetEntities to return dead units too
- Iterate over allGroups in list updates to reduce overhead

* Take care of TODOs

* Mark stageSpectator as non-public

* Fix updating list focus

* Adjust default camera speed

* Include the function file

* Generalise camera button UI

- Makes it easier to extend with future camera mode buttons
- Removes potential error when display doesn't exist

* Remove obsolete staged event

- Add vision toggle to help
- Restructure some function PREP

* Add public function to return all spectators

* Change default briefing name used on map display

* Fix the order of 4 main sides in list

* Restore non-toggle behaviour of camera speed

* Fix UI gap between list and tabs

* Force update UI list when player is staged

Hopefully this fixes any issues related to the player appearing in the
list

* Update controls strings

* Fix entity tooltips showing short name

- Also revert changes to common function and just handle in this component

* Include dead in unit switching

* Show rank and vehicle icon in list

- Rank is shown in tooltip
- Vehicle icon is used to see which units in the list are mounted

* Change default vehicle icon

* Show whether medic/engineer in tooltip

* Improve list double click behaviour

* Improve group icon handling

* Use dynamic group icons for drawing

* Fix EFUNC call

* Update all function headers

* All the changes I had staged before arma broke git

Arma managed to crash my whole system again, breaking my git repo and I
resorted to nuking it and pasting the changes I had comitted locally back
in. From memory:

- Fix icon paths
- use distanceSqr for minor speed boost
- Add setting to show map locations in the UI
- Limit location rendering based on distance
- Probably some other crap

* Fix squared comparisons

* Remove unnecessary variable publicity

* Deprecate fnc_stageSpectator

The function was a source of confusion alongside fnc_setSpectator and so
it is replaced by an additional parameter to hide the unit as part of
fnc_setSpectator. No longer is the unit moved either, to reduce complexity
and give more control to mission maker.

* Fix undefined variable

* Update spectator framework doc

* Update spectator feature doc

* Fix typos and grammar

* Revent version introduced number

* Update with new changes
2017-10-17 20:19:10 +02:00
PabstMirror
65c5e6e38e Add function to add curator actions (#5620) 2017-10-14 12:01:07 -05:00
Ozan Eğitmen
ca580daedd Cargo: Add removeCargoItem Function (#5432)
* Add removeCargoItem function to cargo module

* Fix documentation typos

* Fix header 'public' field

Of course it's a public function, that's the whole point!

* Fix spelling

* Add missing then command

* Work better with objects

* After-test fixes

* Also update wiki

* Overhaul

* Make the event more robust

* Fix logic & shorten docs
2017-09-16 11:21:23 -05:00
Dystopian
559a498e6d Add fast mouse actions to refuel, add refuel eden attributes (#5418)
* Add fast mouse actions to refuel

* nobody seen that

* Add interaction condition and refuel on ladder

* Add car hit, fix change weapon on uncon

* Replace objNull with nil in setVar, unify var names

* Delete *ConnectNozzle functions

* Delete reset* functions

* Add public function and eden attributes

* Remove static actions from RHS compat

* Remove statusEffect_set on respawn

* Fix dual menu, add deprecating message

* Optimize fnc_takeNozzle

* Cleanup
2017-09-10 14:43:03 -05:00
BaerMitUmlaut
eacca05fda Fix GVARs in explosives wiki (#5416)
* Fixed GVARs in explosives wiki

* Standardize double spaced comments
2017-08-26 11:37:31 -05:00
PabstMirror
26ebc16e3f Map wiki fix (#5446) 2017-08-22 20:33:26 +02:00
PabstMirror
e7ebbd5750 Customized map lighting for vehicle interiors (#5401)
* Customized map lighting for vehicle interiors

* Tabs for cases

* Add wiki for new configs

* V
2017-08-22 13:13:03 -05:00
SilentSpike
292844690a Add Pentolite Gurney constant to wiki (#5413)
Hard to find a reference for this, but figure it is useful to others as it's fairly common in older HEAT shells (WW2 stuff is why this even came to my attention) and modern fast-acting explosives.

It's a bit of an approximation as I had to interpolate the value of the first reference so that it was correct relative to the other values on our wiki (by using two other explosives common to both tables). The second reference in fps converts to roughly the same value in m/s so I'm content to call it good.

References:
http://axpro.mines.edu/documents/MNGN%20444_Fragmentation%20and%20Safety%20Distances%20_Examples.pdf, p.3
http://dtic.mil/dtic/tr/fulltext/u2/783941.pdf, p.25
2017-08-09 11:34:35 +01:00
Wakbub
fd48c7fba9 Update the Wiki for the Settings Framework (#5363)
* Update settings-framework.md

Modifications and extensions.

* Update settings-framework.md

Replacement of the bulleted list with a numbered list, as the steps are in chronological order. Removal of superfluous text.
2017-07-19 21:01:25 +02:00
SilentSpike
08d8cf71d7 Update cargo docs with new public functions (#5266)
* Update cargo docs with new public functions
* Add myself to squad.xml
2017-06-10 17:34:42 +01:00
Phyma
48b9a61497 Fix Large IED defuse distance (#5261)
* Fix for large-ied bug because underwater thing have changed

* Added size of IED in config and determine defuse range

* Added typo

* Added help text to wiki about defusing

* Better English

* Increased the defusal range on large bombs make it similar to small ieds

* Add wiki doc
2017-06-09 12:52:55 -05:00
PabstMirror
9c3cca3c56 Add repair feature to wiki (#5247)
* Add repair feature to wiki

* Add blank lines, use adv engineer

* Add repair framework page
2017-06-09 09:11:00 -05:00
PabstMirror
847832c118 Fix some event names on wiki (#5254)
* Fix some event names on wiki

* Switch callable events to functions
2017-06-08 14:31:27 -05:00
PabstMirror
f35f80ee82 Rearm - Pylon Support and Dynamically Add Supply Actions (#5183)
* Dynamic Add

* Support 1.70 Pylon Loadouts

* Properly handle old compat pbos - Update RHS Compat

* Re-add documentation

* cleanup headers (note from other pr)

* Cleanup

* Fix var spelling
2017-06-08 11:47:52 -05:00
PabstMirror
08217f460e Explosives - Add code handler for detonation (#5115)
* Explosives - Add code handler for detonation

* Add info to wiki

* Fix cellphone in demo code, move example to wiki
2017-05-10 11:28:44 -05:00
jonpas
1590948b92 Fix multiple slideshows sub-actions, Add set name setting (#4904)
* Fix all slides being in multiple slideshows setup, Use private keyword

* Add setting for slides main interaction name

* Update Slideshow documentation

* Add not about new argument added in version
2017-02-24 14:08:18 +01:00
nomisum
59ca44bb4b [typofix] explosion -> explosive (#4816) 2017-01-11 17:35:35 -06:00
Glowbal
30f492d704 Add module documentation (#4297) 2016-11-25 00:11:27 +01:00
ulteq
db3b5d924c Scopes - Updated wiki framework (#4680)
* Update scopes-framework.md

Documented the changes to the scopes framework in this pull request: https://github.com/acemod/ACE3/pull/4642

* Clarified the bore height component descriptions
2016-11-16 11:20:07 +01:00
BaerMitUmlaut
ddb449cdbb Merge pull request #4401 from acemod/advanced-fatigue-doc
Advanced Fatigue documentation
2016-09-19 21:18:58 +02:00
Glowbal
5134c16dd0 Add cookoff documentation 2016-09-17 12:15:08 +02:00
PabstMirror
a93aad10a0 Fix speeling 2016-09-14 20:00:18 -05:00
BaerMitUmlaut
15bed8e122 Added advanced fatigue documentation 2016-09-15 02:25:32 +02:00
jonpas
65df821e2b Add wiki ACEX sections and merge Mission Makers and Framework sections (#4307)
* Update documentation guidelines

* Add version info part 1

* Add version info part 2

* Add removed in version to frontmatter and tag testmissions as removed

* Add version info part 3

* Seaparate ACE3 and ACEX Features/Framework menus, Add ACEX Headless documentation

* Add ACEX support to extract_dependencies.py

* Merge useful-functions into frameworks

* Move class-names to main menu

* Prettify class-names table titles

* Fix table of contents on documentation guidelines and tips

* Merge mission-tools into frameworks

* Merge modules into frameworks

* Rename to Frameworks (plural)

* Fix capitalization in class-names

* Improve wiki menu positioning

* Add 'mod' to documentation guidelines

* Update frameworks sections description for new content

* Update wiki menu descriptions

* Fix class-names 4 digit versions

* More places for descriptions

* Include documentation in PRs if applicable note

* Add short ACE3 and ACEX description page, outlining the difference
2016-09-08 21:19:07 +02:00
jonpas
1df3a73461 Add version information to most wiki feature and framework pages (#4303)
* Update documentation guidelines

* Add version info part 1

* Add version info part 2

* Add removed in version to frontmatter and tag testmissions as removed

* Add version info part 3
2016-08-30 15:49:04 +02:00
jonpas
fc7d6b50f6 Add Tagging documentation (new location) (#4260)
* Add Tagging documentation (new location)

* Add version information
2016-08-27 15:19:14 +02:00
PabstMirror
df7aa38a7a Allow inheritance for addActionToClass (#4272)
* Allow inheritance for addActionToClass

* Update Headers

* Use inline code for inheritance example
2016-08-27 10:35:21 +02:00
Glowbal
ee307c405b Add note about no settings class for serverconfig 2016-08-24 19:48:26 +02:00
jonpas
9599ab9bd9 Streamline closing points on wiki pages (#4269) 2016-08-19 15:47:03 +02:00
jonpas
9415d0fb03 Fix Events Framework documentation 3.1 section (#4266)
* Fix 3.1. section, Add dots after numbers, Update CBA doc with target _blank

* Fix closing points
2016-08-19 15:44:30 +02:00
jonpas
3884821eb1 Fix list in interaction menu framework documentation 2016-08-19 00:57:19 +02:00
jonpas
58bf3c4719 Remove never-merged rearm feature and framework documentation 2016-08-18 21:01:44 +02:00
bux578
accd408418 merge gh-pages content into docs folder
https://github.com/blog/2228-simpler-github-pages-publishing
2016-08-18 18:37:38 +02:00