fix: Simplified Script_EyeAngles, updated comments, and added new VScript functions to README

Author: OrsellGit

README.md

@@ -15,31 +15,36 @@ The purpose of this plugin is to patch Portal 2 to make the mod work as well as
 Note: While represented in C++, below functions are for Squirrel. `const char*` type is translated to `string` type. `byte`, `short`, and `long` types are translated to `integer` type. `void` types are simply the `function` type in Squirrel. `HSCRIPT` is a VScript script handle which is an entity instance.
 
 ```c++
-void        printlP2MM(int level, bool dev, const char* pMsgFormat);   | "Logging for the P2MM VScript. The log message must be passed as a string or it will error."
-const char* GetPlayerName(int playerIndex);                            | "Gets player username by their entity index."
-int         GetSteamID(int playerIndex);                               | "Gets the account ID component of player SteamID by the player's entity index."
-int         UserIDToPlayerIndex(int userid);                           | "Get the player's entity index by their userid."
-bool        IsMapValid(const char* map);                               | "Returns true is the supplied string is a available map to load and run."
-int         GetDeveloperLevelP2MM();                                   | "Returns the value of ConVar p2mm_developer."
-bool        IsDedicatedServer();                                       | "Returns true if this is a dedicated server."
-void        InitializeEntity(HSCRIPT ent);                             | "Initializes, spawns, then activates an entity in the map. Create a entity using CreateByClassname, then use this function on its handle. Note: Not all entities will work even after being initialized with this function."
-void        SendToChat(const char* msg, int playerIndex);              | "Sends a raw message to the chat HUD. Specifying no playerIndex or 0 sends to all players. Supports printing localization strings but those that require formatting can't be formatted."
-const char* GetGameMainDir();                                          | "Returns the current game directory. Ex. portal2"
-const char* GetGameRootDir();                                          | "Returns the current root game directory. Ex. Portal 2"
-void        CallFirstRunPrompt();                                      | "Shows the first run prompt if enabled in config.nut."
-int         GetConVarInt(const char* cvName);                          | "Get the integer value of a ConVar."
-const char* GetConVarString(const char* cvName);                       | "Get the string value of a ConVar."
-void        SetConVarInt(const char* cvName, int newValue);            | "Set the integer value of a ConVar."
-void        SetConVarString(const char* cvName, const char* newValue); | "Set the string value of a ConVar."
-HSCRIPT     PlayerByIndex(int playerIndex);                            | "Takes the player's entity index and returns the player's script handle."
-void        RespawnPlayer(int playerIndex);                            | "Respawn the a player by their entity index."
-void        SetFlashlightState(int playerIndex, bool enable);          | "Set the flashlight for a player on or off."
-void        ConsolePrint(int playerIndex, const char* msg);            | "Print a message to a player's console, unlike printl() which is just the host. Specifying no playerIndex or 0 sends to all players. Supports printing localization strings but those that require formatting can't be formatted."
-void        ClientPrint(int playerIndex, const char* msg);             | "Print a message to the top center position of a player's screen. Specifying no playerIndex or 0 sends to all players. Supports printing localization strings but those that require formatting can't be formatted."
-void        HudPrint(int playerIndex, const char* msg, Vector(float x, float y, int channel), int effect, float fxTime, Vector RGB1, float alpha1, Vector RGB2, float alpha2, Vector(float fadeinTime, float fadeoutTime, float holdTime));
-                                                                       | "Print a message to the screen based on what the game_text entity does, with many values to set. See Valve Developer Commentary for the game_text entity to see what each field does. Vectors are in place for sets of RGB values. Specifying no playerIndex or 0 sends to all players. Supports printing localization strings but those that require formatting can't be formatted."
-int         GetMaxPlayers();                                           | "Self-explanatory."
-void        ShowScoreboard(int playerIndex, bool bEnable);             | "Enable or disable displaying the score board a player."
+void          printlP2MM(int level, bool dev, const char* pMsgFormat);   | "Logging for the P2MM VScript. The log message must be passed as a string or it will error."
+const char*   GetPlayerName(int playerIndex);                            | "Gets player username by their entity index."
+int           GetSteamID(int playerIndex);                               | "Gets the account ID component of player SteamID by the player's entity index."
+int           UserIDToPlayerIndex(int userid);                           | "Get the player's entity index by their userid."
+bool          IsMapValid(const char* map);                               | "Returns true is the supplied string is a available map to load and run."
+int           GetDeveloperLevelP2MM();                                   | "Returns the value of ConVar p2mm_developer."
+bool          IsDedicatedServer();                                       | "Returns true if this is a dedicated server."
+void          InitializeEntity(HSCRIPT ent);                             | "Initializes, spawns, then activates an entity in the map. Create a entity using CreateByClassname, then use this function on its handle. Note: Not all entities will work even after being initialized with this function."
+void          SendToChat(const char* msg, int playerIndex);              | "Sends a raw message to the chat HUD. Specifying no playerIndex or 0 sends to all players. Supports printing localization strings but those that require formatting can't be formatted."
+const char*   GetGameMainDir();                                          | "Returns the current game directory. Ex. portal2"
+const char*   GetGameRootDir();                                          | "Returns the current root game directory. Ex. Portal 2"
+void          CallFirstRunPrompt();                                      | "Shows the first run prompt if enabled in config.nut."
+int           GetConVarInt(const char* cvName);                          | "Get the integer value of a ConVar."
+const char*   GetConVarString(const char* cvName);                       | "Get the string value of a ConVar."
+void          SetConVarInt(const char* cvName, int newValue);            | "Set the integer value of a ConVar."
+void          SetConVarString(const char* cvName, const char* newValue); | "Set the string value of a ConVar."
+HSCRIPT       PlayerByIndex(int playerIndex);                            | "Takes the player's entity index and returns the player's script handle."
+void          RespawnPlayer(int playerIndex);                            | "Respawn the a player by their entity index."
+void          SetFlashlightState(int playerIndex, bool enable);          | "Set the flashlight for a player on or off."
+void          ConsolePrint(int playerIndex, const char* msg);            | "Print a message to a player's console, unlike printl() which is just the host. Specifying no playerIndex or 0 sends to all players. Supports printing localization strings but those that require formatting can't be formatted."
+void          ClientPrint(int playerIndex, const char* msg);             | "Print a message to the top center position of a player's screen. Specifying no playerIndex or 0 sends to all players. Supports printing localization strings but those that require formatting can't be formatted."
+void          HudPrint(int playerIndex, const char* msg, Vector(float x, float y, int channel), int effect, float fxTime, Vector RGB1, float alpha1, Vector RGB2, float alpha2, Vector(float fadeinTime, float fadeoutTime, float holdTime));
+                                                                         | "Print a message to the screen based on what the game_text entity does, with many values to set. See Valve Developer Commentary for the game_text entity to see what each field does. Vectors are in place for sets of RGB values. Specifying no playerIndex or 0 sends to all players. Supports printing localization strings but those that require formatting can't be formatted."
+int           GetMaxPlayers();                                           | "Return max amount of players that can be in the server."
+void          ShowScoreboard(int playerIndex, bool bEnable);             | "Enable or disable displaying the score board a player."
+void          RemovePlayerUI(const int playerIndex, const bool bBanning) | "Display UI for either banning or kicking so host can ban or kick a player. WIP, need to manually open pause menu to see VGUI"
+float         TraceLineEx(const Vector& vecAbsStart, const Vector& vecAbsEnd, const int mask, const HSCRIPT ignore, const int collisionGroup)
+                                                                         | "Improved version of TraceLine that allows for checking with bit masks and collision groups. Returns a fraction of line where a collision occured, or if in a solid, the amount spent outside the solid."
+const Vector& Script_EyeAngles(const int playerIndex)                    | "Get the eye angles of a player. WIP seems to crash."
+
 ```
 
 ## Game Events Interfaced To Squirrel VScript Functions:

vscript.cpp

@@ -303,7 +303,7 @@ static void ShowScoreboard(const int playerIndex, const bool enable)
  * @param mask Bit mask used for determining what objects should be hit.
  * @param ignore A entity for the trace line to ignore, typically this is for a trace line originating from a entity.
  * @param collisionGroup Collision group that the trace line can hit.
- * @return 
+ * @return Returns a fraction of line where a collision occured, or if in a solid, the amount spent outside the solid.
  */
 static float Script_UTIL_TraceLine(const Vector& vecAbsStart, const Vector& vecAbsEnd, const int mask, const HSCRIPT ignore, const int collisionGroup)
 {
@@ -323,12 +323,8 @@ static float Script_UTIL_TraceLine(const Vector& vecAbsStart, const Vector& vecA
  */
 static const Vector& Script_EyeAngles(const int playerIndex)
 {
-	Vector eyeVector;
 	const QAngle eyeAngles = CBasePlayer__EyeAngles(playerIndex);
-	eyeVector.x = eyeAngles.x;
-	eyeVector.y = eyeAngles.y;
-	eyeVector.z = eyeAngles.z;
-	return eyeVector;
+	return Vector(eyeAngles.x, eyeAngles.y, eyeAngles.z);
 }
 
 void RegisterFuncsAndRun()
@@ -374,7 +370,7 @@ void RegisterFuncsAndRun()
 													   "Supports printing localization strings but those that require formatting can't be formatted."
 													   "Vectors are used to consolidate some parameters so function isn't monstrously big."
 	);
-	ScriptRegisterFunction	   (g_pScriptVM, GetMaxPlayers, "Returns the current max players in the server.");
+	ScriptRegisterFunction	   (g_pScriptVM, GetMaxPlayers, "Return max amount of players that can be in the server.");
 	ScriptRegisterFunction	   (g_pScriptVM, ShowScoreboard, "Enable or disable displaying the score board for players.");
 	ScriptRegisterFunction	   (g_pScriptVM, RemovePlayerUI, "Display UI for either banning or kicking so host can ban or kick a player.");
 	ScriptRegisterFunctionNamed(g_pScriptVM, Script_UTIL_TraceLine, "TraceLineEx", "Improved version of TraceLine that allows for checking with bit masks and collision groups.");