Skip to content

Commit d10db81

Browse files
committed
updated gametextstyles, gametextforall, gametextforplayer pages
1 parent cdd5d9a commit d10db81

17 files changed

+40
-75
lines changed

Diff for: docs/scripting/functions/GameTextForAll.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ tags: []
99

1010
Shows 'game text' (on-screen text) for a certain length of time for all players.
1111

12-
| Name | Description |
13-
| -------------- | ----------------------------------------------------- |
14-
| const string[] | The text to be displayed. |
15-
| time | The duration of the text being shown in milliseconds. |
16-
| style | The style of text to be displayed. |
12+
| Name | Description |
13+
| --------------- | ----------------------------------------------------------------- |
14+
| const string[] | The text to be displayed. |
15+
| time | The duration of the text being shown in milliseconds. |
16+
| style | The [style](../resources/gametextstyles) of text to be displayed. |
1717

1818
## Returns
1919

Diff for: docs/scripting/functions/GameTextForPlayer.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ tags: ["player"]
99

1010
Shows 'game text' (on-screen text) for a certain length of time for a specific player.
1111

12-
| Name | Description |
13-
| -------------- | ----------------------------------------------------- |
14-
| playerid | The ID of the player to show the gametext for. |
15-
| const string[] | The text to be displayed. |
16-
| time | The duration of the text being shown in milliseconds. |
17-
| style | The style of text to be displayed. |
12+
| Name | Description |
13+
| --------------- | ----------------------------------------------------------------- |
14+
| playerid | The ID of the player to show the gametext for. |
15+
| const string[] | The text to be displayed. |
16+
| time | The duration of the text being shown in milliseconds. |
17+
| style | The [style](../resources/gametextstyles) of text to be displayed. |
1818

1919
## Returns
2020

Diff for: docs/scripting/resources/gametextstyles.md

+29-64
Original file line numberDiff line numberDiff line change
@@ -3,41 +3,32 @@ title: GameText Styles
33
description: GameText Styles to be used in textdraws and gametext
44
---
55

6-
To be used with [GameText](../functions/GameTextForPlayer).
6+
To be used with [GameText](../functions/GameTextForPlayer) and [GameTextForAll](../functions/GameTextForAll).
77

88
## Text Colors
99

10-
- `~n~` New line
11-
12-
- `~r~` Red
13-
14-
- `~g~` Green
15-
16-
- `~b~` Blue
17-
18-
- `~w~` or ~s~ White
19-
20-
- `~y~` Yellow
21-
22-
- `~p~` Purple
23-
24-
- `~l~` Black (lower case L)
25-
26-
- `~h~` Turn text color lighter (used too much will make your text white, doesn't work on black)
10+
| Prefix | Description |
11+
| ---------- | ---------------------------------------------------------------------------------------- |
12+
| ~n~ | New line |
13+
| ~r~ | Red |
14+
| ~g~ | Green |
15+
| ~b~ | Blue |
16+
| ~w~ or ~s~ | White |
17+
| ~y~ | Yellow |
18+
| ~p~ | Purple |
19+
| ~l~ | Black (lower case L) |
20+
| ~h~ | Turn text color lighter (used too much will make your text white, doesn't work on black) |
2721

2822
## Special Text Letters
2923

30-
- `~u~` up arrow (gray)
31-
32-
- `~d~` down arrow (gray)
33-
34-
- `~<~` left arrow (gray)
35-
36-
- `~>~` right arrow (gray)
37-
38-
- `]` displays a \* symbol (Only in text styles 3, 4 and 5)
39-
40-
- `~k~` keyboard key mapping (e.g. ~k~\~VEHICLE_TURRETLEFT~ and ~k~\~PED_FIREWEAPON~). Look here for a list of keys
24+
| Prefix | Description |
25+
| ------ | ----------------------------------------------------------------------------------------------------------------------------------- |
26+
| ~u~ | Up arrow (gray) |
27+
| ~d~ | Down arrow (gray) |
28+
| ~\<~ | Left arrow (gray) |
29+
| ~>~ | Right arrow (gray) |
30+
| ] | Displays a \* symbol (Only in text styles 3, 4 and 5) |
31+
| ~k~ | Keyboard key mapping (e.g. ~k\~~VEHICLE_TURRETLEFT~ and ~k\~~PED_FIREWEAPON~). Look [here](../resources/keys.md) for a list of keys |
4132

4233
:::caution
4334

@@ -47,38 +38,12 @@ Be careful, using too many text colors or special characters in one gametext may
4738

4839
## Text Styles
4940

50-
### Style 0
51-
52-
![GameTextStyle0](/images/gameTextStyles/120px-Game-text-type0.png)
53-
54-
**Appears for 9 seconds regardless of time setting. Hides textdraws and any other gametext on screen.**
55-
56-
### Style 1
57-
58-
![GameTextStyle1](/images/gameTextStyles/120px-Game-text-type1.png)
59-
60-
**Fades out after 8 seconds, regardless of time set. If you have a time setting longer than that, it will re-appear after fading out and repeat until the time ends.**
61-
62-
### Style 2
63-
64-
![GameTextStyle2](/images/gameTextStyles/120px-Game-text-type2.png)
65-
66-
**Does not disappear until the player respawns.**
67-
68-
### Style 3
69-
70-
![GameTextStyle3](/images/gameTextStyles/120px-Game-text-type3.png)
71-
72-
### Style 4
73-
74-
![GameTextStyle4](/images/gameTextStyles/120px-Game-text-type4.png)
75-
76-
### Style 5
77-
78-
![GameTextStyle5](/images/gameTextStyles/120px-Game-text-type5.png)
79-
80-
**Displays for 3 seconds, regardless of what time you set. Will refuse to be shown if it is 'spammed'.**
81-
82-
### Style 6
83-
84-
![GameTextStyle6](/images/gameTextStyles/120px-Game-text-type6.png)
41+
| Style | Preview | Description |
42+
| ------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
43+
| Style 0 | ![](/images/gametextstyles/style0.png) | Appears for 9 seconds regardless of time setting. Hides textdraws and any other gametext on screen. |
44+
| Style 1 | ![](/images/gametextstyles/style1.png) | Fades out after 8 seconds, regardless of time set. If you have a time setting longer than that, it will re-appear after fading out and repeat until the time ends. |
45+
| Style 2 | ![](/images/gametextstyles/style2.png) | N/A |
46+
| Style 3 | ![](/images/gametextstyles/style3.png) | N/A |
47+
| Style 4 | ![](/images/gametextstyles/style4.png) | N/A |
48+
| Style 5 | ![](/images/gametextstyles/style5.png) | Displays for 3 seconds, regardless of what time you set. Will refuse to be shown if it is 'spammed'. |
49+
| Style 6 | ![](/images/gametextstyles/style6.png) | N/A |
-6.6 KB
Binary file not shown.
-6.51 KB
Binary file not shown.
-6.7 KB
Binary file not shown.
-6.28 KB
Binary file not shown.
-6.32 KB
Binary file not shown.
-6.93 KB
Binary file not shown.
-6.43 KB
Binary file not shown.

Diff for: static/images/gametextstyles/style0.png

103 KB
Loading

Diff for: static/images/gametextstyles/style1.png

106 KB
Loading

Diff for: static/images/gametextstyles/style2.png

109 KB
Loading

Diff for: static/images/gametextstyles/style3.png

106 KB
Loading

Diff for: static/images/gametextstyles/style4.png

105 KB
Loading

Diff for: static/images/gametextstyles/style5.png

106 KB
Loading

Diff for: static/images/gametextstyles/style6.png

111 KB
Loading

0 commit comments

Comments
 (0)