Category:UTIL: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(oop)
(Clarity and grammar.)
 
(17 intermediate revisions by 6 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 29: Line 34:


== Other ==
== Other ==
{{todo|Categorize these}}
* [[UTIL_AddDebugLine]]
* [[UTIL_GetSimulationInterval]]
* [[UTIL_BoundToWorldSize]]
* [[UTIL_DropToFloor]]
* [[UTIL_CheckBottom]]
* [[UTIL_CheckBottom]]
* [[UTIL_Remove]]
* [[UTIL_RemoveImmediate]]
* [[UTIL_EnableRemoveImmediate]]
* [[UTIL_DisableRemoveImmediate]]
* [[UTIL_PlayerByIndex]]
* [[UTIL_PlayerByName]]
* [[UTIL_PlayerByUserId]]
* [[UTIL_GetLocalPlayer]]
* [[UTIL_GetListenServerHost]]
* [[UTIL_IsCommandIssuedByServerAdmin]]
* [[UTIL_EntityByIndex]]
* [[UTIL_GetPlayerConnectionInfo]]
* [[UTIL_ClientPrintFilter]]
* [[UTIL_ClientPrintAll]]
* [[UTIL_SayTextFilter]]
* [[UTIL_SayText2Filter]]
* [[UTIL_SayText]]
* [[UTIL_SayTextAll]]
* [[UTIL_ShowMessage]]
* [[UTIL_ShowMessageAll]]
* [[UTIL_SnapDirectionToAxis]]
* [[UTIL_VarArgs]]
* [[UTIL_IsMasterTriggered]]
* [[UTIL_TeamsMatch]]
* [[UTIL_ClipPunchAngleOffset]]
* [[UTIL_ClipPunchAngleOffset]]
* [[UTIL_WaterLevel]]
* [[UTIL_FindWaterSurface]]
* [[UTIL_IsValidEntity]]
* [[UTIL_LogPrintf]]
* [[UTIL_DotPoints]]
* [[UTIL_StripToken]]
* [[UTIL_ScaleForGravity]]
* [[UTIL_EntityInSolid]]
* [[UTIL_ValidateSoundName]]
* [[UTIL_GetNewCheckClient]]
* [[UTIL_ClientPVSIsExpanded]]
* [[UTIL_PredictedPosition]]
* [[UTIL_PointAtEntity]]
* [[UTIL_PointAtNamedEntity]]
* [[UTIL_TransferPoseParameters]]
* [[UTIL_PointOnLineNearestPoint]]
* [[WorldToLocalRotation]]
* [[UTIL_LoadFileForMe]]
* [[UTIL_FreeFile]]
* [[UTIL_IsFacingWithinTolerance]]
* [[UTIL_LoadAndSpawnEntitiesFromScript]]
* [[UTIL_ParentToWorldSpace]]
* [[UTIL_WorldToParentSpace]]
* [[UTIL_BoundToWorldSize]]
* [[UTIL_DistApprox]]
* [[UTIL_DistApprox2D]]
* [[UTIL_EntityHasMatchingRootParent]]
* [[UTIL_GetAchievementEventMask]]
* [[UTIL_AddDebugLine]]
* [[UTIL_ComputeAABBForBounds]]
* [[UTIL_ComputeAABBForBounds]]
* [[UTIL_ComputeEntityFade]]
* [[UTIL_ComputeEntityFade]]
* [[UTIL_ComputerStringWidth]]
* [[UTIL_ComputerStringWidth]]
* [[UTIL_DecodeICE]]
* [[UTIL_DecodeICE]]
* [[UTIL_DisableRemoveImmediate]]
* [[UTIL_DistApprox2D]]
* [[UTIL_DistApprox]]
* [[UTIL_DotPoints]]
* [[UTIL_DrawOverlayLines]]
* [[UTIL_DrawOverlayLines]]
* [[UTIL_DropToFloor]]
* [[UTIL_EmitAmbientSound]]
* [[UTIL_EmitAmbientSound]]
* [[UTIL_EmitSoundSuit]]
* [[UTIL_EmitGroupnameSuit]]
* [[UTIL_EmitGroupnameSuit]]
* [[UTIL_EmitSoundSuit]]
* [[UTIL_EmitSoundSuit]]
* [[UTIL_EnableRemoveImmediate]]
* [[UTIL_EntityByIndex]]
* [[UTIL_EntityHasMatchingRootParent]]
* [[UTIL_EntityInSolid]]
* [[UTIL_FindWaterSurface]]
* [[UTIL_FreeFile]]
* [[UTIL_FunctionFromName]]
* [[UTIL_FunctionFromName]]
* [[UTIL_FunctionToName]]
* [[UTIL_FunctionToName]]
* [[UTIL_GetCommandClient]]
* [[UTIL_GetAchievementEventMask]]
* [[UTIL_GetCommandClientIndex]]
* [[UTIL_GetCurrentCheckClient]]
* [[UTIL_GetLocalPlayerOrListenServerHost]]
* [[UTIL_GetMapKeyCount]]
* [[UTIL_GetMapKeyCount]]
* [[UTIL_GetMapLoadCountFileName]]
* [[UTIL_GetMapLoadCountFileName]]
* [[UTIL_GetModDir]]
* [[UTIL_GetModDir]]
* [[UTIL_GetNormalizedColorTintAndLuminosity]]
* [[UTIL_GetNormalizedColorTintAndLuminosity]]
* [[UTIL_GetSimulationInterval]]
* [[UTIL_IncrementMapKey]]
* [[UTIL_IncrementMapKey]]
* [[UTIL_IteMCanBeTouchedByPlayer]]
* [[UTIL_IsFacingWithinTolerance]]
* [[UTIL_IsMasterTriggered]]
* [[UTIL_IsValidEntity]]
* [[UTIL_LoadActivityRemapFile]]
* [[UTIL_LoadActivityRemapFile]]
* [[UTIL_LoadAndSpawnEntitiesFromScript]]
* [[UTIL_LoadFileForMe]]
* [[UTIL_LogPrintf]]
* [[UTIL_ParentToWorldSpace]]
* [[UTIL_PointAtEntity]]
* [[UTIL_PointAtNamedEntity]]
* [[UTIL_PointContents]]
* [[UTIL_PointContents]]
* [[UTIL_PointOnLineNearestPoint]]
* [[UTIL_PredictedPosition]]
* [[UTIL_RemoveHeirarchy]]
* [[UTIL_RemoveHeirarchy]]
* [[UTIL_RemoveImmediate]]
* [[UTIL_Remove]]
* [[UTIL_ReplaceKeyBindings]]
* [[UTIL_ReplaceKeyBindings]]
* [[UTIL_RestartAmbientSounds]]
* [[UTIL_RestartAmbientSounds]]
* [[UTIL_SayText2Filter]]
* [[UTIL_SayTextAll]]
* [[UTIL_SayTextFilter]]
* [[UTIL_SayText]]
* [[UTIL_ScaleForGravity]]
* [[UTIL_ShowMessageAll]]
* [[UTIL_ShowMessage]]
* [[UTIL_SnapDirectionToAxis]]
* [[UTIL_StripToken]]
* [[UTIL_TeamsMatch]]
* [[UTIL_TransferPoseParameters]]
* [[UTIL_TranslateSoundName]]
* [[UTIL_TranslateSoundName]]
* [[UTIL_ValidateSoundName]]
* [[UTIL_VarArgs]]
* [[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}}
Line 120: Line 107:
* [[UTIL_PrecacheDecal]]
* [[UTIL_PrecacheDecal]]
* [[UTIL_PrecacheOther]]
* [[UTIL_PrecacheOther]]
* [[UTIL_PrecacheOtherGrenade]]
* [[PrecacheModel]]
* [[PrecacheModel]]
* [[PrecacheMaterial]]
* [[PrecacheMaterial]]
Line 133: Line 121:
* [[PrecacheVGuiScreen]]
* [[PrecacheVGuiScreen]]
* [[PrecacheVGuiScreenOverlayMaterial]]
* [[PrecacheVGuiScreenOverlayMaterial]]
* [[UTIL_PrecacheOtherGrenade]]
 
 
{{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]]
* [[UTIL_ClipTraceToPlayers]]
* [[UTIL_TraceRay]]


{{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 158: Line 164:
{{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_PlayerDecalTrace]]
* [[UTIL_Bubbles]]
* [[UTIL_BubbleTrail]]
* [[UTIL_Beam]]
* [[UTIL_GetDebugColorForRelationship]]
* [[UTIL_MuzzleFlash]]
* [[UTIL_ParticleTracer]]
* [[UTIL_Tracer]]
* [[UTIL_Tracer]]
* [[UTIL_IsLowViolence]]
* [[UTIL_ViewPunch]]


== Pitch & Yaw ==  
== Pitch & Yaw ==  
Line 192: Line 198:


== String Conversion ==
== String Conversion ==
* [[UTIL_StringToCOlor32]]
* [[UTIL_AxisStringToPointPoint]]
* [[UTIL_AxisStringToPointDir]]
* [[UTIL_AxisStringToUnitDir]]
* [[UTIL_ColorStringToLinearFloatColor]]
* [[UTIL_StringToColor32]]
* [[UTIL_StringToFloatArray]]
* [[UTIL_StringToFloatArray]]
* [[UTIL_StringToIntArray]]
* [[UTIL_StringToIntArray]]
* [[UTIL_StringToVector]]
* [[UTIL_StringToVector]]
* [[UTIL_StringFieldToInt]]
* [[UTIL_StringFieldToInt]]
* [[UTIL_ColorStringToLinearFloatColor]]
 
* [[UTIL_AxisStringToPointPoint]]
* [[UTIL_AxisStringToPointDir]]
* [[UTIL_AxisStringToUnitDir]]


{{category end}}__NOTOC__
{{category end}}__NOTOC__
{{Note|This list is incomplete, and these functions are poorly categorized for now.}}
[[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