diff --git a/DLC/GetIsLoadingScreenActive.md b/DLC/GetIsLoadingScreenActive.md index e5e3fcc74..c2fb8ea4b 100644 --- a/DLC/GetIsLoadingScreenActive.md +++ b/DLC/GetIsLoadingScreenActive.md @@ -8,5 +8,16 @@ ns: DLC BOOL GET_IS_LOADING_SCREEN_ACTIVE(); ``` +When loading in, returns true until [`SHUTDOWN_LOADING_SCREEN`](#_0x078EBE9809CCD637) was called. Note that this is referring to the game's loading screen, not the NUI loadingscreen and is therefore not impacted by [loadscreen_manual_shutdown](https://docs.fivem.net/docs/scripting-reference/resource-manifest/resource-manifest/#loadscreen_manual_shutdown). ## Return value + +Wether the player is still in the loadingscreen + +## Examples +```lua +-- Close the loading screen if it's still active +if GetIsLoadingScreenActive() then + ShutdownLoadingScreen() +end +``` diff --git a/HUD/HudDisplayLoadingScreenTips.md b/HUD/HudDisplayLoadingScreenTips.md index 8ecdbf8dd..0c19b8e2c 100644 --- a/HUD/HudDisplayLoadingScreenTips.md +++ b/HUD/HudDisplayLoadingScreenTips.md @@ -9,5 +9,15 @@ aliases: ["0x488043841BBE156F"] void _HUD_DISPLAY_LOADING_SCREEN_TIPS(); ``` -Displays loading screen tips, requires `_0x56C8B608CFD49854` to be called beforehand. +Displays loading screen tips. +Seems to do the same as [`_THEFEED_DISPLAY_LOADING_SCREEN_TIPS`](#_0x15CFA549788D35EF). +Requires [`THEFEED_AUTO_POST_GAMETIPS_ON`](#0_x56C8B608CFD49854) to be called beforehand. +Call [`_THEFEED_DISABLE_LOADING_SCREEN_TIPS`](#_0x32888337579A5970) to disable immediately, or [`THEFEED_AUTO_POST_GAMETIPS_OFF`](#_0xADED7F5748ACAFE6) to disable after the current tip. +Example result: +![](https://i.imgur.com/hzaHuPb.png) + +## Examples +```lua +HudDisplayLoadingScreenTips() +``` diff --git a/HUD/ThefeedAutoPostGametipsOn.md b/HUD/ThefeedAutoPostGametipsOn.md index 6258222d0..fcd8f9913 100644 --- a/HUD/ThefeedAutoPostGametipsOn.md +++ b/HUD/ThefeedAutoPostGametipsOn.md @@ -10,4 +10,12 @@ void THEFEED_AUTO_POST_GAMETIPS_ON(); ``` Enables loading screen tips to be be shown, blocks other kinds of notifications from being displayed. -Call [`THEFEED_AUTO_POST_GAMETIPS_OFF`](#_0xADED7F5748ACAFE6) to undo this. +Call [`THEFEED_AUTO_POST_GAMETIPS_OFF`](#_0xADED7F5748ACAFE6) to disable. + +Example result: +![](https://i.imgur.com/GdRa0kw.png) + +## Examples +```lua +ThefeedAutoPostGametipsOn() +``` diff --git a/HUD/ThefeedDisplayLoadingScreenTips.md b/HUD/ThefeedDisplayLoadingScreenTips.md index fe4c37ce4..ac76f0bcb 100644 --- a/HUD/ThefeedDisplayLoadingScreenTips.md +++ b/HUD/ThefeedDisplayLoadingScreenTips.md @@ -9,5 +9,15 @@ aliases: ["0x15CFA549788D35EF","_THEFEED_ENABLE"] void _THEFEED_DISPLAY_LOADING_SCREEN_TIPS(); ``` -Displays loading screen tips, requires `0x56C8B608CFD49854` to be called beforehand. +Displays loading screen tips. +Seems to do the same as [`_HUD_DISPLAY_LOADING_SCREEN_TIPS`](#_0x488043841BBE156F). +Requires [`THEFEED_AUTO_POST_GAMETIPS_ON`](#_0x56C8B608CFD49854) to be called beforehand. +Call [`_THEFEED_DISABLE_LOADING_SCREEN_TIPS`](#_0x32888337579A5970) to disable immediately, or [`THEFEED_AUTO_POST_GAMETIPS_OFF`](#_0xADED7F5748ACAFE6) to disable after the current tip. +Example result: +![](https://i.imgur.com/hzaHuPb.png) + +## Examples +```lua +ThefeedDisplayLoadingScreenTips() +``` diff --git a/SCRIPT/GetNoLoadingScreen.md b/SCRIPT/GetNoLoadingScreen.md index 71b58f958..abef91561 100644 --- a/SCRIPT/GetNoLoadingScreen.md +++ b/SCRIPT/GetNoLoadingScreen.md @@ -9,5 +9,12 @@ aliases: ["_GET_NO_LOADING_SCREEN"] BOOL GET_NO_LOADING_SCREEN(); ``` - ## Return value + +The value that was set by [SET_NO_LOADING_SCREEN](#_0x5262CC1995D07E09) + +## Examples +```lua +SetNoLoadingScreen(true) +print(GetNoLoadingScreen()) -- will return true +``` diff --git a/SCRIPT/SetNoLoadingScreen.md b/SCRIPT/SetNoLoadingScreen.md index f5751fb37..2ab4a987e 100644 --- a/SCRIPT/SetNoLoadingScreen.md +++ b/SCRIPT/SetNoLoadingScreen.md @@ -8,7 +8,13 @@ ns: SCRIPT void SET_NO_LOADING_SCREEN(BOOL toggle); ``` +Doesn't seem to do anything. Set value can be retrieved using [`GET_NO_LOADING_SCREEN`](#_0x18C1270EA7F199BC). ## Parameters -* **toggle**: +* **toggle**: Enabled/Disable +## Examples +```lua +SetNoLoadingScreen(true) +print(GetNoLoadingScreen()) -- will return true +``` diff --git a/SCRIPT/ShutdownLoadingScreen.md b/SCRIPT/ShutdownLoadingScreen.md index df6bc331d..0fad65c66 100644 --- a/SCRIPT/ShutdownLoadingScreen.md +++ b/SCRIPT/ShutdownLoadingScreen.md @@ -8,4 +8,12 @@ ns: SCRIPT void SHUTDOWN_LOADING_SCREEN(); ``` +Shuts down the loading screen and switches to normal game view. Should only be used by [spawnmanager](https://docs.fivem.net/docs/resources/spawnmanager/) or similar resources after loading and spawning the player ped. If no script does this, the game is stuck in the infamous bridge screen with the "Awaiting scripts" text and loading circle at the bottom right corner. +![](https://i.imgur.com/WULopNH.jpeg) + +## Examples + +```lua +ShutdownLoadingScreen() +```