Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions DLC/GetIsLoadingScreenActive.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
ns: DLC
apiset: client
---
## GET_IS_LOADING_SCREEN_ACTIVE

Expand All @@ -8,5 +9,17 @@ 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 and 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
```
13 changes: 12 additions & 1 deletion HUD/HudDisplayLoadingScreenTips.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,16 @@ 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)

## Example

```lua
HudDisplayLoadingScreenTips()
```
11 changes: 10 additions & 1 deletion HUD/ThefeedAutoPostGametipsOn.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,13 @@ 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)

## Example

```lua
ThefeedAutoPostGametipsOn()
```
13 changes: 12 additions & 1 deletion HUD/ThefeedDisplayLoadingScreenTips.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,16 @@ 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)

## Example

```lua
ThefeedDisplayLoadingScreenTips()
```
10 changes: 9 additions & 1 deletion SCRIPT/GetNoLoadingScreen.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,13 @@ aliases: ["_GET_NO_LOADING_SCREEN"]
BOOL GET_NO_LOADING_SCREEN();
```


## Return value

The value that was set by [SET_NO_LOADING_SCREEN](#_0x5262CC1995D07E09)

## Example

```lua
SetNoLoadingScreen(true)
print(GetNoLoadingScreen()) -- will return true
```
9 changes: 8 additions & 1 deletion SCRIPT/SetNoLoadingScreen.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,14 @@ 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

## Example

```lua
SetNoLoadingScreen(true)
print(GetNoLoadingScreen()) -- will return true
```
9 changes: 9 additions & 0 deletions SCRIPT/ShutdownLoadingScreen.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
ns: SCRIPT
apiset: client
---
## SHUTDOWN_LOADING_SCREEN

Expand All @@ -8,4 +9,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()
```
Loading