Category:UTIL: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Tried to make some pretty colors to go with the new category. Has an extra space after it. Feel free to fix it :))
(Clarity and grammar.)
 
(22 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{lang|Category:UTIL}}
{{category header|background-color=#E0E0E0|border-color=lightgray}}
{{category header|background-color=#E0E0E0|border-color=lightgray}}
{{category newcolumn|rowspan=99|width=50%|background-color=#F7F7F7|border-color=lightgray}}
{{category newcolumn|rowspan=99|width=50%|background-color=#F7F7F7|border-color=lightgray}}


== UTIL(ities) ==
== UTIL(ities) ==
The Source Engine comes with a variety of built in Utilities, or UTIL_ functions. These range from things like the safe removal of objects, to TraceLines, and Precaching assets.  
The Source Engine has utility functions, that are commonly prefixed with 'UTIL_', for performing common functions, such as safe removal of objects, trace lines, and precaching assets.


== Blood ==
== Traces ==
* [[UTIL_BloodDecalTrace]]
* [[UTIL_TraceLine]]
* [[UTIL_BloodDrips]]
* [[UTIL_TraceEntity]]
* [[UTIL_BloodImpact]]
* [[UTIL_TraceLineFilterEntity]]
* [[UTIL_BloodSpray]]
* [[UTIL_TraceHull]]
* [[UTIL_BloodStream]]
* [[UTIL_TraceModel]]
* [[UTIL_ShouldShowBlood]]
* [[UTIL_SetTrace]]
* [[UTIL_ClearTrace]]
* [[UTIL_ClipTraceToPlayers]]
* [[UTIL_TraceRay]]


== Finding Entities in Space  ==
== Finding Entities in Space  ==
Line 23: Line 28:


== Set Properties ==
== Set Properties ==
* [[UTIL_SetTrace]]
* [[UTIL_SetSize]]
* [[UTIL_SetSize]]
* [[UTIL_SetModel]]
* [[UTIL_SetModel]]
Line 30: Line 34:


== Other ==
== Other ==
{{todo|Categorize these}}
* [[UTIL_AddDebugLine]]
* [[UTIL_PrecacheDecal]]
* [[UTIL_BoundToWorldSize]]
* [[UTIL_GetSimulationInterval]]
* [[UTIL_CheckBottom]]
* [[UTIL_ClipPunchAngleOffset]]
* [[UTIL_ComputeAABBForBounds]]
* [[UTIL_ComputeEntityFade]]
* [[UTIL_ComputerStringWidth]]
* [[UTIL_DecodeICE]]
* [[UTIL_DisableRemoveImmediate]]
* [[UTIL_DistApprox2D]]
* [[UTIL_DistApprox]]
* [[UTIL_DotPoints]]
* [[UTIL_DrawOverlayLines]]
* [[UTIL_DropToFloor]]
* [[UTIL_DropToFloor]]
* [[UTIL_CheckBottom]]
* [[UTIL_EmitAmbientSound]]
* [[UTIL_Remove]]
* [[UTIL_EmitGroupnameSuit]]
* [[UTIL_RemoveImmediate]]
* [[UTIL_EmitSoundSuit]]
* [[UTIL_EnableRemoveImmediate]]
* [[UTIL_EnableRemoveImmediate]]
* [[UTIL_DisableRemoveImmediate]]
* [[UTIL_PlayerByIndex]]
* [[UTIL_PlayerByName]]
* [[UTIL_PlayerByUserId]]
* [[UTIL_GetLocalPlayer]]
* [[UTIL_GetListenServerHost]]
* [[UTIL_IsCommandIssuedByServerAdmin]]
* [[UTIL_EntityByIndex]]
* [[UTIL_EntityByIndex]]
* [[UTIL_GetPlayerConnectionInfo]]
* [[UTIL_EntityHasMatchingRootParent]]
* [[UTIL_ClientPrintFilter]]
* [[UTIL_EntityInSolid]]
* [[UTIL_ClientPrintAll]]
* [[UTIL_FindWaterSurface]]
* [[UTIL_FreeFile]]
* [[UTIL_FunctionFromName]]
* [[UTIL_FunctionToName]]
* [[UTIL_GetAchievementEventMask]]
* [[UTIL_GetMapKeyCount]]
* [[UTIL_GetMapLoadCountFileName]]
* [[UTIL_GetModDir]]
* [[UTIL_GetNormalizedColorTintAndLuminosity]]
* [[UTIL_GetSimulationInterval]]
* [[UTIL_IncrementMapKey]]
* [[UTIL_IsFacingWithinTolerance]]
* [[UTIL_IsMasterTriggered]]
* [[UTIL_IsValidEntity]]
* [[UTIL_LoadActivityRemapFile]]
* [[UTIL_LoadAndSpawnEntitiesFromScript]]
* [[UTIL_LoadFileForMe]]
* [[UTIL_LogPrintf]]
* [[UTIL_ParentToWorldSpace]]
* [[UTIL_PointAtEntity]]
* [[UTIL_PointAtNamedEntity]]
* [[UTIL_PointContents]]
* [[UTIL_PointOnLineNearestPoint]]
* [[UTIL_PredictedPosition]]
* [[UTIL_RemoveHeirarchy]]
* [[UTIL_RemoveImmediate]]
* [[UTIL_Remove]]
* [[UTIL_ReplaceKeyBindings]]
* [[UTIL_RestartAmbientSounds]]
* [[UTIL_SayText2Filter]]
* [[UTIL_SayTextAll]]
* [[UTIL_SayTextFilter]]
* [[UTIL_SayTextFilter]]
* [[UTIL_SayText2Filter]]
* [[UTIL_SayText]]
* [[UTIL_SayText]]
* [[UTIL_SayTextAll]]
* [[UTIL_ScaleForGravity]]
* [[UTIL_ShowMessageAll]]
* [[UTIL_ShowMessage]]
* [[UTIL_ShowMessage]]
* [[UTIL_ShowMessageAll]]
* [[UTIL_SnapDirectionToAxis]]
* [[UTIL_SnapDirectionToAxis]]
* [[UTIL_StripToken]]
* [[UTIL_TeamsMatch]]
* [[UTIL_TransferPoseParameters]]
* [[UTIL_TranslateSoundName]]
* [[UTIL_ValidateSoundName]]
* [[UTIL_VarArgs]]
* [[UTIL_VarArgs]]
* [[UTIL_IsMasterTriggered]]
* [[UTIL_TeamsMatch]]
* [[UTIL_AxisStringToPointPoint]]
* [[UTIL_AxisStringToPointDir]]
* [[UTIL_AxisStringToUnitDir]]
* [[UTIL_ClipPunchAngleOffset]]
* [[UTIL_WaterLevel]]
* [[UTIL_WaterLevel]]
* [[UTIL_WorldToParentSpace]]
* [[WorldToLocalRotation]]


{{category newcolumn|rowspan=1|width=50%|background-color=#FBF7EA|border-color=#E4DCCD}}
{{category newcolumn|rowspan=1|width=50%|background-color=#FBF7EA|border-color=#E4DCCD}}
== Precaching ==  
== Precaching ==  
* [[UTIL_PrecacheDecal]]
* [[UTIL_PrecacheDecal]]
* [[UTIL_PrecacheOther]]
* [[UTIL_PrecacheOther]]
* [[UTIL_PrecacheOtherGrenade]]
* [[PrecacheModel]]
* [[PrecacheModel]]
* [[PrecacheMaterial]]
* [[PrecacheMaterial]]
Line 82: Line 121:
* [[PrecacheVGuiScreen]]
* [[PrecacheVGuiScreen]]
* [[PrecacheVGuiScreenOverlayMaterial]]
* [[PrecacheVGuiScreenOverlayMaterial]]
{{category cell|background-color=white|border-color=white}}
== Player ==
* [[UTIL_ClientPVSIsExpanded]]
* [[UTIL_ClientPrintAll]]
* [[UTIL_ClientPrintFilter]]
* [[UTIL_GetCommandClientIndex]]
* [[UTIL_GetCommandClient]]
* [[UTIL_GetCurrentCheckClient]]
* [[UTIL_GetListenServerHost]]
* [[UTIL_GetLocalPlayerOrListenServerHost]]
* [[UTIL_GetLocalPlayer]]
* [[UTIL_GetNewCheckClient]]
* [[UTIL_GetPlayerConnectionInfo]]
* [[UTIL_IsCommandIssuedByServerAdmin]]
* [[UTIL_ItemCanBeTouchedByPlayer]]
* [[UTIL_PlayerByIndex]]
* [[UTIL_PlayerByName]]
* [[UTIL_PlayerByUserId]]


{{category cell|background-color=white|border-color=white}}
{{category cell|background-color=white|border-color=white}}
== Traces ==
 
* [[UTIL_TraceLine]]
== Blood ==
* [[UTIL_TraceEntity]]
* [[UTIL_BloodDecalTrace]]
* [[UTIL_TraceLineFilterEntity]]
* [[UTIL_BloodDrips]]
* [[UTIL_TraceHull]]
* [[UTIL_BloodImpact]]
* [[UTIL_TraceModel]]
* [[UTIL_BloodSpray]]
* [[UTIL_Tracer]]
* [[UTIL_BloodStream]]
* [[UTIL_SetTrace]]
* [[UTIL_ShouldShowBlood]]
* [[UTIL_ClearTrace]]


{{category cell|background-color=white|border-color=white}}
{{category cell|background-color=white|border-color=white}}
== Modifying Angles ==
== Modifying Angles ==
* [[UTIL_Approach]]
* [[UTIL_Approach]]
Line 100: Line 160:
* [[UTIL_AngleMod]]
* [[UTIL_AngleMod]]
* [[UTIL_AngleDiff]]
* [[UTIL_AngleDiff]]
* [[UTIL_AngleDistance]]
{{category cell|background-color=#FBF7EA|border-color=white}}
{{category cell|background-color=#FBF7EA|border-color=white}}
== Utility Effects ==
== Utility Effects ==
* [[UTIL_ScreenShake]]
* [[UTIL_Beam]]
* [[UTIL_ScreenShakeObject]]
* [[UTIL_BubbleTrail]]
* [[UTIL_ViewPunch]]
* [[UTIL_Bubbles]]
* [[UTIL_GetDebugColorForRelationship]]
* [[UTIL_HudHintText]]
* [[UTIL_HudMessageAll]]
* [[UTIL_HudMessage]]
* [[UTIL_ImpactTrace]]
* [[UTIL_IsLowViolence]]
* [[UTIL_MuzzleFlash]]
* [[UTIL_ParticleTracer]]
* [[UTIL_PlayerDecalTrace]]
* [[UTIL_ScreenFadeAll]]
* [[UTIL_ScreenFadeBuild]]
* [[UTIL_ScreenFadeBuild]]
* [[UTIL_ScreenFadeWrite]]
* [[UTIL_ScreenFadeWrite]]
* [[UTIL_ScreenFadeAll]]
* [[UTIL_ScreenFade]]
* [[UTIL_ScreenFade]]
* [[UTIL_HudMessage]]
* [[UTIL_ScreenShakeObject]]
* [[UTIL_HudMessageAll]]
* [[UTIL_ScreenShake]]
* [[UTIL_HudHintText]]
* [[UTIL_Smoke]]
* [[UTIL_Smoke]]
* [[UTIL_ImpactTrace]]
* [[UTIL_Tracer]]
* [[UTIL_PlayerDecalTrace]]
* [[UTIL_ViewPunch]]
* [[UTIL_Bubbles]]
 
* [[UTIL_BubbleTrail]]
== Pitch & Yaw ==
* [[UTIL_Beam]]
* [[UTIL_VecToYaw]]
* [[UTIL_GetDebugColorForRelationship]]
* [[UTIL_VecToPitch]]
* [[UTIL_MuzzleFlash]]
* [[UTIL_YawToVector]]


== Shared Random ==
* [[SharedRandomFloat]]
* [[SharedRandomInt]]
* [[SharedRandomVector]]
* [[SharedRandomAngle]]


{{category end}}__NOTOC__
== String Conversion ==
* [[UTIL_AxisStringToPointPoint]]
* [[UTIL_AxisStringToPointDir]]
* [[UTIL_AxisStringToUnitDir]]
* [[UTIL_ColorStringToLinearFloatColor]]
* [[UTIL_StringToColor32]]
* [[UTIL_StringToFloatArray]]
* [[UTIL_StringToIntArray]]
* [[UTIL_StringToVector]]
* [[UTIL_StringFieldToInt]]


{{Note|This list is incomplete, and these functions are poorly categorized for now.}}


{{category end}}__NOTOC__
[[Category:Programming]]
[[Category:Programming]]
[[Category:Modding]]
[[Category:Modding]]

Latest revision as of 15:40, 2 November 2021

English (en)Deutsch (de)Português do Brasil (pt-br)Русский (ru)Translate (Translate)

UTIL(ities)

The Source Engine has utility functions, that are commonly prefixed with 'UTIL_', for performing common functions, such as safe removal of objects, trace lines, and precaching assets.

Traces

Finding Entities in Space


Set Properties

Other

Precaching


Player

Blood

Modifying Angles

Utility Effects

Pitch & Yaw

Shared Random

String Conversion