You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Copy file name to clipboardExpand all lines: content/docs/client-manual/crosshair.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -124,4 +124,4 @@ The crosshair can be disabled from the server by entering the following line in
124
124
setr cl_customCrosshair false
125
125
```
126
126
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`.
Copy file name to clipboardExpand all lines: content/docs/developers/scripting-manual/introduction/about-native-functions.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -6,13 +6,13 @@ weight: 1300
6
6
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.
7
7
8
8
## 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).
10
10
11
11
12
12
## Where Can You Find Native Functions?
13
13
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.
14
14
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/).
16
16
17
17
-**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.
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):
Copy file name to clipboardExpand all lines: content/docs/developers/scripting-manual/voice/_index.md
+8-8
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,7 @@ Enables the game's native audio including filter support. This should be enabled
33
33
34
34
# Talker Proximity
35
35
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.
This method ought to be called from the client in order for it to work.
45
45
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.
47
47
48
48
# Submixes
49
49
50
50
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).
51
51
Below is an example of a submix being initialized (with audio effects being applied):
52
52
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).
54
54
55
55
## Initializing a submix
56
56
@@ -84,7 +84,7 @@ end
84
84
85
85
## Making a submix play through the left channel only
86
86
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.
88
88
Let's create an audio submix, and then play it through the front left channel.
89
89
90
90
```lua
@@ -111,7 +111,7 @@ end
111
111
112
112
## Removing assignment of a submix for a given player
113
113
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:
115
115
116
116
```lua
117
117
MumbleSetSubmixForServerId(playerId, -1)
@@ -213,7 +213,7 @@ end, false)
213
213
214
214
### Writing the code (client-side)
215
215
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).
@@ -245,15 +245,15 @@ And that's it, we can now join and leave channels.
245
245
246
246
## Listening to channels
247
247
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.
Copy file name to clipboardExpand all lines: content/docs/developers/scripting-reference/onesync/_index.md
+8-8
Original file line number
Diff line number
Diff line change
@@ -101,7 +101,7 @@ Culling has a range for each specific player, and entities are culled to players
101
101
102
102
{{% 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 %}}
103
103
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.
105
105
106
106
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.
107
107
@@ -222,12 +222,12 @@ Each bucket can have different rules, these are named 'lockdown modes' and they
Copy file name to clipboardExpand all lines: content/docs/game-references/checkpoints.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: Checkpoints
3
3
weight: 730
4
4
---
5
5
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 %}}
7
7
8
8
9
9
Standard Checkpoints
@@ -92,7 +92,7 @@ Standard Checkpoints
92
92
93
93
Checkpoint Type 44-46
94
94
-----
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.
96
96
97
97
IDs 100 and higher include a [marker](/docs/game-references/markers/) next to it, marker IDs are included below.
Copy file name to clipboardExpand all lines: content/docs/support/ban-faq.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -45,5 +45,5 @@ I found cheats that are undetected! Get em!
45
45
-------------------------------------------
46
46
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,
47
47
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
49
49
fight against cheaters who may be affecting your server.
Copy file name to clipboardExpand all lines: content/docs/support/documentation-faq.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ Do you feel as if there's missing documentation? As of now there's a few section
9
9
10
10
Where are these sections?
11
11
--------------------------------
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.
0 commit comments