|
| 1 | +# Menu functions |
| 2 | +Menu functions are used to perform operations while being in the menu. |
| 3 | + |
| 4 | +!!! Danger |
| 5 | + The menu functions are only available in the menu parser. |
| 6 | + |
| 7 | +## Functions |
| 8 | + |
| 9 | +### `Update_ChoiceBox` |
| 10 | +!!! function "`Update_ChoiceBox`" |
| 11 | + Updates `C_MENU_ITEM` choice box with the current setting. |
| 12 | + This specific boxes are hardcoded in the function itself: |
| 13 | + `MENUITEM_AUDIO_PROVIDER_CHOICE`, |
| 14 | + `MENUITEM_VID_DEVICE_CHOICE`, |
| 15 | + `MENUITEM_VID_RESOLUTION_CHOICE` |
| 16 | + ```dae |
| 17 | + func void Update_ChoiceBox(var string choicebox) |
| 18 | + ``` |
| 19 | + |
| 20 | + **Parameters** |
| 21 | + |
| 22 | + - `#!dae var string choicebox` - name of the one of the hardcoded choice boxes |
| 23 | + |
| 24 | +### `PlayVideo` |
| 25 | +!!! function "`PlayVideo`" |
| 26 | + Plays a video |
| 27 | + ```dae |
| 28 | + func int PlayVideo(var string filename) |
| 29 | + ``` |
| 30 | + |
| 31 | + **Parameters** |
| 32 | + |
| 33 | + - `#!dae var string filename` - name of the video file |
| 34 | + |
| 35 | + **Return value** |
| 36 | + The function returns TRUE if the video was played successfully, FALSE otherwise |
| 37 | + |
| 38 | +### `Apply_Options_Performance` |
| 39 | +!!! function "`Apply_Options_Performance`" |
| 40 | + Applies the options for the performance, analyzes the system and changes the settings if necessary |
| 41 | + ```dae |
| 42 | + func void Apply_Options_Performance() |
| 43 | + ``` |
| 44 | + |
| 45 | +### `Apply_Options_Video` |
| 46 | +!!! function "`Apply_Options_Video`" |
| 47 | + Applies the options for the video, changes the resolution and graphics device if necessary |
| 48 | + ```dae |
| 49 | + func void Apply_Options_Video() |
| 50 | + ``` |
| 51 | + |
| 52 | +## Deprecated |
| 53 | + |
| 54 | +### `Apply_Options_Audio` |
| 55 | +!!! function "`Apply_Options_Audio`" |
| 56 | + Meant to apply the options for the audio, does nothing apart playing an apply sound |
| 57 | + ```dae |
| 58 | + func void Apply_Options_Audio() |
| 59 | + ``` |
| 60 | + |
| 61 | +### `Apply_Options_Game` |
| 62 | +!!! function "`Apply_Options_Game`" |
| 63 | + Meant to apply the options for the game, does nothing apart playing an apply sound |
| 64 | + ```dae |
| 65 | + func void Apply_Options_Game() |
| 66 | + ``` |
| 67 | + |
| 68 | +### `Apply_Options_Controls` |
| 69 | +!!! function "`Apply_Options_Controls`" |
| 70 | + Meant to apply the options for the controls, does nothing apart playing an apply sound |
| 71 | + ```dae |
| 72 | + func void Apply_Options_Controls() |
| 73 | + ``` |
| 74 | + |
0 commit comments