Skip to content

Commit

Permalink
Documentation - Update for v2.8.0
Browse files Browse the repository at this point in the history
  • Loading branch information
jonpas committed Sep 17, 2020
1 parent 0566a42 commit 02748c8
Show file tree
Hide file tree
Showing 3 changed files with 163 additions and 4 deletions.
163 changes: 163 additions & 0 deletions docs/_includes/custom/functions-list-api.html
Original file line number Diff line number Diff line change
Expand Up @@ -796,6 +796,85 @@
```


---

### acre_api_fnc_addNotificationDisplay
__Description__

Adds notification system support to given display ID (IDD).

__Parameters__

Index | Description | Datatype(s) | Default Value
--- | --- | --- | ---
0 | Display ID | NUMBER |

__Return Value__

Description | Datatype(s)
--- | ---
Display priority index | NUMBER

__Example__

```sqf
[3333] call acre_api_fnc_addNotificationDisplay
```


---

### acre_api_fnc_godModeGetGroupTargets
__Description__

Returns given group's current targets.

__Parameters__

Index | Description | Datatype(s) | Default Value
--- | --- | --- | ---
1 | Group (0-based index or -1 for current channel) | NUMBER | 0

__Return Value__

Description | Datatype(s)
--- | ---
Group targets | ARRAY

__Example__

```sqf
[0] call acre_api_fnc_godModeGetGroupTargets
```


---

### acre_api_fnc_godModeConfigureAccess
__Description__

Configures the access to God Mode.

__Parameters__

Index | Description | Datatype(s) | Default Value
--- | --- | --- | ---
0 | Access to the BI Chat Channel functionality | BOOL | false
1 | Access to Group presets functionality | BOOL | false

__Return Value__

Description | Datatype(s)
--- | ---
Handled | BOOL

__Example__

```sqf
[true, false] call acre_api_fnc_godModeConfigureAccess
```


---

### acre_api_fnc_getRadioSpatial
Expand Down Expand Up @@ -1689,6 +1768,33 @@
```


---

### acre_api_fnc_godModeNameGroup
__Description__

Sets a visible name for the given God Mode group.

__Parameters__

Index | Description | Datatype(s) | Default Value
--- | --- | --- | ---
0 | Name | STRING |
1 | Group to effect (0-based index) | NUMBER | 0

__Return Value__

Description | Datatype(s)
--- | ---
Group name set successfully | BOOL

__Example__

```sqf
["Admin", 0] call acre_api_fnc_godModeNameGroup
```


---

### acre_api_fnc_isSpeaking
Expand Down Expand Up @@ -1767,6 +1873,33 @@
```


---

### acre_api_fnc_godModeSendText
__Description__

Sends a text message to the specified God Mode group.

__Parameters__

Index | Description | Datatype(s) | Default Value
--- | --- | --- | ---
0 | Text | STRING | ""
1 | Group ID (0-based index) | NUMBER | 0

__Return Value__

Description | Datatype(s)
--- | ---
Text message sent successfully | BOOL

__Example__

```sqf
["sample text", 2] call acre_api_fnc_godModeSendText
```


---

### acre_api_fnc_babelGetLanguageName
Expand Down Expand Up @@ -1820,6 +1953,36 @@
```


---

### acre_api_fnc_godModeModifyGroup
__Description__

Modifies who can hear a message from God Mode.

__Parameters__

Index | Description | Datatype(s) | Default Value
--- | --- | --- | ---
0 | Unit or UID or array of either or code returning array of units | OBJECT, STRING, ARRAY, CODE | []
1 | Group to effect (0-based index) | NUMBER | 0
2 | Action. 0 for set, 1 for add and 2 for subtract | NUMBER | 0

__Return Value__

Description | Datatype(s)
--- | ---
Group modified successfully | BOOL

__Example__

```sqf
[[unit1, unit2], 0, 1] call acre_api_fnc_godModeModifyGroup
[["76561198040512062", "76561198046921073"], 0, 1] call acre_api_fnc_godModeModifyGroup
[{allUnits select {alive _x}}, 0, 1] call acre_api_fnc_godModeModifyGroup
```


---

### acre_api_fnc_setGlobalVolume
Expand Down
2 changes: 0 additions & 2 deletions docs/wiki/frameworks/god-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
title: God Mode
---

{% include important.html content="Dev-build only" %}

All [God Mode](/wiki/user/god-mode) configuration only applies to the local machine. This allows great flexibility in configuration and different group presets for each player.

## Access
Expand Down
2 changes: 0 additions & 2 deletions docs/wiki/user/god-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
title: God Mode
---

{% include important.html content="Dev-build only" %}

ACRE2 offers the possibility of sending voice and text messages to groups of players without attenuation effects. This functionality is known as God Mode and consists of:

- Integration with Arma 3 Chat Channel: when pressing the corresponding Push-To-Talk (PTT), a voice message is going to be sent to those players matching the criteria of the current chat channel. _Note: Custom chat channels are not supported. Custom, Direct and Command all behave same as Global.
Expand Down

0 comments on commit 02748c8

Please sign in to comment.