View source for CUtility

The CUtility class contains global utility related methods.

A single global Instance exists with the following declaration:

<code>CUtility g_Utility;</code>

This class only contains methods.
== Effects == 
{| class="wikitable" 
|- style="font-weight:bold; text-align:center; vertical-align:middle;"
! Declaration
! Description
|-
| <code>void BloodStream(const Vector& in vecOrigin, const Vector& in vecDirection, int iColor, int iAmount)</code>
| style="vertical-align:middle;" | Creates a blood stream. Use BLOOD_COLOR enum for the color.
|-
| <code>void BloodDrips(const Vector& in vecOrigin, const Vector& in vecDirection, int iColor, int iAmount)</code>
| style="vertical-align:middle;" | Creates blood drips. Use BLOOD_COLOR enum for the color.
|-
| <code>Vector RandomBloodVector()</code>
| style="vertical-align:middle;" | Returns a random blood direction vector
|-
| <code>bool ShouldShowBlood(int iBloodColor)</code>
| style="vertical-align:middle;" | Returns whether blood of the given type should be shown.
|-
| <code>void BloodDecalTrace(TraceResult& in trace, int iBloodColor)</code>
| style="vertical-align:middle;" | Applies blood decal to the trace hit location
|-
| <code>void DecalTrace(TraceResult& in trace, int iDecalNumber)</code>
| style="vertical-align:middle;" | Applies decal to the trace hit location
|-
| <code>void PlayerDecalTrace(TraceResult& in trace, int iPlayerNum, int iDecalNumber, const bool bIsCustom)</code>
| style="vertical-align:middle;" | Applies player decal to the trace hit location
|-
| <code>void GunshotDecalTrace(TraceResult& in trace, int iDecalNumber)</code>
| style="vertical-align:middle;" | Applies gunshot decal to the trace hit location
|-
| <code>void Sparks(const Vector& in vecPosition)</code>
| style="vertical-align:middle;" | Creates sparks at the given location
|-
| <code>void Ricochet(const Vector& in vecPosition, float flScale)</code>
| style="vertical-align:middle;" | Creates a ricochet at the given location
|-
| <code>float WaterLevel(const Vector& in vecPosition, float minz, float maxz)</code>
| style="vertical-align:middle;" | Determines the Z level at which a water surface level is, given a position to start searching from and a range to search.
|-
| <code>void Bubbles(const Vector& in vecMins, const Vector& in vecMaxs, int iCount)</code>
| style="vertical-align:middle;" | Creates a box filled with bubbles
|-
| <code>void BubbleTrail(const Vector& in vecFrom, const Vector& in vecTo, int iCount)</code>
| style="vertical-align:middle;" | Creates a trail of bubbles
|}
== Operations ==
{| class="wikitable" 
|- style="font-weight:bold; text-align:center; vertical-align:middle;"
! Declaration
! Description
|-
| <code>void StringToVector(Vector& out vecVector, const string& in szString, const char delimiter = char(' '))
| style="vertical-align:middle;" | Converts the given string to a vector
|-
| <code>void StringToRGBA(RGBA& out rgba, const string& in szString, const char delimiter = char(' '))
| style="vertical-align:middle;" | Converts the given string to an RGBA (alpha component is optional)
|-
| <code>bool IsStringInt(const string& in szString)
| style="vertical-align:middle;" | Returns whether the given string is an integer
|-
| <code>bool IsStringFloat(const string& in szString)
| style="vertical-align:middle;" | Returns whether the given string is a float
|-
| <code>bool IsWholeNumber(const float flNum, int& out iRounded)
| style="vertical-align:middle;" | Returns whether the given float is a whole number, and returns the rounded number
|-
| <code>bool IsString3DVec(const string& in szString)
| style="vertical-align:middle;" | Returns whether the given string is a 3D vector
|-
| <code>void GetCircularGaussianSpread(float& out x, float& out y) const
| style="vertical-align:middle;" | Gets circular gaussian spread.
|}

== [[Tracing]] methods ==
{| class="wikitable" 
|- style="font-weight:bold; text-align:center; vertical-align:middle;"
! Declaration
! Description
|-
| <code>void TraceLine(const Vector& in vecStart, const Vector& in vecEnd, IGNORE_MONSTERS igmon,edict_t@ pEntIgnore, TraceResult& out ptr)
| style="vertical-align:middle;" | Calculates a trace along the given line, storing the results in ptr.
|-
| <code>void TraceLine(const Vector& in vecStart, const Vector& in vecEnd, IGNORE_MONSTERS igmon,IGNORE_GLASS ignoreGlass, edict_t@ pEntIgnore, TraceResult& out ptr)
| style="vertical-align:middle;" | Calculates a trace along the given line, storing the results in ptr.
|-
| <code>void TraceHull(const Vector& in vecStart, const Vector& in vecEnd, IGNORE_MONSTERS igmon,HULL_NUMBER hullNumber, edict_t@ pEntIgnore, TraceResult& out ptr)
| style="vertical-align:middle;" | Calculates a trace along the given line, storing the results in ptr, using the specified hull type.
|-
| <code>void TraceToss(edict_t@ pEntity, edict_t@ pEntityToIgnore, TraceResult& out traceResult)
| style="vertical-align:middle;" | Trace toss
|-
| <code>bool TraceMonsterHull(edict_t@ pEntity, const Vector& in vecStart, const Vector& in vecEnd, IGNORE_MONSTERS igmon, edict_t@ pEntityToIgnore, TraceResult& out ptr)
| style="vertical-align:middle;" | Trace monster hull. Returns true if the trace was entirely in a solid object, or hit something.
|-
| <code>void TraceModel(const Vector& in vecStart, const Vector& in vecEnd, int iHullNumber, edict_t@ pEntityToIgnore, TraceResult& out ptr)
| style="vertical-align:middle;" | TraceModel
|-
| <code>string TraceTexture(edict_t@ pEntity, const Vector& in vecStart, const Vector& in vecEnd)
| style="vertical-align:middle;" | Trace texture
|-
| <code>void FindHullIntersection(const Vector& in vecSrc, TraceResult& in inTr, TraceResult& out outTr, const Vector& in vecMins, const Vector& in vecMaxs, edict_t@ pEntity, float flDistance = 1e6f)
| style="vertical-align:middle;" | Finds the hull intersection from a traceline in a given set of bounds. The bounds are relative to the input traceline's endpoint.<br />The given entity is the entity performing the traceline.
|-
| <code>CBaseEntity@ FindEntityForward(CBaseEntity@ pLooker, float flMaxDistance)
| style="vertical-align:middle;" | Convience function that finds the entity that the given entity is currently looking at.
|-
| <code>CBaseEntity@ FindEntityForward(CBaseEntity@ pLooker)
| style="vertical-align:middle;" | Convience function that finds the entity that the given entity is currently looking at. Uses a maximum distance of 12048 units.
|-
| <code>TraceResult GetGlobalTrace()
| style="vertical-align:middle;" | Gets the global trace data stored in g_Engine as a TraceResult object.
|}

== Misc ==
{| class="wikitable" 
|- style="font-weight:bold; text-align:center; vertical-align:middle;"
! Declaration
! Description
|-
| <code>bool IsPlayerInVolume(CBasePlayer@ pPlayer, CBaseEntity@ pEntityVolume)
| style="vertical-align:middle;" | Returns whether the given player is in the given volume.
|-
| <code>int CountPlayersInBrushVolume(const bool fIgnoreDeadPlayers, CBaseEntity@ pBrushVolume,int& out iOutPlayersInsideVolume, int& out iOutPlayersOutsideVolume, PlayerInVolumeListener@ pListener)
| style="vertical-align:middle;" | Counts the number of players inside and outside a brush volume.
|-
| <code>bool VoteActive() const
| style="vertical-align:middle;" | Returns whether a vote is active. This only covers the votes started using the in-game vote menu, trigger_vote and the Vote class.
|-
| <code>string BuildEntityLogString(const string& in szName, const string& in szUserID = NULL, const string& in szAuthID = NULL, const string& in szTeam = NULL) const
| style="vertical-align:middle;" | Builds a generic entity log string.
|-
| <code>string BuildPlayerLogString(const string& in szName, const string& in szUserID = NULL, const string& in szAuthID = NULL) const
| style="vertical-align:middle;" | Builds a generic player log string.
|-
| <code>string GetPlayerLog(edict_t@ pPlayerEdict) const
| style="vertical-align:middle;" | Get a player log string.
|}
[[Category:Scripting]]