Arma3_Epoch/ACE3
1
0
Fork 0
mirror of https://github.com/acemod/ACE3.git synced 2024-08-30 18:23:18 +00:00
Code Issues Packages Projects Releases Wiki Activity
261cd42202
ACE3/documentation/feature/safemode.md

24 lines
530 B
Markdown
Raw Normal View History

Create missing documentation placeholders Creates placeholder documentation for modules which did not previously have any. If a module had the same name and apparent purpose as a module from AGM, AGM's documentation was imported into the placeholder. These documentation are useful to users for explaining what ACE3 changes. They are also useful to community admins who want to create a custom distribution of ACE3 and need to know which modules to disable. The documentation needs to be significantly fleshed out before it's ready for public consumption, but this should be a helpful start.
2015-05-13 00:28:18 +00:00
---
layout: wiki
title: Safe Mode
Documentation pass 5 - Documentation done except (medical, AtragMX, MicroDAGR, Vector, Kestrel 4500) - Typos fixed - enjoy the review MOWHAHAHAHAH.
2015-05-28 15:22:45 +00:00
description: Introduce safe mode
Create missing documentation placeholders Creates placeholder documentation for modules which did not previously have any. If a module had the same name and apparent purpose as a module from AGM, AGM's documentation was imported into the placeholder. These documentation are useful to users for explaining what ACE3 changes. They are also useful to community admins who want to create a custom distribution of ACE3 and need to know which modules to disable. The documentation needs to be significantly fleshed out before it's ready for public consumption, but this should be a helpful start.
2015-05-13 00:28:18 +00:00
group: feature
add categories to feature docs
2015-07-29 17:11:50 +00:00
category: equipment
Create missing documentation placeholders Creates placeholder documentation for modules which did not previously have any. If a module had the same name and apparent purpose as a module from AGM, AGM's documentation was imported into the placeholder. These documentation are useful to users for explaining what ACE3 changes. They are also useful to community admins who want to create a custom distribution of ACE3 and need to know which modules to disable. The documentation needs to be significantly fleshed out before it's ready for public consumption, but this should be a helpful start.
2015-05-13 00:28:18 +00:00
parent: wiki
---
Insert additional newlines
2015-05-14 14:02:01 +00:00
Documentation pass 5 - Documentation done except (medical, AtragMX, MicroDAGR, Vector, Kestrel 4500) - Typos fixed - enjoy the review MOWHAHAHAHAH.
2015-05-28 15:22:45 +00:00
## 1. Overview
Insert additional newlines
2015-05-14 14:02:01 +00:00
Documentation pass 5 - Documentation done except (medical, AtragMX, MicroDAGR, Vector, Kestrel 4500) - Typos fixed - enjoy the review MOWHAHAHAHAH.
2015-05-28 15:22:45 +00:00
### 1.1 Safety
Create missing documentation placeholders Creates placeholder documentation for modules which did not previously have any. If a module had the same name and apparent purpose as a module from AGM, AGM's documentation was imported into the placeholder. These documentation are useful to users for explaining what ACE3 changes. They are also useful to community admins who want to create a custom distribution of ACE3 and need to know which modules to disable. The documentation needs to be significantly fleshed out before it's ready for public consumption, but this should be a helpful start.
2015-05-13 00:28:18 +00:00
You can now use the safety mode of any weapon. Switching weapon modes takes the safety off.
Documentation pass 5 - Documentation done except (medical, AtragMX, MicroDAGR, Vector, Kestrel 4500) - Typos fixed - enjoy the review MOWHAHAHAHAH.
2015-05-28 15:22:45 +00:00
## 2. Usage
Insert additional newlines
2015-05-14 14:02:01 +00:00
Documentation pass 5 - Documentation done except (medical, AtragMX, MicroDAGR, Vector, Kestrel 4500) - Typos fixed - enjoy the review MOWHAHAHAHAH.
2015-05-28 15:22:45 +00:00
### 2.1 Switching safety on / off
Documentation pass 8 - Finished: MicroDAGR doc, note that the images can't be viewed properly on GitHub. - Coding guidelines are more readable now, added the STRING family of macros to it. - How to enable dragging / carrying added to dragging / carrying framework with a BIG disclaimer that the functions are not public and may change. - Shortcut updated to fit the convention established in the shortcut page.
2015-06-30 14:04:00 +00:00
- To turn it on press <kbd>Ctrl</kbd> + <kbd>`</kbd> (QWERTY layout) (ACE3 default key bind `Safe Mode`).
- To turn it off press <kbd>Ctrl</kbd> + <kbd>`</kbd> (QWERTY layout) again or switch firing mode.
Insert additional newlines
2015-05-14 14:02:01 +00:00
Documentation pass 5 - Documentation done except (medical, AtragMX, MicroDAGR, Vector, Kestrel 4500) - Typos fixed - enjoy the review MOWHAHAHAHAH.
2015-05-28 15:22:45 +00:00
## 3. Dependencies
Insert additional newlines
2015-05-14 14:02:01 +00:00
Document module dependencies Add a list of dependencies to each module's documentation. Also add a note to the documenation of modules which are a dependency for many other modules. Dependency lists are pulled from each module's config.cpp.
2015-05-13 19:31:53 +00:00
`ace_common`
Reference in New Issue Copy Permalink