mirror of
https://github.com/acemod/ACE3.git
synced 2024-08-30 18:23:18 +00:00
copy documentation style updates from gh-pages
This commit is contained in:
parent
83304a0622
commit
cb88469da8
@ -7,6 +7,8 @@ order: 2
|
||||
---
|
||||
|
||||
## 1. CfgVehicles
|
||||
Entries from found in the `CfgVehicles.hpp` files
|
||||
|
||||
|
||||
```c++
|
||||
ace_nightvision_grain
|
||||
@ -24,6 +26,8 @@ ace_offset
|
||||
|
||||
|
||||
## 2. CfgWeapons
|
||||
Entries from found in the `CfgWeapons.hpp` files
|
||||
|
||||
|
||||
```c++
|
||||
ace_recoil_shakemultiplier
|
||||
@ -61,6 +65,7 @@ ace_modedescription
|
||||
|
||||
|
||||
## 3. CfgAmmo
|
||||
Entries from found in the `CfgAmmo.hpp` files
|
||||
|
||||
```c++
|
||||
ace_recoil_shakemultiplier
|
||||
@ -89,6 +94,7 @@ ace_barrellengths
|
||||
|
||||
|
||||
## 4. CfgGlasses
|
||||
Entries from found in the `CfgGlasses.hpp` file
|
||||
|
||||
```c++
|
||||
ace_color
|
||||
@ -103,6 +109,7 @@ ace_dustpath
|
||||
|
||||
|
||||
## 5. CfgMagazines
|
||||
Entries from found in the `CfgMagazines.hpp` files
|
||||
|
||||
```c++
|
||||
ace_isbelt
|
||||
|
@ -14,11 +14,13 @@ A single rendered frame of Arma 3.
|
||||
### 1.2 Scheduled Space
|
||||
|
||||
This refers to execution would is ruled by the Arma 3 default script scheduling engine. This would include:
|
||||
|
||||
* spawn
|
||||
* execVM
|
||||
|
||||
### 1.3 Unscheduled Space
|
||||
This refers to execution which is linear; what this means is that the code will run to completion prior to executing the current frame. It must complete, but is guaranteed to run within a given frame.
|
||||
|
||||
* perFrameHandler
|
||||
* Extended_EventHandlers
|
||||
* addEventHandler
|
||||
@ -43,7 +45,6 @@ Because we are attempting to always run to completion; execution occurs from 2 p
|
||||
Rules of thumb for component design:
|
||||
|
||||
* If you need to wait for a value, don't wait, use a CBA event! This means everything should be designed and written with an event-driven model in mind.
|
||||
|
||||
* If you have to wait, use a PFH delay/diag_tickTime check.
|
||||
|
||||
|
||||
@ -58,7 +59,7 @@ Line Notes:
|
||||
### 3.2 ACE3 General Rules
|
||||
|
||||
* Always use call whenever possible. We should be calling functions chains exclusive and not be relying on spawn/execVM ever. Consider spawn/execVM banned without good reason. All code should be a chain of execution which is traceable, and not triggered between seperate threads.
|
||||
* waitUntil and sleep are banned. If you need to use them, use scheduled delay execution instead. **Reasoning** *Sleep/waituntil surrender about 5x the scheduler time than even normal execution does. *
|
||||
* waitUntil and sleep are banned. If you need to use them, use scheduled delay execution instead. **Reasoning: Sleep/waitUntil surrender about 5x the scheduler time than even normal execution does.**
|
||||
* If we need a spawn or exec, we should utilize the perFrame scheduler. Spawn/execVM are subject to the Arma 3 scheduler and as such, cannot be relied upon. In order to give our players a consistent gameplay experience, we need to have total control over how and when all of our code runs.
|
||||
* PFH should be utilized at all possible times when the player can see the result of whatever the code is. This applies to missile guidance, bullets, wind, optics, interactive UI, HUD's, and rendering. We should only consider scheduled execution if the code is running out of the visual range of the player.
|
||||
|
||||
|
@ -354,7 +354,9 @@ Defines the radius around the player (in meters) at which projectiles are wind d
|
||||
*Part of: ace_core*
|
||||
|
||||
And then there's the "LSD Vehicles" module … it does 'something' to all vehicles synced to that module.
|
||||
<iframe width="560" height="315" src="https://www.youtube.com/embed/X3e0LTexEok" frameborder="0" allowfullscreen></iframe>
|
||||
<div class="videoWrapper">
|
||||
<iframe src="https://www.youtube.com/embed/X3e0LTexEok" frameborder="0" allowfullscreen></iframe>
|
||||
</div>
|
||||
|
||||
## 2. ACE Medical
|
||||
*Part of: ace_medical*
|
||||
@ -520,4 +522,4 @@ Follow players. If set to false, loop will play sounds only nearby logic positio
|
||||
`Default value: No`
|
||||
6. **Volume (Number)**<br>
|
||||
The volume of the sounds played<br>
|
||||
`Default value: 1`
|
||||
`Default value: 1`
|
||||
|
Loading…
x
Reference in New Issue
Block a user