Skip to content

Commit

Permalink
Generated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Apr 12, 2024
1 parent 4397bc5 commit 4ffb7f1
Show file tree
Hide file tree
Showing 5 changed files with 200 additions and 22 deletions.
2 changes: 1 addition & 1 deletion Documentation/API/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Count modules: 49
- [Gender](host//Gender.md) - 1 files
- [GURPS](host//GURPS.md) - 3 files
- [Logger](host//Logger.md) - 1 files
- [MapManager](host//MapManager.md) - 11 files
- [MapManager](host//MapManager.md) - 12 files
- [MatterSystem](host//MatterSystem.md) - 11 files
- [Medals](host//Medals.md) - 3 files
- [Namings](host//Namings.md) - 7 files
Expand Down
156 changes: 150 additions & 6 deletions Documentation/API/client/LightEngine.md
Original file line number Diff line number Diff line change
Expand Up @@ -1620,6 +1620,78 @@ Replaced value:
2105
```
File: [client\LightEngine\ScriptedEffects.hpp at line 11](../../../Src/client/LightEngine/ScriptedEffects.hpp#L11)
## SLIGHT_WEAK_FIRE

Type: constant

Description:


Replaced value:
```sqf
2106
```
File: [client\LightEngine\ScriptedEffects.hpp at line 12](../../../Src/client/LightEngine/ScriptedEffects.hpp#L12)
## SLIGHT_SPOT_LAMP

Type: constant

Description:


Replaced value:
```sqf
2107
```
File: [client\LightEngine\ScriptedEffects.hpp at line 13](../../../Src/client/LightEngine/ScriptedEffects.hpp#L13)
## SLIGHT_LAMP_HOUSE

Type: constant

Description:


Replaced value:
```sqf
2108
```
File: [client\LightEngine\ScriptedEffects.hpp at line 14](../../../Src/client/LightEngine/ScriptedEffects.hpp#L14)
## SLIGHT_LIGHT_STOVE

Type: constant

Description:


Replaced value:
```sqf
2109
```
File: [client\LightEngine\ScriptedEffects.hpp at line 15](../../../Src/client/LightEngine/ScriptedEffects.hpp#L15)
## SLIGHT_LIGHT_BAKE

Type: constant

Description:


Replaced value:
```sqf
2110
```
File: [client\LightEngine\ScriptedEffects.hpp at line 16](../../../Src/client/LightEngine/ScriptedEffects.hpp#L16)
## SLIGHT_STREET_LAMP_DORM

Type: constant

Description:


Replaced value:
```sqf
2111
```
File: [client\LightEngine\ScriptedEffects.hpp at line 17](../../../Src/client/LightEngine/ScriptedEffects.hpp#L17)
## SLIGHT_MAGICSTORM_DEBUG_var

Type: Variable
Expand All @@ -1633,7 +1705,7 @@ Initial value:
```sqf
2100
```
File: [client\LightEngine\ScriptedEffects.hpp at line 15](../../../Src/client/LightEngine/ScriptedEffects.hpp#L15)
File: [client\LightEngine\ScriptedEffects.hpp at line 21](../../../Src/client/LightEngine/ScriptedEffects.hpp#L21)
## SLIGHT_SET123_DEBUG_var

Type: Variable
Expand All @@ -1645,7 +1717,7 @@ Initial value:
```sqf
2101
```
File: [client\LightEngine\ScriptedEffects.hpp at line 16](../../../Src/client/LightEngine/ScriptedEffects.hpp#L16)
File: [client\LightEngine\ScriptedEffects.hpp at line 22](../../../Src/client/LightEngine/ScriptedEffects.hpp#L22)
## SLIGHT_TEMPLATE_DIRECTLIGHT_var

Type: Variable
Expand All @@ -1657,7 +1729,7 @@ Initial value:
```sqf
2102
```
File: [client\LightEngine\ScriptedEffects.hpp at line 17](../../../Src/client/LightEngine/ScriptedEffects.hpp#L17)
File: [client\LightEngine\ScriptedEffects.hpp at line 23](../../../Src/client/LightEngine/ScriptedEffects.hpp#L23)
## SLIGHT_TEMPLATE_POINTLIGHT_var

Type: Variable
Expand All @@ -1669,7 +1741,7 @@ Initial value:
```sqf
2103
```
File: [client\LightEngine\ScriptedEffects.hpp at line 18](../../../Src/client/LightEngine/ScriptedEffects.hpp#L18)
File: [client\LightEngine\ScriptedEffects.hpp at line 24](../../../Src/client/LightEngine/ScriptedEffects.hpp#L24)
## SLIGHT_STREET_LAMP_var

Type: Variable
Expand All @@ -1681,7 +1753,7 @@ Initial value:
```sqf
2104
```
File: [client\LightEngine\ScriptedEffects.hpp at line 19](../../../Src/client/LightEngine/ScriptedEffects.hpp#L19)
File: [client\LightEngine\ScriptedEffects.hpp at line 25](../../../Src/client/LightEngine/ScriptedEffects.hpp#L25)
## SLIGHT_SHIT_SMELL_var

Type: Variable
Expand All @@ -1693,7 +1765,79 @@ Initial value:
```sqf
2105
```
File: [client\LightEngine\ScriptedEffects.hpp at line 20](../../../Src/client/LightEngine/ScriptedEffects.hpp#L20)
File: [client\LightEngine\ScriptedEffects.hpp at line 26](../../../Src/client/LightEngine/ScriptedEffects.hpp#L26)
## SLIGHT_WEAK_FIRE_var

Type: Variable

Description:


Initial value:
```sqf
2106
```
File: [client\LightEngine\ScriptedEffects.hpp at line 27](../../../Src/client/LightEngine/ScriptedEffects.hpp#L27)
## SLIGHT_SPOT_LAMP_var

Type: Variable

Description:


Initial value:
```sqf
2107
```
File: [client\LightEngine\ScriptedEffects.hpp at line 28](../../../Src/client/LightEngine/ScriptedEffects.hpp#L28)
## SLIGHT_LAMP_HOUSE_var

Type: Variable

Description:


Initial value:
```sqf
2108
```
File: [client\LightEngine\ScriptedEffects.hpp at line 29](../../../Src/client/LightEngine/ScriptedEffects.hpp#L29)
## SLIGHT_LIGHT_STOVE_var

Type: Variable

Description:


Initial value:
```sqf
2109
```
File: [client\LightEngine\ScriptedEffects.hpp at line 30](../../../Src/client/LightEngine/ScriptedEffects.hpp#L30)
## SLIGHT_LIGHT_BAKE_var

Type: Variable

Description:


Initial value:
```sqf
2110
```
File: [client\LightEngine\ScriptedEffects.hpp at line 31](../../../Src/client/LightEngine/ScriptedEffects.hpp#L31)
## SLIGHT_STREET_LAMP_DORM_var

Type: Variable

Description:


Initial value:
```sqf
2111
```
File: [client\LightEngine\ScriptedEffects.hpp at line 32](../../../Src/client/LightEngine/ScriptedEffects.hpp#L32)
# ScriptedEffects.sqf

## le_se_map
Expand Down
2 changes: 1 addition & 1 deletion Documentation/API/host/GameObjects.md
Original file line number Diff line number Diff line change
Expand Up @@ -3609,7 +3609,7 @@ Replaced value:
```sqf
_y get #func
```
File: [host\GameObjects\Items\Office\Books.sqf at line 386](../../../Src/host/GameObjects/Items/Office/Books.sqf#L386)
File: [host\GameObjects\Items\Office\Books.sqf at line 397](../../../Src/host/GameObjects/Items/Office/Books.sqf#L397)
# BasicMob.sqf

## emulate_mp_in_sp
Expand Down
28 changes: 14 additions & 14 deletions Documentation/API/host/GamemodeManager.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Replaced value:
```sqf
(missionNamespace getVariable ["role_"+(val),nullPtr])
```
File: [host\GamemodeManager\GamemodeFunctions.sqf at line 648](../../../Src/host/GamemodeManager/GamemodeFunctions.sqf#L648)
File: [host\GamemodeManager\GamemodeFunctions.sqf at line 651](../../../Src/host/GamemodeManager/GamemodeFunctions.sqf#L651)
## gm_init

Type: function
Expand Down Expand Up @@ -128,39 +128,39 @@ Description: Загружает игровой режим. Запускает п
- Param: _modeName
- Param: _gmName

File: [host\GamemodeManager\GamemodeFunctions.sqf at line 381](../../../Src/host/GamemodeManager/GamemodeFunctions.sqf#L381)
File: [host\GamemodeManager\GamemodeFunctions.sqf at line 384](../../../Src/host/GamemodeManager/GamemodeFunctions.sqf#L384)
## gm_pickMode

Type: function

Description:
- Param: _name (optional, default "")

File: [host\GamemodeManager\GamemodeFunctions.sqf at line 424](../../../Src/host/GamemodeManager/GamemodeFunctions.sqf#L424)
File: [host\GamemodeManager\GamemodeFunctions.sqf at line 427](../../../Src/host/GamemodeManager/GamemodeFunctions.sqf#L427)
## gm_handleAntagsImpl

Type: function

Description: Новый алгоритм выбора антагониста. Осуществляется после назначения режима


File: [host\GamemodeManager\GamemodeFunctions.sqf at line 505](../../../Src/host/GamemodeManager/GamemodeFunctions.sqf#L505)
File: [host\GamemodeManager\GamemodeFunctions.sqf at line 508](../../../Src/host/GamemodeManager/GamemodeFunctions.sqf#L508)
## gm_syncRolelistToAllClients

Type: function

Description: синхронизирует со всеми клиентами ролелист


File: [host\GamemodeManager\GamemodeFunctions.sqf at line 593](../../../Src/host/GamemodeManager/GamemodeFunctions.sqf#L593)
File: [host\GamemodeManager\GamemodeFunctions.sqf at line 596](../../../Src/host/GamemodeManager/GamemodeFunctions.sqf#L596)
## gm_syncRolelistToClient

Type: function

Description: отсылает клиенту все доступные роли для лобби или игры
- Param: _cli

File: [host\GamemodeManager\GamemodeFunctions.sqf at line 601](../../../Src/host/GamemodeManager/GamemodeFunctions.sqf#L601)
File: [host\GamemodeManager\GamemodeFunctions.sqf at line 604](../../../Src/host/GamemodeManager/GamemodeFunctions.sqf#L604)
## gm_addContenderToRole

Type: function
Expand All @@ -172,63 +172,63 @@ Description: Добавляет претендента в лист претен
- Param: _oldRoleName (optional, default "none")
- Param: _doNeedSyncAfterSet (optional, default false)

File: [host\GamemodeManager\GamemodeFunctions.sqf at line 643](../../../Src/host/GamemodeManager/GamemodeFunctions.sqf#L643)
File: [host\GamemodeManager\GamemodeFunctions.sqf at line 646](../../../Src/host/GamemodeManager/GamemodeFunctions.sqf#L646)
## gm_syncRoleContenders

Type: function

Description: синхронизирует со всеми клиентами информацию о занятых ролях
- Param: _idxContenders

File: [host\GamemodeManager\GamemodeFunctions.sqf at line 704](../../../Src/host/GamemodeManager/GamemodeFunctions.sqf#L704)
File: [host\GamemodeManager\GamemodeFunctions.sqf at line 707](../../../Src/host/GamemodeManager/GamemodeFunctions.sqf#L707)
## gm_isPreStartRoleExist

Type: function

Description: Проверяет наличие роли в списке дефолтных ролей. Принимает ссылку на объект роли или строковое название
- Param: _roleClass

File: [host\GamemodeManager\GamemodeFunctions.sqf at line 762](../../../Src/host/GamemodeManager/GamemodeFunctions.sqf#L762)
File: [host\GamemodeManager\GamemodeFunctions.sqf at line 765](../../../Src/host/GamemodeManager/GamemodeFunctions.sqf#L765)
## gm_isRoleExists

Type: function

Description: Осуществляет проверку наличия класса роли. Не учитывается статус роли количество и прочие факторы. Просто проверщик
- Param: _roleClass

File: [host\GamemodeManager\GamemodeFunctions.sqf at line 772](../../../Src/host/GamemodeManager/GamemodeFunctions.sqf#L772)
File: [host\GamemodeManager\GamemodeFunctions.sqf at line 775](../../../Src/host/GamemodeManager/GamemodeFunctions.sqf#L775)
## gm_getRoleObject

Type: function

Description: };


File: [host\GamemodeManager\GamemodeFunctions.sqf at line 787](../../../Src/host/GamemodeManager/GamemodeFunctions.sqf#L787)
File: [host\GamemodeManager\GamemodeFunctions.sqf at line 790](../../../Src/host/GamemodeManager/GamemodeFunctions.sqf#L790)
## gm_getGameModeObject

Type: function

Description: Получаем объект игрового режима


File: [host\GamemodeManager\GamemodeFunctions.sqf at line 790](../../../Src/host/GamemodeManager/GamemodeFunctions.sqf#L790)
File: [host\GamemodeManager\GamemodeFunctions.sqf at line 793](../../../Src/host/GamemodeManager/GamemodeFunctions.sqf#L793)
## gm_prepDesc

Type: function

Description: Подготавливает описание роли, заменяя куски текста на \n
- Param: _sourceText

File: [host\GamemodeManager\GamemodeFunctions.sqf at line 793](../../../Src/host/GamemodeManager/GamemodeFunctions.sqf#L793)
File: [host\GamemodeManager\GamemodeFunctions.sqf at line 796](../../../Src/host/GamemodeManager/GamemodeFunctions.sqf#L796)
## gm_printRoleNamesEx

Type: function

Description:
- Param: _name

File: [host\GamemodeManager\GamemodeFunctions.sqf at line 807](../../../Src/host/GamemodeManager/GamemodeFunctions.sqf#L807)
File: [host\GamemodeManager\GamemodeFunctions.sqf at line 810](../../../Src/host/GamemodeManager/GamemodeFunctions.sqf#L810)
# GamemodeManager.h

## IS_ENABLE_GAMEMODEMANAGER
Expand Down
34 changes: 34 additions & 0 deletions Documentation/API/host/MapManager.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,40 @@ Description:
- Param: _o

File: [host\MapManager\Maps\detective.sqf at line 22](../../../Src/host/MapManager/Maps/detective.sqf#L22)
# Dorm.sqf

## reditor_binding_fc

Type: function

Description:
- Param: _o

File: [host\MapManager\Maps\Dorm.sqf at line 3](../../../Src/host/MapManager/Maps/Dorm.sqf#L3)
## reditor_binding_gv

Type: function

Description:
- Param: _o

File: [host\MapManager\Maps\Dorm.sqf at line 12](../../../Src/host/MapManager/Maps/Dorm.sqf#L12)
## reditor_binding_sv

Type: function

Description:
- Param: _o

File: [host\MapManager\Maps\Dorm.sqf at line 17](../../../Src/host/MapManager/Maps/Dorm.sqf#L17)
## reditor_binding_gref

Type: function

Description:
- Param: _o

File: [host\MapManager\Maps\Dorm.sqf at line 22](../../../Src/host/MapManager/Maps/Dorm.sqf#L22)
# Hunt.sqf

## reditor_binding_fc
Expand Down

0 comments on commit 4ffb7f1

Please sign in to comment.