UNLOZE/sourcemod
10
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add clarification to documentation for hud messages and engine dialogs (#1888)

Browse Source 
with regard to game support.
This commit is contained in:
Nicholas Hastings 2022-12-19 18:49:48 -05:00 committed by GitHub
parent 3a315e88c2
commit 2d5bc4007f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
plugins/include/halflife.inc
View File

@ -331,6 +331,10 @@ native bool IsSoundPrecached(const char[] sound);
/**
* Creates different types of ingame messages.
*
* Note: On many newer games (Left 4 Dead/2008+), the display of this to clients is broken.
* Additionally, as of 2018, some games also require the client to have cl_showpluginmessages
* set to 1, a non-default value, for this to function.
*
* @param client Index of the client.
* @param kv KeyValues handle to set the menu keys and options. (Check iserverplugin.h for more information).
* @param type Message type to display ingame.
@ -587,7 +591,7 @@ native void ClearSyncHud(int client, Handle sync);
/**
* Shows a HUD message to a client on the given channel.
*
* As of this writing, only TF, HL2MP, and SourceForts support HUD Text.
* Note: while many games support HUD Text, not all do.
*
* @param client Client index to send the message to.
* @param channel A channel number.
@ -629,6 +633,10 @@ stock void ShowMOTDPanel(int client, const char[] title, const char[] msg, int t
/**
* Displays a panel asking the client to connect to a specified IP.
*
* Note: On many newer games (Left 4 Dead/2008+), the display of this to clients is broken.
* Additionally, as of 2018, some games also require the client to have cl_showpluginmessages
* set to 1, a non-default value, for this to function.
*
* @param client Client index.
* @param time Duration to hold the panel on the client's screen.