Skip to content

Commit e81ca9e

Browse files
authored
Update README.md
1 parent cb09131 commit e81ca9e

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,11 @@ Extract/copy the files into the game folder.
77
Currently the extension only supports 32-bit TF2, but it can in idea work with other games by expanding the gamedata.
88

99
## Usage
10-
The extension works with entity properties, the same that you're used to with the `SetEntProp[Type]` functions, except it doesn't set the entity property itself, but instead modifies the sent value. Since not all properties are networkable, the extension allows you to verify if an entity property is networkable through `HasNetworkableProp`. After you know a property is networkable, you can set its sent value with `SetSendVar`, replace it only if its already going to be sent with `ReplaceSendVar`, or prevent it from being sent with `OmitSendVar`. `SetSendVar` and `ReplaceSendVar` take a custom value that are stored in a handle. These handles can be created with the `SendVar[Type]` functions, where `Type` is the sent type of the property. All handles are automatically freed at the end of the frame, so you can use `SendVar[Type]` directly in the argument of `[Set/Replace]SendVar` without worry. Some properties go through a conversion function called a proxy that might even change its sent type, so make sure to use the proxy output instead if it exists. The extension provides a few such proxies named `SendProxy[Type]` for convenience. It is not guaranteed that a client will receive an update every frame (`cl_updaterate` < tickrate), so the the extension will remember every edit until then to make sure no action ends up missing its mark. It is possible get notified when such a client update will happen by subscribing to the forward `OnCheckTransmit`. The forward can also be used to control what entities get sent to the client in cases where hiding or transmitting an entity through walls is desirable. The extension additionally includes the forwards `OnSendClientMessages` and `OnSendClientMessagesPost` to let you know whenever the server is preparing to send out updates to clients and when it is done doing so.
10+
The extension works with entity properties, the same that you're used to with the `SetEntProp[Type]` functions, except it doesn't set the entity property itself, but instead modifies the sent value. Since not all properties are networkable, the extension allows you to verify if an entity property is networkable through `HasNetworkableProp`. After you know a property is networkable, you can set its sent value with `SetSendVar`, replace it only if its already going to be sent with `ReplaceSendVar`, or prevent it from being sent with `OmitSendVar`.
11+
12+
`SetSendVar` and `ReplaceSendVar` take a custom value that are stored in a handle. These handles can be created with the `SendVar[Type]` functions, where `Type` is the sent type of the property. All handles are automatically freed at the end of the frame, so you can use `SendVar[Type]` directly in the argument of `[Set/Replace]SendVar` without worry. Some properties go through a conversion function called a proxy that might even change its sent type, so make sure to use the proxy output instead if it exists. The extension provides a few such proxies named `SendProxy[Type]` for convenience.
13+
14+
It is not guaranteed that a client will receive an update every frame (`cl_updaterate` < tickrate), so the the extension will remember every edit until then to make sure no action ends up missing its mark. It is possible get notified when such a client update will happen by subscribing to the forward `OnCheckTransmit`. The forward can also be used to control what entities get sent to the client in cases where hiding or transmitting an entity through walls is desirable. The extension additionally includes the forwards `OnSendClientMessages` and `OnSendClientMessagesPost` to let you know whenever the server is preparing to send out updates to clients and when it is done doing so.
1115

1216
## Compiling
1317
1. Install AMBuild.

0 commit comments

Comments
 (0)