Skip to content

Commit 9058fbd

Browse files
authored
More loadingscreen documentation (#1294)
* Update ShutdownLoadingScreen * Update GetIsLoadingScreenActive * more loadingscreen documentation * fixes (requested changes) * fix (missed)
1 parent fe93fbe commit 9058fbd

File tree

7 files changed

+65
-5
lines changed

7 files changed

+65
-5
lines changed

DLC/GetIsLoadingScreenActive.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,16 @@ ns: DLC
88
BOOL GET_IS_LOADING_SCREEN_ACTIVE();
99
```
1010

11+
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).
1112

1213
## Return value
14+
15+
Wether the player is still in the loadingscreen
16+
17+
## Examples
18+
```lua
19+
-- Close the loading screen if it's still active
20+
if GetIsLoadingScreenActive() then
21+
ShutdownLoadingScreen()
22+
end
23+
```

HUD/HudDisplayLoadingScreenTips.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,15 @@ aliases: ["0x488043841BBE156F"]
99
void _HUD_DISPLAY_LOADING_SCREEN_TIPS();
1010
```
1111

12-
Displays loading screen tips, requires `_0x56C8B608CFD49854` to be called beforehand.
12+
Displays loading screen tips.
13+
Seems to do the same as [`_THEFEED_DISPLAY_LOADING_SCREEN_TIPS`](#_0x15CFA549788D35EF).
14+
Requires [`THEFEED_AUTO_POST_GAMETIPS_ON`](#0_x56C8B608CFD49854) to be called beforehand.
15+
Call [`_THEFEED_DISABLE_LOADING_SCREEN_TIPS`](#_0x32888337579A5970) to disable immediately, or [`THEFEED_AUTO_POST_GAMETIPS_OFF`](#_0xADED7F5748ACAFE6) to disable after the current tip.
1316

17+
Example result:
18+
![](https://i.imgur.com/hzaHuPb.png)
19+
20+
## Examples
21+
```lua
22+
HudDisplayLoadingScreenTips()
23+
```

HUD/ThefeedAutoPostGametipsOn.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,12 @@ void THEFEED_AUTO_POST_GAMETIPS_ON();
1010
```
1111

1212
Enables loading screen tips to be be shown, blocks other kinds of notifications from being displayed.
13-
Call [`THEFEED_AUTO_POST_GAMETIPS_OFF`](#_0xADED7F5748ACAFE6) to undo this.
13+
Call [`THEFEED_AUTO_POST_GAMETIPS_OFF`](#_0xADED7F5748ACAFE6) to disable.
14+
15+
Example result:
16+
![](https://i.imgur.com/GdRa0kw.png)
17+
18+
## Examples
19+
```lua
20+
ThefeedAutoPostGametipsOn()
21+
```

HUD/ThefeedDisplayLoadingScreenTips.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,15 @@ aliases: ["0x15CFA549788D35EF","_THEFEED_ENABLE"]
99
void _THEFEED_DISPLAY_LOADING_SCREEN_TIPS();
1010
```
1111

12-
Displays loading screen tips, requires `0x56C8B608CFD49854` to be called beforehand.
12+
Displays loading screen tips.
13+
Seems to do the same as [`_HUD_DISPLAY_LOADING_SCREEN_TIPS`](#_0x488043841BBE156F).
14+
Requires [`THEFEED_AUTO_POST_GAMETIPS_ON`](#_0x56C8B608CFD49854) to be called beforehand.
15+
Call [`_THEFEED_DISABLE_LOADING_SCREEN_TIPS`](#_0x32888337579A5970) to disable immediately, or [`THEFEED_AUTO_POST_GAMETIPS_OFF`](#_0xADED7F5748ACAFE6) to disable after the current tip.
1316

17+
Example result:
18+
![](https://i.imgur.com/hzaHuPb.png)
19+
20+
## Examples
21+
```lua
22+
ThefeedDisplayLoadingScreenTips()
23+
```

SCRIPT/GetNoLoadingScreen.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,12 @@ aliases: ["_GET_NO_LOADING_SCREEN"]
99
BOOL GET_NO_LOADING_SCREEN();
1010
```
1111

12-
1312
## Return value
13+
14+
The value that was set by [SET_NO_LOADING_SCREEN](#_0x5262CC1995D07E09)
15+
16+
## Examples
17+
```lua
18+
SetNoLoadingScreen(true)
19+
print(GetNoLoadingScreen()) -- will return true
20+
```

SCRIPT/SetNoLoadingScreen.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,13 @@ ns: SCRIPT
88
void SET_NO_LOADING_SCREEN(BOOL toggle);
99
```
1010
11+
Doesn't seem to do anything. Set value can be retrieved using [`GET_NO_LOADING_SCREEN`](#_0x18C1270EA7F199BC).
1112
1213
## Parameters
13-
* **toggle**:
14+
* **toggle**: Enabled/Disable
1415
16+
## Examples
17+
```lua
18+
SetNoLoadingScreen(true)
19+
print(GetNoLoadingScreen()) -- will return true
20+
```

SCRIPT/ShutdownLoadingScreen.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,12 @@ ns: SCRIPT
88
void SHUTDOWN_LOADING_SCREEN();
99
```
1010

11+
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.
1112

13+
![](https://i.imgur.com/WULopNH.jpeg)
14+
15+
## Examples
16+
17+
```lua
18+
ShutdownLoadingScreen()
19+
```

0 commit comments

Comments
 (0)