Difference between revisions of "SayParameters"

From Sven Co-op
Jump to navigation Jump to search
(Created page with "The SayParameters class contains a player's text data when they say something in game chat. It can be used to interpret the text as though it were a command, and its visibilit...")
 
m
 
Line 9: Line 9:
 
! Description
 
! Description
 
|-
 
|-
| CBasePlayer@ GetPlayer() const
+
| <code>CBasePlayer@ GetPlayer() const
 
| Gets the player that is saying something.
 
| Gets the player that is saying something.
 
|-
 
|-
| ClientSayType GetSayType() const
+
| <code>ClientSayType GetSayType() const
 
| Gets the say type of this text.
 
| Gets the say type of this text.
 
|-
 
|-
| const string& GetCommand() const
+
| <code>const string& GetCommand() const
 
| Gets the entire command string.
 
| Gets the entire command string.
 
|-
 
|-
| const CCommand@ GetArguments() const
+
| <code>const CCommand@ GetArguments() const
 
| Gets the arguments in this command.
 
| Gets the arguments in this command.
 
|}
 
|}
 
[[Category:Scripting]]
 
[[Category:Scripting]]

Latest revision as of 16:05, 21 October 2025

The SayParameters class contains a player's text data when they say something in game chat. It can be used to interpret the text as though it were a command, and its visibility can be controlled. This is used for ClientSay hook.

It has a single property bool ShouldHide: Controls whether this text will be hidden or not. This is implemented as a property accessor and mutator. Default false.

Function Description
CBasePlayer@ GetPlayer() const Gets the player that is saying something.
ClientSayType GetSayType() const Gets the say type of this text.
const string& GetCommand() const Gets the entire command string.
const CCommand@ GetArguments() const Gets the arguments in this command.