Skip to content

Commit 0c68a60

Browse files
committed
Remove Unnecessary Absolute URLs
This commit removes unnecessary instances of https://docs.fivem.net from the documentation. Instead, relative links such as '/docs/...' are used to maintain organization and keep things consistent. No modifications were made to the example code; it remains unchanged.
1 parent cf22d9f commit 0c68a60

File tree

12 files changed

+28
-28
lines changed

12 files changed

+28
-28
lines changed

content/docs/client-manual/crosshair.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -124,4 +124,4 @@ The crosshair can be disabled from the server by entering the following line in
124124
setr cl_customCrosshair false
125125
```
126126

127-
Entering said line will set the [convar](https://docs.fivem.net/docs/developers/scripting-reference/convars/#standard-convars) (console variable) as a [replicated variable](https://docs.fivem.net/docs/developers/scripting-reference/convars/#using-commands-1) set to `false`.
127+
Entering said line will set the [convar](/docs/developers/scripting-reference/convars/#standard-convars) (console variable) as a [replicated variable](/docs/developers/scripting-reference/convars/#using-commands-1) set to `false`.

content/docs/developers/scripting-manual/introduction/about-native-functions.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ weight: 1300
66
In FiveM, you have access to what are called "native functions" or simply "natives". These functions are provided by the game itself, using them will allow you to perform a wide variety of actions within the game environment. This guide will explain what natives are, where you can find them, and how to use them in your scripts.
77

88
## What Are Native Functions?
9-
Native functions in FiveM are predefined functions that enable interaction with the game. They are essential for creating and managing game mechanics, player interactions, and various other functionalities within your server. Natives are used in both client-side and server-side. Some of them are created by Cfx like [DropPlayer](https://docs.fivem.net/natives/?_0xBA0613E1).
9+
Native functions in FiveM are predefined functions that enable interaction with the game. They are essential for creating and managing game mechanics, player interactions, and various other functionalities within your server. Natives are used in both client-side and server-side. Some of them are created by Cfx like [DropPlayer](/natives/?_0xBA0613E1).
1010

1111

1212
## Where Can You Find Native Functions?
1313
FiveM provides comprehensive documentation for native functions. This documentation is essential for understanding what each native function does, how to use it, and what parameters it requires.
1414

15-
- **FiveM Natives**: All documented natives can be found on [our official website](https://docs.fivem.net/natives/).
15+
- **FiveM Natives**: All documented natives can be found on [our official website](/natives/).
1616

1717
- **Community Forums**: The [Cfx.re Forums](https://forum.cfx.re/) are another valuable resource. Here, you can find discussions, tutorials, and examples from other developers who share their experiences and solutions related to using native functions.
1818

content/docs/developers/scripting-manual/introduction/fact-sheet.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ GiveWeaponToPed(ped, GetHashKey("WEAPON_PISTOL"), 100, false, false) -- We got a
3939
```
4040

4141
## Where are all the natives?
42-
Natives are located [here](https://docs.fivem.net/natives/).
42+
Natives are located [here](/natives/).
4343

4444
# Developer Commands & Game References
4545
## Where are all the developer commands?

content/docs/developers/scripting-manual/using-new-game-features/collection-based-natives.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ RegisterCommand('PrintFullPlayerPedCollectionsInfo', function(source)
166166
end, true)
167167
```
168168

169-
Set new ped look (for `mp_f_freemode_01` ped model, see https://docs.fivem.net/docs/game-references/ped-models/, other models may have less drawable variations available):
169+
Set new ped look (for `mp_f_freemode_01` ped model, see [Ped models](/docs/game-references/ped-models/), other models may have less drawable variations available):
170170

171171
```lua
172172
function setLook(ped)

content/docs/developers/scripting-manual/voice/_index.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Enables the game's native audio including filter support. This should be enabled
3333

3434
# Talker Proximity
3535

36-
You can use [`MUMBLE_SET_TALKER_PROXIMITY`](https://docs.fivem.net/natives/?_0x74E927B0) to limit distance between players when communicating via voice chat.
36+
You can use [`MUMBLE_SET_TALKER_PROXIMITY`](/natives/?_0x74E927B0) to limit distance between players when communicating via voice chat.
3737

3838
An example can be shown down below:
3939

@@ -43,14 +43,14 @@ MumbleSetTalkerProximity(15.0)
4343

4444
This method ought to be called from the client in order for it to work.
4545

46-
It's worth noting that there's another native named [`NETWORK_SET_TALKER_PROXIMITY`](https://docs.fivem.net/natives/?_0xCBF12D65F95AD686), which is only available on FiveM. The aforementioned native also [calls](https://github.com/citizenfx/fivem/blob/928bd19f886d66d3f85340e65df69ae97ab91dc7/code/components/gta-net-five/src/MumbleVoice.cpp#L1343) the original game native before setting mumble's audio distance.
46+
It's worth noting that there's another native named [`NETWORK_SET_TALKER_PROXIMITY`](/natives/?_0xCBF12D65F95AD686), which is only available on FiveM. The aforementioned native also [calls](https://github.com/citizenfx/fivem/blob/928bd19f886d66d3f85340e65df69ae97ab91dc7/code/components/gta-net-five/src/MumbleVoice.cpp#L1343) the original game native before setting mumble's audio distance.
4747

4848
# Submixes
4949

5050
Submixes allow you to apply effects to sounds, FiveM utilizes `rage::audDriver::GetMixer` to apply these effects. These can be set to clients to alter their outgoing audio (voice).
5151
Below is an example of a submix being initialized (with audio effects being applied):
5252

53-
Submix effects have hashes, for the full list of hashes, check out this [native](https://docs.fivem.net/natives/?_0xAAA94D53).
53+
Submix effects have hashes, for the full list of hashes, check out this [native](/natives/?_0xAAA94D53).
5454

5555
## Initializing a submix
5656

@@ -84,7 +84,7 @@ end
8484

8585
## Making a submix play through the left channel only
8686

87-
You can change how a submix plays through different channels by using [`SET_AUDIO_SUBMIX_OUTPUT_VOLUMES`](https://docs.fivem.net/natives/?_0x825DC0D1) as described down below.
87+
You can change how a submix plays through different channels by using [`SET_AUDIO_SUBMIX_OUTPUT_VOLUMES`](/natives/?_0x825DC0D1) as described down below.
8888
Let's create an audio submix, and then play it through the front left channel.
8989

9090
```lua
@@ -111,7 +111,7 @@ end
111111

112112
## Removing assignment of a submix for a given player
113113

114-
You can stop a submix from applying to a player by sending `-1` as the submix id to [`MUMBLE_SET_SUBMIX_FOR_SERVER_ID`](https://docs.fivem.net/natives/?_0xFE3A3054), for example:
114+
You can stop a submix from applying to a player by sending `-1` as the submix id to [`MUMBLE_SET_SUBMIX_FOR_SERVER_ID`](/natives/?_0xFE3A3054), for example:
115115

116116
```lua
117117
MumbleSetSubmixForServerId(playerId, -1)
@@ -213,7 +213,7 @@ end, false)
213213

214214
### Writing the code (client-side)
215215

216-
We will first register an event named `onPlayerChangeVoiceChannels`, we will be using this event to iterate through the list of clients we previously mentioned (which the server is sending us) and set their volume. We will also be setting our voice channel through here by calling [`MUMBLE_SET_VOICE_CHANNEL`](https://docs.fivem.net/natives/?_0x8737EEE8).
216+
We will first register an event named `onPlayerChangeVoiceChannels`, we will be using this event to iterate through the list of clients we previously mentioned (which the server is sending us) and set their volume. We will also be setting our voice channel through here by calling [`MUMBLE_SET_VOICE_CHANNEL`](/natives/?_0x8737EEE8).
217217

218218
```lua
219219
RegisterNetEvent("onPlayerChangeVoiceChannels", function(clients, channel, state)
@@ -245,15 +245,15 @@ And that's it, we can now join and leave channels.
245245

246246
## Listening to channels
247247

248-
We can listen to channels by using the following native: [`MUMBLE_ADD_VOICE_CHANNEL_LISTEN`](https://docs.fivem.net/natives/?_0xC79F44BF). The native allows us to 'spectate' any channel we want. We can find an example client implementation down below.
248+
We can listen to channels by using the following native: [`MUMBLE_ADD_VOICE_CHANNEL_LISTEN`](/natives/?_0xC79F44BF). The native allows us to 'spectate' any channel we want. We can find an example client implementation down below.
249249

250250
```lua
251251
RegisterCommand("listenchannel", function(source, args, rawCommand)
252252
MumbleAddVoiceChannelListen(tonumber(args[1]))
253253
end, false)
254254
```
255255

256-
In order to remove ourselves as a listener, we can use [`MUMBLE_REMOVE_VOICE_CHANNEL_LISTEN`](https://docs.fivem.net/natives/?_0x231523B7).
256+
In order to remove ourselves as a listener, we can use [`MUMBLE_REMOVE_VOICE_CHANNEL_LISTEN`](/natives/?_0x231523B7).
257257

258258
# Not the end
259259

content/docs/developers/scripting-manual/working-with-events/server-security.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ When using networked events, make sure to add some checks like:
6565
- Player money
6666
- Player [state bags](/docs/developers/scripting-manual/networking/state-bags/)
6767
- Player inventory items
68-
- Player [position](https://docs.fivem.net/natives/?_0x1647F1CB)
68+
- Player [position](/natives/?_0x1647F1CB)
6969
- Player experience and level
7070
- Player [permissions](https://forum.cfx.re/t/basic-aces-principals-overview-guide/90917) and roles
7171

content/docs/developers/scripting-reference/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ FiveM supports C#, Lua, and JavaScript, allowing you the flexibility to create a
2626
- [Create Your First Script](/docs/developers/scripting-manual/introduction/creating-your-first-script)
2727
- [Client Events](/docs/developers/scripting-reference/events/client-events)
2828
- [Server Events](/docs/developers/scripting-reference/events/server-events)
29-
- [Native Functions](https://docs.fivem.net/natives/)
29+
- [Native Functions](/natives/)
3030
- [Client Functions](/docs/developers/scripting-reference/client-functions)
3131
- [Server Functions](/docs/developers/scripting-reference/server-functions)
3232

content/docs/developers/scripting-reference/onesync/_index.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ Culling has a range for each specific player, and entities are culled to players
101101

102102
{{% alert theme="warning" %}}Culling natives are deprecated and have known, unfixable [issues](https://forum.cfx.re/t/issue-with-culling-radius-and-server-side-entities/4900677/4). {{% /alert %}}
103103

104-
There's natives such as [SetEntityDistanceCullingRadius](https://docs.fivem.net/natives/?_0xD3A183A3) and [SetPlayerCullingRadius](https://docs.fivem.net/natives/?_0x8A2FBAD4) to change the default culling radius.
104+
There's natives such as [SetEntityDistanceCullingRadius](/natives/?_0xD3A183A3) and [SetPlayerCullingRadius](/natives/?_0x8A2FBAD4) to change the default culling radius.
105105

106106
When an entity goes out of range, it's no longer controlled by their original owner. This means that any entity that would be out of scope will be culled and migrated/disowned. By default, the culling radius is set to `424 units` around the entity.
107107

@@ -222,12 +222,12 @@ Each bucket can have different rules, these are named 'lockdown modes' and they
222222

223223
| Native |
224224
| ---------- |
225-
| **[GET_ENTITY_ROUTING_BUCKET](https://docs.fivem.net/natives/?_0xED4B0486)** |
226-
| **[GET_PLAYER_ROUTING_BUCKET](https://docs.fivem.net/natives/?_0x52441C34)** |
227-
| **[SET_ENTITY_ROUTING_BUCKET](https://docs.fivem.net/natives/?_0x635E5289)** |
228-
| **[SET_PLAYER_ROUTING_BUCKET](https://docs.fivem.net/natives/?_0x6504EB38)** |
229-
| **[SET_ROUTING_BUCKET_ENTITY_LOCKDOWN_MODE](https://docs.fivem.net/natives/?_0xA0F2201F)** |
230-
| **[SET_ROUTING_BUCKET_POPULATION_ENABLED](https://docs.fivem.net/natives/?_0xCE51AC2C)** |
225+
| **[GET_ENTITY_ROUTING_BUCKET](/natives/?_0xED4B0486)** |
226+
| **[GET_PLAYER_ROUTING_BUCKET](/natives/?_0x52441C34)** |
227+
| **[SET_ENTITY_ROUTING_BUCKET](/natives/?_0x635E5289)** |
228+
| **[SET_PLAYER_ROUTING_BUCKET](/natives/?_0x6504EB38)** |
229+
| **[SET_ROUTING_BUCKET_ENTITY_LOCKDOWN_MODE](/natives/?_0xA0F2201F)** |
230+
| **[SET_ROUTING_BUCKET_POPULATION_ENABLED](/natives/?_0xCE51AC2C)** |
231231

232232
**A rough example:**
233233

@@ -243,5 +243,5 @@ State bags allow you to set attributes to entities and allow other clients to ac
243243

244244
[vmturl]: https://en.wikipedia.org/wiki/Virtual_method_table
245245
[fivem-codebase]: https://github.com/citizenfx/fivem
246-
[server-events]: https://docs.fivem.net/docs/developers/scripting-reference/events/server-events
246+
[server-events]: /docs/developers/scripting-reference/events/server-events
247247
[original-scope-post]: https://forum.cfx.re/t/onesync-playerenteredscope-and-playerleftscope-events

content/docs/developers/scripting-reference/runtimes/javascript/functions/exports.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Exports
33
---
44

55
Use this to export functions so they can be called from other resources.\
6-
Read more on [exports](https://docs.fivem.net/scripting-manual/runtimes/javascript/#using-exports)
6+
Read more on [exports](/docs/developers/scripting-manual/runtimes/javascript/#using-exports)
77

88
## Signature
99

content/docs/game-references/checkpoints.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Checkpoints
33
weight: 730
44
---
55

6-
{{% alert color="success" title="Note" %}}This checkpoint ID order is valid as of game build 2189. Any game build before that the order slightly differs. You can generally take 3 away from IDs to get an ID that matches older game builds, or you could check the old table on the [native reference](https://docs.fivem.net/natives/?_0x0134F0835AB6BFCB).{{% /alert %}}
6+
{{% alert color="success" title="Note" %}}This checkpoint ID order is valid as of game build 2189. Any game build before that the order slightly differs. You can generally take 3 away from IDs to get an ID that matches older game builds, or you could check the old table on the [native reference](/natives/?_0x0134F0835AB6BFCB).{{% /alert %}}
77

88

99
Standard Checkpoints
@@ -92,7 +92,7 @@ Standard Checkpoints
9292

9393
Checkpoint Type 44-46
9494
-----
95-
If using checkpoint type 44-46 the `reserved` parameter in the [CreateCheckpoint](https://docs.fivem.net/natives/?_0x0134F0835AB6BFCB) native sets the number/number and shape to display.
95+
If using checkpoint type 44-46 the `reserved` parameter in the [CreateCheckpoint](/natives/?_0x0134F0835AB6BFCB) native sets the number/number and shape to display.
9696

9797
IDs 100 and higher include a [marker](/docs/game-references/markers/) next to it, marker IDs are included below.
9898

content/docs/support/ban-faq.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,5 +45,5 @@ I found cheats that are undetected! Get em!
4545
-------------------------------------------
4646
Whoa! That's unfortunate, are you sure they still are undetected? Our anticheat system bans are typically slightly delayed, within 24 hours after detection the user is banned. With that being said,
4747
we cannot stay on top of them completely without your help, our community is our backbone. If you come across cheats in which you feel are undetected and you have the actual files, please feel free to send
48-
them to [this form](https://support.cfx.re/hc/en-us/requests/new?ticket_form_id=1900000367874). Additionally, take a look at [this link](https://docs.fivem.net/docs/support/resource-faq/#what-can-i-do-against-cheaters) to see what you can do to help
48+
them to [this form](https://support.cfx.re/hc/en-us/requests/new?ticket_form_id=1900000367874). Additionally, take a look at [this link](/docs/support/resource-faq/#what-can-i-do-against-cheaters) to see what you can do to help
4949
fight against cheaters who may be affecting your server.

content/docs/support/documentation-faq.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Do you feel as if there's missing documentation? As of now there's a few section
99

1010
Where are these sections?
1111
--------------------------------
12-
[General documentation](https://docs.fivem.net/) has its own [Github issues](https://github.com/citizenfx/fivem-docs/issues) section and [natives](https://docs.fivem.net/natives/) have their own section located [here](https://github.com/citizenfx/natives/issues) as well.
12+
[General documentation](https://docs.fivem.net/) has its own [Github issues](https://github.com/citizenfx/fivem-docs/issues) section and [natives](/natives/) have their own section located [here](https://github.com/citizenfx/natives/issues) as well.
1313

1414
How do I open an issue in any of these sections?
1515
--------------------------------

0 commit comments

Comments
 (0)