mirror of
https://github.com/acemod/ACE3.git
synced 2024-08-30 18:23:18 +00:00
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.
This commit is contained in:
parent
f3d6a54ccf
commit
f1ca76669f
@ -1,3 +1,7 @@
|
||||
{% if include.component == "fortify" %}
|
||||
`acex_main`, `ace_interaction`
|
||||
{% endif %}
|
||||
|
||||
{% if include.component == "headless" %}
|
||||
`acex_main`
|
||||
{% endif %}
|
||||
@ -9,4 +13,3 @@
|
||||
{% if include.component == "viewrestriction" %}
|
||||
`acex_main`
|
||||
{% endif %}
|
||||
|
||||
|
41
docs/wiki/featurex/fortify.md
Normal file
41
docs/wiki/featurex/fortify.md
Normal file
@ -0,0 +1,41 @@
|
||||
---
|
||||
layout: wiki
|
||||
title: fortify
|
||||
description: Enables player to build fortifications.
|
||||
group: feature
|
||||
category: interaction
|
||||
parent: wiki
|
||||
mod: acex
|
||||
version:
|
||||
major: 3
|
||||
minor: 3
|
||||
patch: 0
|
||||
---
|
||||
|
||||
## 1. Overview
|
||||
|
||||
Enable players to place down fortifications. Budget enables mission makers / admin to restrict the amount of resources available.
|
||||
|
||||
## 2. Usage
|
||||
|
||||
Please note that to use this function the Fortify module needs to be placed down and `Fortify Tool` equipped by player.
|
||||
|
||||
### 2.1 Placing fortification
|
||||
|
||||
- Open self-interaction menu with <kbd>Ctrl</kbd> + <kbd>⊞ Win</kbd> (ACE3 default).
|
||||
- Select `Equipment` -> `Fortify`.
|
||||
- Choose your fortification object and follow the instructions on the screen.
|
||||
|
||||
### 2.1 Removing fortification
|
||||
|
||||
- Use interaction <kbd>⊞ Win</kbd> on object.
|
||||
|
||||
## 3. Tips
|
||||
|
||||
- Using <kbd>Alt</kbd> / <kbd>Ctrl</kbd> / <kbd>Shift</kbd> + <kbd>Scroll Wheel</kbd> you can rotate object on different axis.
|
||||
- You can use planks to get up on rooftops.
|
||||
- Holding <kbd>Ctrl</kbd> while placing allows for placing multiple objects of the same type.
|
||||
|
||||
## 4. Dependencies
|
||||
|
||||
{% include dependenciesx_list.md component="fortify" %}
|
66
docs/wiki/frameworkx/fortify-framework.md
Normal file
66
docs/wiki/frameworkx/fortify-framework.md
Normal file
@ -0,0 +1,66 @@
|
||||
---
|
||||
layout: wiki
|
||||
title: Fortify Framework
|
||||
description: Explains how to set-up the Fortify component.
|
||||
group: framework
|
||||
order: 6
|
||||
parent: wiki
|
||||
mod: acex
|
||||
version:
|
||||
major: 3
|
||||
minor: 3
|
||||
patch: 0
|
||||
---
|
||||
|
||||
## 1. Overview
|
||||
|
||||
The Fortify framework allows server admins or mission makers to give players the ability to place fortifications through self-interaction, using the `Fortify Tool`.
|
||||
|
||||
|
||||
### 1.1 Chat commands
|
||||
|
||||
If the Fortify module is present in the mission, server admins can use chat commands to set-up or change the different parameters. Useful to give players additional resources based on progress on the mission for example.
|
||||
|
||||
- `#ace-fortify on` turns fortify mode on
|
||||
- `#ace-fortify off` turns fortify mode off
|
||||
- `#ace-fortify west small 500` registers the "small" preset for the west side with a budget of 500
|
||||
- `#ace-fortify west medium` registers the "medium" preset for the west side with no budget
|
||||
- `#ace-fortify o big` registers the "big" preset for the east side with no budget
|
||||
|
||||
## 1.2 Adding custom presets
|
||||
|
||||
There are two ways of adding custom presets to your mission, either via code or through desciption.ext.
|
||||
|
||||
To add a preset via code you use the function `call acex_fortify_fnc_registerObjects`. Also enables Fortify.
|
||||
|
||||
```
|
||||
* Registers the given objects in the given side's player interaction menu.
|
||||
* Players on that side must have the `Fortify Tool` item in their inventory to access the menu.
|
||||
* Classnames must be in the format [<classname>, <cost>]
|
||||
* MUST BE CALLED ON SERVER!
|
||||
*
|
||||
* Arguments:
|
||||
* 0: Side <SIDE>
|
||||
* 1: Budget <NUMBER>
|
||||
* 2: Object Classnames <ARRAY>
|
||||
*
|
||||
* Return Value:
|
||||
* None
|
||||
*
|
||||
* Example:
|
||||
* [west, 5000, [["Sandbag", 5], ["Bunker", 50]]] call acex_fortify_fnc_registerObjects
|
||||
```
|
||||
|
||||
Adding it through `description.ext` you use:
|
||||
|
||||
```c++
|
||||
class ACEX_Fortify_Presets {
|
||||
class myMissionObjects {
|
||||
objects[] = {
|
||||
{"Sandbag", 5},
|
||||
{"Bunker", 50}
|
||||
};
|
||||
};
|
||||
```
|
||||
|
||||
Then you will have to set the mission preset to `myMissionObjects` with `#fortify blufor myMissionObjects` to enable it.
|
@ -10,12 +10,11 @@ version:
|
||||
major: 3
|
||||
minor: 2
|
||||
patch: 0
|
||||
redirect_from: "/wiki/framework/sitting-framework.md"
|
||||
---
|
||||
|
||||
<div class="panel callout">
|
||||
<h5>Note:</h5>
|
||||
<p>ACE3 Sitting has been deprecated in favour of ACEX Sitting and will be removed in a future version.</p>
|
||||
</div>
|
||||
_Sitting has been moved from ACE3 (in v3.8.0) to ACEX._
|
||||
|
||||
|
||||
## 1. Requirements
|
||||
|
Loading…
Reference in New Issue
Block a user