3.3.1 Update (#36)

etjump · Nov 16, 2024 · 3630b46 · 3630b46
1 parent 898c393
commit 3630b46
Show file tree

Hide file tree

Showing 7 changed files with 210 additions and 75 deletions.
diff --git a/docs/basic_features.md b/docs/basic_features.md
@@ -143,6 +143,28 @@ You can send private messages to other players by typing `/m <name|clientnum> <m
 
 ```{note}
 Private messages are sent to all players who's name match `<name>` partially. If you want to make sure you're only sending the message to a single client, it's safer to use `<clientnum>`.
+
+If playing with ET: Legacy client, you can enable window flashing for incoming private messages if the game is minimized by setting the bit **2** on [`etj_highlight`](client/etjump_cvars.md/#etj_highlight).
+```
+
+---
+
+## Fireteams
+Fireteams in ETJump are team-agnostic, meaning there are no restrictions on which team the members of the fireteam are allowed to be in. Fireteams provide additional functionality to the gameplay by allowing players to enable features only for the members of the fireteam.
+
+### Rules
+
+Fireteam members can set "rules" amongst themselves. The available rules are following:
+
+* `noghost` - fireteam members can toggle player collision between the members.
+* `savelimit` - fireteam members can limit the number of [`save`](client/client_commands.md/#save) commands each member is allowed to use.
+
+### Teamjump mode
+
+When teamjump mode is enabled, [`target_ftrelay`](mapping/mapping_entities.md/#target_ftrelay) entity activates targets for each of the fireteam members.
+
+```{seealso}
+[`fireteam`](client/client_commands.md/#fireteam)
 ```
 
 ---

diff --git a/docs/client/client_commands.md b/docs/client/client_commands.md
@@ -6,11 +6,7 @@ Below is a list of all available ETJump related console commands for players.
 ## ad_save
 `ad_save [name]`
 
-Saves the current temp demo recorded by autodemo with the given name. The manually saved autodemo naming format is `playername_map_name[DD-MM-YY-HHMMSS]`. If no name is given, defaults to `demo`.
-
-```{note}
-This only saves the latest temp demo recorded with [`etj_autoDemo`](etjump_cvars.md/#etj_autodemo). If you are manually recording a demo and use this command, it will take the latest `temp/temp_N.dm_84` and save that. The manually recorded demo will be saved normally into whatever folder you're recording into, with the name it was recorded with.
-```
+Saves the current temp demo recorded with [`etj_autoDemo`](etjump_cvars.md/#etj_autodemo) with the given name. The manually saved autodemo naming format is `playername_map_name[DD-MM-YY-HHMMSS]`. If no name is given, defaults to `demo`.
 
 ---
 
@@ -111,6 +107,20 @@ Prints the list of bitflag values for [`etj_extraTrace`](etjump_cvars.md/#etj_ex
 
 ---
 
+## fireteam
+`fireteam rules <rule> <value>`  
+`fireteam tj|teamjump <on|1> <off|0>`  
+
+Executes fireteam actions. Can only be set by the fireteam admin.
+
+Enabling teamjump mode is required for [`target_ftrelay`](../mapping/mapping_entities.md/#target_ftrelay) to activate targets for each fireteam member.
+
+Available rules:
+* `noghost <on|1> <off|0>` - toggles player collision between fireteam members
+* `savelimit <limit (-1 - 100|reset)>` - sets savelimit for fireteam members. `-1` means no limit. `reset` restores all the available saves for each member.
+
+---
+
 ## goto
 `goto <name|clientnum>`
 

diff --git a/docs/client/etjump_cvars.md b/docs/client/etjump_cvars.md
@@ -125,6 +125,15 @@ Time in milliseconds to delay the stopping and saving of autodemo when a timerun
 
 ---
 
+## etj_ad_stopInSpec
+Cvar                    | Values        | Default
+:-----------------------|:--------------|:------------
+etj_ad_stopInSpec       | 0 or 1        | 1
+
+Toggles whether currently recorded autodemo temp demo is automatically stopped when the player joins spectators.
+
+---
+
 ## etj_ad_targetPath
 Cvar                    | Values        | Default
 :-----------------------|:--------------|:------------
@@ -203,6 +212,19 @@ Time in milliseconds the player has to be idle in free spec before automatically
 
 ---
 
+## etj_autoSprint
+Cvar                    | Values        | Default
+:-----------------------|:--------------|:------------
+etj_autoSprint          | 0 or 1        | 0
+
+Automatically sprint instead of run.
+
+```{tip}
+When enabled, the behavior of `+sprint` key is flipped - pressing the key enables running instead of sprinting.
+```
+
+---
+
 ## etj_CGaz1Color1
 Cvar                    | Values                                           | Default
 :-----------------------|:-------------------------------------------------|:------------
@@ -1461,15 +1483,28 @@ When this cvar is enabled, along with your player model, several other aspects o
 * Item pickup sounds
 ```
 
+```{note}
+If the player is in a fireteam with [`noghost`](./client_commands.md/#fireteam) enabled, `etj_hideMe` is automatically disabled.
+```
+
 ---
 
 ## etj_highlight
 Cvar                    | Values        | Default
 :-----------------------|:--------------|:------------
-etj_highlight           | 0 or 1        | 1
+etj_highlight           | bitflag       | 1
 
 Toggles highlighting chat messages if your name was mentioned.
 
+* **0** off
+* **1** highlight the message and play a sound
+* **2** flash the game window if minimized (ET: Legacy only)
+  * If this is set, the game window also flashes on incoming private messages
+
+```{seealso}
+[`etj_highlightSound`](etjump_cvars.md/#etj_highlightsound)
+```
+
 ---
 
 ## etj_highlightSound
@@ -2469,6 +2504,30 @@ Sets vertical position of the slick detector.
 
 ---
 
+## etj_smoothAngles
+Cvar                    | Values        | Default
+:-----------------------|:--------------|:------------
+etj_smoothAngles        | 0 or 1        | 1
+
+Enables pmove-independent viewangle updates. When enabled, clients viewangle updates are not limited to `pmove_msec` intervals (8ms by default), but can be updated each frame that the client renders, allowing for smoother gameplay.
+
+```{note}
+This does not affect physics calculations, they are still performed with viewangles calculated at `pmove_msec` intervals.
+```
+
+```{note}
+The functionality is disabled in the following scenarios:
+* spectating
+* demo playback
+* `pmove_fixed 0`
+* prone
+* using set weapons (mobile mg42, mortar)
+* mounted mg42/tank
+* wounded state
+```
+
+---
+
 ## etj_snapHUDActiveIsPrimary
 Cvar                       | Values        | Default
 ---------------------------|:--------------|:------------
@@ -2482,6 +2541,19 @@ This can be used independently, without enabling [`etj_snapHUDHLActive`](etjump_
 
 ---
 
+## etj_snapHUDBorderThickness
+Cvar                       | Values        | Default
+---------------------------|:--------------|:------------
+etj_snapHUDBorderThickness | 0.1 - 10.0    | 1
+
+Sets the thickness of snaphud borders when [`etj_drawSnapHUD`](etjump_cvars.md/#etj_drawsnaphud) is set to **3**.
+
+```{note}
+The maximum value is also capped to [`etj_snapHUDHeight`](etjump_cvars.md/#etj_snaphudheight) * 2, to avoid the borders from "bleeding over".
+```
+
+---
+
 ## etj_snapHUDColor1
 Cvar                    | Values                                           | Default
 :-----------------------|:-------------------------------------------------|:------------
@@ -3016,7 +3088,7 @@ etj_viewlog             | 0 or 1        | 1
 Toggles external console window. Only works on Windows.
 
 ```{note}
-ET: Legacy client requires you to start the game with `+set viewlog 1`, the console window cannot be created or re-created if closed while the game is running.
+If playing with ET: Legacy client, you must use version **2.83.0** or newer to be able to create the console window while the game is running. Older versions require you to start the game with `+set viewlog 1`, the console window cannot be created or re-created if closed while the game is running.
 ```
 
 ```{hint}

diff --git a/docs/client/etmain_cvars.md b/docs/client/etmain_cvars.md
@@ -5,7 +5,7 @@ The following ETMain cvars have been modified or extended by ETJump.
 ---
 
 ## cg_autoswitch
-Name                    | Values        | Default
+Cvar                    | Values        | Default
 :-----------------------|:--------------|:------------
 cg_autoswitch           | bitflag       | 0
 
@@ -23,7 +23,7 @@ ETJump has added additional control to the behavior of this cvar.
 ---
 
 ## cg_centertime
-Name                    | Values             | Default
+Cvar                    | Values             | Default
 :-----------------------|:-------------------|:------------
 cg_centertime           | any positive value | 5
 
@@ -36,7 +36,7 @@ ETJump has removed cheat protection from this cvar.
 ---
 
 ## cg_crosshairSize
-Name                    | Values             | Default
+Cvar                    | Values             | Default
 :-----------------------|:-------------------|:------------
 cg_crosshairSize        | any positive value | 48
 
@@ -49,7 +49,7 @@ ETJump allows using floating point values for this cvar.
 ---
 
 ## cg_crosshairX
-Name                    | Values        | Default
+Cvar                    | Values        | Default
 :-----------------------|:--------------|:------------
 cg_crosshairX           | any value     | 0
 
@@ -62,7 +62,7 @@ ETJump allows using floating point values for this cvar.
 ---
 
 ## cg_crosshairY
-Name                    | Values        | Default
+Cvar                    | Values        | Default
 :-----------------------|:--------------|:------------
 cg_crosshairY           | any value     | 0
 
@@ -75,7 +75,7 @@ ETJump allows using floating point values for this cvar.
 ---
 
 ## cg_drawCrosshair
-Name                    | Values        | Default
+Cvar                    | Values        | Default
 :-----------------------|:--------------|:------------
 cg_drawCrosshair        | 0 - 16        | 1
 
@@ -97,7 +97,7 @@ ETJump has added crosshairs **10-16**.
 ---
 
 ## cg_drawWeaponIconFlash
-Name                    | Values        | Default
+Cvar                    | Values        | Default
 :-----------------------|:--------------|:------------
 cg_drawWeaponIconFlash  | 0 - 2         | 0
 
@@ -119,7 +119,7 @@ ETJump has added value **2**, which mimics ETPro/legacy behavior for the weapon
 ---
 
 ## cg_gunX/Y/Z
-Name                    | Values        | Default
+Cvar                    | Values        | Default
 :-----------------------|:--------------|:------------
 cg_gunX/Y/Z             | any value     | 0
 
@@ -132,7 +132,7 @@ ETJump has removed cheat protection from these cvars.
 ---
 
 ## cg_lagometer
-Name                    | Values        | Default
+Cvar                    | Values        | Default
 :-----------------------|:--------------|:------------
 cg_lagometer            | 0 - 2         | 0
 
@@ -148,7 +148,7 @@ ETJump has added value **2**.
 ---
 
 ## cg_showmiss
-Name                    | Values        | Default
+Cvar                    | Values        | Default
 :-----------------------|:--------------|:------------
 cg_showmiss             | bitflag       | 0
 
@@ -167,7 +167,7 @@ ETJump has changed this cvar to a bitflag, and added values **2**, **8** and **1
 ---
 
 ## cg_skybox
-Name                    | Values        | Default
+Cvar                    | Values        | Default
 :-----------------------|:--------------|:------------
 cg_skybox               | 0 or 1        | 1
 
@@ -180,7 +180,7 @@ ETJump has removed cheat protection from this cvar.
 ---
 
 ## cg_teamChatHeight
-Name                    | Values        | Default
+Cvar                    | Values        | Default
 :-----------------------|:--------------|:------------
 cg_teamChatHeight       | 0 - 64        | 8
 

diff --git a/docs/mapping/mapping_entities.md b/docs/mapping/mapping_entities.md
@@ -70,9 +70,10 @@ When a button is used, it moves some distance in the direction of it's angles, t
 
 **Keys**
 
-| Key   | Value        | Default                         | Description                                                             |
-| :---- | :----------- | :------------------------------ | :---------------------------------------------------------------------- |
-| noise | path to .wav | sound/movers/switches/butn2.wav | Sound to play on activation. Use `nosound` to disable sound completely. |
+| Key        | Value           | Default                         | Description                                                                     |
+| :--------- | :-------------- | :------------------------------ | :------------------------------------------------------------------------------ |
+| noise      | path to .wav    | sound/movers/switches/butn2.wav | Sound to play on activation. Use `nosound` to disable sound completely.         |
+| cursorhint | cursorhint name |                                 | Sets a custom cursorhint for the button. If not set, defaults to `HINT_BUTTON`. |
 
 **Spawnflags**
 

diff --git a/docs/mapping/mapscripting.md b/docs/mapping/mapscripting.md
@@ -4,6 +4,15 @@ ETJump adds new scripting actions, events and entities for mapscripting. Below i
 
 ---
 
+## changemodel
+`changemodel <path/to/model.md3>`
+
+Changes the entitys model to the given model.
+
+```{tip}
+This script action is present in ETMain but only works for brush entities using `model2` key. ETJump allows this to be used to change models of `misc_gamemodel` entities as well.
+```
+
 ## create
 
 ```