Sven Co-op - User contributions [en]

Hooks

2026-02-04T16:44:29Z

Outerbeast: /* Player Hooks */

Hooks are a form of events that scripts can hook into. When you register a hook, the function you’ve registered will be called whenever the associated event occurs.

Multiple scripts can hook into the same hook, and the same script can hook the same hook multiple times. Map scripts will always come first when hooks that both map scripts and plugins can use are executed.

== Hook return code ==

All hooks have to return a code to indicate whether they’ve handled the event or not.

If a hook has handled the event, it should return <code>HOOK_HANDLED</code>. Otherwise, it should return <code>HOOK_CONTINUE</code>.


== Hook definition and usage ==

All hooks are defined in the namespace “Hooks”.

All hooks have funcdefs defined for them that have the syntax <name>Hook, where <name> is the name of the constant without any namespaces prepended. For example, the <code>Hooks::Game::MapChange</code> hook has the funcdef <code>MapChangeHook</code>. This can be used to register object methods as hooks.

You can get an up to date list of hook by typing as_dumphooks <filename> in the console. You must be the server admin to be able to do this. The filename should not have an extension. The file extension is .txt.


=== Registering hooks ===

To register a hook, you must use the g_Hooks global object. This object is defined as follows:

<pre>CModuleHookManager g_Hooks;</pre>
(The actual definition uses a global property accessor, but it behaves like a variable as shown above)

Registering a hook is done as follows:

<pre>HookReturnCode MapChange( const string& in szNextMap )
{
// Handle map change
}

g_Hooks.RegisterHook( Hooks::Game::MapChange, MapChange );</pre>
Removing a hook is done much like registering it:

<pre>g_Hooks.RemoveHook( Hooks::Game::MapChange, MapChange );</pre>

If you are trying to register a method to a hook, you need to pass the method handle in via a delegate, this is done as follows:
<pre>g_Hooks.RegisterHook( Hooks::Game::MapChange, MapChangeHook( obj.MapChange ) )</pre>

It is also possible to remove all of the hook functions registered for a particular hook in the current script by calling RemoveHook with just the hook ID parameter:

<pre>g_Hooks.RemoveHook( Hooks::Game::MapChange );</pre>

=== Stop Modes ===

Hooks can have one of a few stop modes. This mode defines when hook execution should stop.

{| class="wikitable"
|-
! Name
! Action
|-
| <code>ON_HANDLED
| As soon as a hook has returned HOOK_HANDLED, stop execution.
|-
| <code>MODULE_HANDLED
| As soon as a single script has return HOOK_HANDLED from any of its hooks, stop execution.
|-
| <code>CALL_ALL
| Regardless of the return code, execute all hooks.
|}



== Available hooks ==
=== Game Hooks ===
<code>Hooks::Game::</code>
{| class="wikitable"
|- style="font-weight:bold; text-align:center; vertical-align:middle;"
! Constant
! Signature
! style="border-color:inherit;" | Description
! style="border-color:inherit;" | Stop Mode
! style="border-color:inherit;" | Availability
|-
| <code>MapChange</code>
| <code>HookReturnCode Function( const string& in szNextMap )</code>
| When the map changes, this hook is called. Note that this happens when the world is destroyed. There may still be entities that exist at this point. This is caused by engine limitations.
| <code>CALL_ALL</code>
| All
|-
| <code>EntityCreated</code>
| <code>HookReturnCode Function( CBaseEntity@ pEntity )</code>
| Called when a new entity is created. At this point the entity is not spawned yet and may not be fully initialized.
| <code>ON_HANDLED</code>
| All
|}

=== Player Hooks ===
<code>Hooks::Player::</code>
{| class="wikitable"
|- style="font-weight:bold; text-align:center; vertical-align:middle;"
! Constant
! Signature
! style="border-color:inherit;" | Description
! style="border-color:inherit;" | Stop Mode
! style="border-color:inherit;" | Availability
|- style="vertical-align:middle;"
| style="background-color:#F8F9FA; color:#202122;" | <code>CanPlayerUseReservedSlot
| style="background-color:#F8F9FA; color:#202122;" | <code>HookReturnCode Function( edict_t@ pEntity, const string& in szPlayerName, const string& in szIPAddress, bool& out bAllowJoin )
| style="background-color:#F8F9FA; color:#202122; border-color:inherit;" | Called when a player connects to the server, and the number of slots left on the server is <= the number of reserved slots. Set bAllowJoin to true to allow the player to join (default false). Note: At this point in time the player’s CBasePlayer instance does not yet exist. Do not try to use it, as it will not work.
| style="border-color:inherit;" | <code>ON_HANDLED
| style="border-color:inherit;" | Plugins only
|- style="vertical-align:middle;"
| style="background-color:#F8F9FA; color:#202122;" | <code>ClientConnected
| style="background-color:#F8F9FA; color:#202122;" | <code>HookReturnCode Function( edict_t@ pEntity, const string& in szPlayerName, const string& in szIPAddress, bool& out bDisallowJoin, string& out szRejectReason )
| style="background-color:#F8F9FA; color:#202122; border-color:inherit;" | Called when a player connects to the server. if bDisallowJoin is set to false, the player is disconnected. szRejectReason is shown to the player if disconnected. the maximum length of the reject reason string is 127 characters. Note: At this point in time the player’s CBasePlayer instance does not yet exist. Do not try to use it, as it will not work.
| style="border-color:inherit;" | <code>CALL_ALL
| style="border-color:inherit;" | Plugins only
|-
| style="vertical-align:middle; background-color:#F8F9FA; color:#202122;" | <code>ClientPutInServer
| style="background-color:#F8F9FA; color:#202122;" | <code>HookReturnCode Function( CBasePlayer@ pPlayer )
| style="vertical-align:middle; background-color:#F8F9FA; color:#202122; border-color:inherit;" | Called when a player has finished connecting and is put into the world. It is safe to send network messages to the player at this point. The player’s CBasePlayer instance is created right before this hook is executed.
| style="vertical-align:middle; border-color:inherit;" | <code>CALL_ALL
| style="vertical-align:middle; border-color:inherit;" | All
|-
| <code>ClientDisconnect
| <code>HookReturnCode Function( CBasePlayer@ pPlayer )
| style="border-color:inherit;" | Called when a player disconnects. Note that this is only called if the player was fully connected, meaning the player went through ClientPutInServer. This is never called for the local host, since it can’t disconnect before shutting the server itself down.
| style="border-color:inherit;" | <code>CALL_ALL
| style="border-color:inherit;" | All
|-
| <code>ClientSay
| <code>HookReturnCode Function( SayParameters@ pParams )
| style="border-color:inherit;" | Called when a player says something in game chat. The SayParameters class can be used to manipulate input and veto the message.
| style="border-color:inherit;" | <code>ON_HANDLED
| style="border-color:inherit;" | All
|- style="border-color:inherit;"
| <code>GetPlayerSpawnSpot
| <code>HookReturnCode Function( CBasePlayer@ pPlayer, CBaseEntity@& out ppEntSpawnSpot )
| Called when the game is trying to find a spawn spot for a player. To specify a spawn spot (or no spawn spot), set ppEntSpawnSpot to the spot you wish to use, and return HOOK_HANDLED. Setting null will cause the game to spawn the player dead.
|
|
|- style="border-color:inherit;"
| <code>PlayerSpawn
| <code>HookReturnCode Function( CBasePlayer@ pPlayer )
| Called when a player (re)spawns. Player render settings and equipment changes are unavailable at this point.
| <code>CALL_ALL
| All
|- style="border-color:inherit;"
| <code>PlayerCanRespawn
| <code>HookReturnCode Function( CBasePlayer@ pPlayer, bool& out bCanRespawn )
| Called when the game wants to know if the player should be able to respawn or not. Set bCanRespawn to false to disallow, default true.
| <code>ON_HANDLED
| All
|- style="border-color:inherit;"
| <code>PlayerTakeDamage
| <code>HookReturnCode PlayerTakeDamageHook( DamageInfo@ pDamageInfo )
| Called when a player takes damage. Note that the victim entity can’t be changed at this point.
|
| All
|-
| style="border-color:inherit;" | <code>PlayerKilled
| style="border-color:inherit;" | <code>HookReturnCode Function( CBasePlayer@ pPlayer, CBaseEntity@ pAttacker, int iGib )
| Called when a player is killed. pAttacker is the entity responsible for killing the player, and may be null. iGib is one of the GIB enum values, indicating whether or not the player should be gibbed or not.
| style="border-color:inherit;" |
| style="border-color:inherit;" | All
|- style="border-color:inherit;"
| <code>PlayerRevived</code>
| <code>HookReturnCode Function( CBasePlayer@ pPlayer )</code>
| Called when a player is revived. At this point all the revival process is finished.
| style="border-color:inherit;" | <code>CALL_ALL
| style="border-color:inherit;" | All
|-
| <code>PlayerUse
| <code>HookReturnCode Function( CBasePlayer@ pPlayer, uint& out uiFlags )
| Called when the game is processing player button input. Note that this occurs even if the player has not pressed any keys. uiFlags is used to skip player use processing after the hook returns. Setting the flag PlrHook_SkipUse will skip processing.
|
| All
|-
| style="border-color:inherit;" | <code>PlayerPreThink
| style="border-color:inherit;" | <code>HookReturnCode Function( CBasePlayer@ pPlayer, uint& out uiFlags )
| Called when the player is processing pre think events. uiFlags is used to skip pre think processing after the hook returns. Setting the flag PlrHook_SkipVehicles will skip vehicle processing.
| style="border-color:inherit;" |
| style="border-color:inherit;" | All
|-
| style="border-color:inherit;" | <code>PlayerPostThink
| style="border-color:inherit;" | <code>HookReturnCode Function( CBasePlayer@ pPlayer )
| Called when the player is processing post think events.
| style="border-color:inherit;" |
| style="border-color:inherit;" | All
|-
| <code>PlayerPreDecal
| <code>HookReturnCode Function( CBasePlayer@, const TraceResult& in, bool& out bResult)
| Called when a player attempts to spraypaint a decal onto a surface. The given trace result contains the surface information. Set bResult to false if the player shouldn’t be able to spray.
| style="border-color:inherit;" |
| style="border-color:inherit;" | Plugins only
|-
| <code>PlayerDecal
| <code>HookReturnCode Function( CBasePlayer@ pPlayer, const TraceResult& in trace )
| Called when a player is spraypainting a decal onto a surface. The given trace result contains the surface information.
| style="border-color:inherit;" |
| style="border-color:inherit;" | Plugins only
|-
| <code>PlayerEnteredObserver
| <code>HookReturnCode Function( CBasePlayer@ pPlayer )
| Called when a player enters observer mode.
| style="border-color:inherit;" |
| style="border-color:inherit;" | All
|-
| <code>PlayerLeftObserver
| <code>HookReturnCode Function( CBasePlayer@ pPlayer )
| Called when a player leaves observer mode.
| style="border-color:inherit;" |
| style="border-color:inherit;" | All
|}

=== Monster Hooks ===
<code>Hooks::Monster::</code>

'''Note:''' Players are technically CBaseMonster instances, so player TakeDamage and Killed events will also be hooked. Ensure the function code accommodates for this.
{| class="wikitable"
|-
! Constant
! Signature
! Description
! Stop Mode
! Availability
|-
| <code>MonsterKilledHook
| <code>HookReturnCode Function( CBaseMonster@ pMonster, CBaseEntity@ pAttacker, int iGib )
| Called when a monster is killed (This hook isn’t called for grenade entities/monster_sentry/monster_barnacle). This hook may have spam issues.
| <code>ON_HANDLED
| All
|-
| <code>MonsterTakeDamage
| <code>HookReturnCode Function( DamageInfo@ pDamageInfo )
| Called when a monster takes damage.
| <code>ON_HANDLED
| All
|}

=== Weapon Hooks ===
<code>Hooks::Weapon::</code>
{| class="wikitable"
|-
! Constant
! Signature
! Description
! Stop Mode
! Availability
|-
| <code>WeaponPrimaryAttack
| <code>HookReturnCode Function( CBasePlayer@ pPlayer, CBasePlayerWeapon@ pWeapon )
| Called when a player fires a weapon's primary attack.
| <code>ON_HANDLED
| All
|-
| <code>WeaponSecondaryAttack
| <code>HookReturnCode Function( CBasePlayer@ pPlayer, CBasePlayerWeapon@ pWeapon )
| Called when a player fires a weapon's secondary attack.
| <code>ON_HANDLED
| All
|-
| <code>WeaponTertiaryAttack
| <code>HookReturnCode Function( CBasePlayer@ pPlayer, CBasePlayerWeapon@ pWeapon )
| Called when a player fires a weapon's tertiary attack.
| <code>ON_HANDLED
| All
|-
| <code>WeaponReload
| <code>HookReturnCode Function( CBasePlayer@ pPlayer, CBasePlayerWeapon@ pWeapon )
| Called a player reloads a weapon (or calls BaseClass::Reload()).
| <code>CALL_ALL
| All
|}

=== Pickup Hooks ===
<code>Hooks::PickupObject::</code>
{| class="wikitable"
|-
! Constant
! Signature
! Description
! Stop Mode
! Availability
|- style="border-color:inherit;"
| <code>Materialize
| <code>HookReturnCode Function( CBaseEntity@ pPickup )
| Called when a pickup object materializes.
| <code>CALL_ALL
| All
|-
| style="border-color:inherit;" | <code>CanCollect
| style="border-color:inherit;" | <code>HookReturnCode Function( CBaseEntity@ pPickup, CBaseEntity@ pOther, bool& out bResult )
| style="border-color:inherit;" | Called when a pickup object is about to be collected by a player. Note that basic checks are done before this hook is called. Set bResult to false if the player shouldn’t be able to pick up the object.
| <code>ON_HANDLED
| style="border-color:inherit;" | All
|- style="border-color:inherit;"
| <code>Collected
| <code>HookReturnCode Function( CBaseEntity@ pPickup, CBaseEntity@ pOther )
| Called when a pickup object is collected by a player.
| <code>CALL_ALL
| All
|}

[[Category:Scripting]]

EHandle

2026-02-01T19:03:23Z

Outerbeast:

This type is used to store a handle to an entity across multiple frames: either in global state, or shared state as passed around in scheduled functions or in class fields.

If the entity is removed, EHandle will return null instead. Using EHandle is very easy:

<nowiki>
EHandle g_hHandle;

void StoreEntity( CBaseEntity@ pEntity )
{
g_hHandle = pEntity; // CBaseEntity@ (and child types) instances implicitly cast to EHandle
}

void DoSomethingWithStoredEntity()
{
if( g_hHandle ) // Check if the EHandle is valid first before using it.
{
CBaseEntity@ pEntity = g_hHandle.GetEntity();

//Do something with "pEntity"
}
}</nowiki>

You should always check if the handle is valid before using it, otherwise, Angelscript will stop executing and raise an error.

You should always use EHandle when storing entity handles, unless you know that it will only be used in current frame. Even then, it is safer to use EHandle to avoid problems.

Never declare a CBase* handle as a global or member variable, always use EHandle.

For the same reason, avoid passing CBase* handles through scheduled function/method parameters. In situations where you have to pass an entity through a scheduled function, its recommended to overload the scheduled function changing the CBase* parameter to EHandle and scheduling that overload:

<nowiki>
void ScheduleEntity( CBaseEntity@ pEntity )
{
// This will schedule "DoSomethingWithEntity( CBaseEntity@ pEntity )" - unsafe, avoid doing this
// g_Scheduler.SetTimeout( "DoSomethingWithEntity", 0.0f, pEntity );

// This will schedule "DoSomethingWithEntity( EHandle hEntity )" - safe
g_Scheduler.SetTimeout( "DoSomethingWithEntity", 0.0f, EHandle( pEntity ) );
}

void DoSomethingWithEntity( CBaseEntity@ pEntity ) // Original function
{
pEntity.DoSomething();
}

void DoSomethingWithEntity( EHandle hEntity ) // Overload
{
if( hEntity )
DoSomethingWithEntity( hEntity.GetEntity() );
}</nowiki>

== Methods ==

{| class="wikitable"
|- style="font-weight:bold; text-align:center; vertical-align:middle;"
! Declaration
! Description
|-
| <code>void EHandle()
| style="vertical-align:middle;" | Default constructs this handle.
|-
| <code>void EHandle(const EHandle& in other)
| style="vertical-align:middle;" | Copy constructs this handle.
|-
| <code>void EHandle(CBaseEntity@ pEntity)
| style="vertical-align:middle;" | Constructs this handle with a reference to the given entity.
|-
| <code>bool IsValid() const
| style="vertical-align:middle;" | Returns whether this handle is valid.
|-
| <code>bool opImplConv() const
| style="vertical-align:middle;" | Returns whether this handle is valid.
|-
| <code>CBaseEntity@ GetEntity() const
| style="vertical-align:middle;" | Gets the Entity this handle refers to. Returns null if invalid.
|-
| <code>CBaseEntity@ opImplCast() const
| style="vertical-align:middle;" | Gets the Entity this handle refers to. Returns null if invalid.
|-
| <code>CBaseEntity@ opAssign(CBaseEntity@ pEntity)
| style="vertical-align:middle;" | Assigns the given entity to this handle.
|-
| <code>EHandle& opAssign(const EHandle& in other)
| style="vertical-align:middle;" | Makes this handle refer to the same entity as the given handle.
|-
| <code>int GetSerialNumber() const
| CBaseEntity serial number. Used to determine if the entity is still valid.
|}

[[Category:Scripting]]

SayParameters

2026-01-30T15:51:39Z

Outerbeast:

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 <code>bool ShouldHide</code>: Controls whether this text will be hidden or not. This is implemented as a property accessor and mutator. Default false.

{| class="wikitable" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
! Function
! Description
|-
| <code>CBasePlayer@ GetPlayer() const
| Gets the player that is saying something.
|-
| <code>ClientSayType GetSayType() const
| Gets the say type of this text: 
* <code>CLIENTSAY_SAY</code> 0 Say
* <code>CLIENTSAY_SAYTEAM</code> 1 Say team
|-
| <code>const string& GetCommand() const
| Gets the entire command string.
|-
| <code>const CCommand@ GetArguments() const
| Gets the arguments in this command.
|}

[[Category:Scripting]]

Tracing

2026-01-30T15:48:04Z

Outerbeast: /* Trace methods */

Traces are used to perform hit detection, which is handled by the engine. It is one of the primary means of handling navigation and hit detection in the game.

== TraceResult ==
The <code>TraceResult</code> class stores trace results that are performed by trace methods. Passing in a TraceResult object into a given trace method will modify the object, and so the results from the trace method can be accessed. Not all trace operations require the use of a <code>TraceResult</code> object.

{| class="wikitable" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
! Variable
! Description
|-
| <code>int fAllSolid
| Flag telling whether the trace started and ended in a solid area. If true, the plane is not valid.
|-
| <code>int fStartSolid
| Flag telling whether the trace started in a solid area.
|-
| <code>int fInOpen
| Flag telling whether the trace ended in empty space.
|-
| <code>int fInWater
| Flag telling whether the trace ended in water.
|-
| <code>float flFraction
| How much of the trace's total distance was covered. 1.0 means it didn't hit anything.
|-
| <code>Vector vecEndPos
| End position. If flFraction is 1.0, this is invalid.
|-
| <code>float flPlaneDist
| Brush plane distance. This appears to be the dot product between the first plane point and the normal. Its purpose is unknown, and there are no known uses. If flFraction is 1.0, this is invalid. If the hit object is not a brush, this is invalid.
|-
| <code>Vector vecPlaneNormal
| Brush plane normal. If flFraction is 1.0, this is invalid. If the hit object is not a brush, this is invalid.
|-
| <code>edict_t@ pHit
| Hit entity. If flFraction is 1.0, this is null.
|-
| <code>int iHitgroup
| Studio model hit group. if flFraction is 1.0, this is invalid. If the hit object is not a studio model, this is invalid.
|}

== Trace methods ==
Supported trace operations are listed below and are accessible via the [[CUtility#Tracing_methods|CUtility]] class.
A global instance exists:
<code>CUtility g_Utility;</code>

Note: The method <code>TankTrace</code> belongs to the CBaseTank class.

There are a number of traces that can be performed:

{| class="wikitable" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
! Method
! Description
! Bounds
|-
| <code>void TraceLine(const Vector& in vecStart, const Vector& in vecEnd, IGNORE_MONSTERS igmon, edict_t@ pEntIgnore, TraceResult& out ptr)</code>
| Calculates a trace along the given line, storing the results in ptr. If <code>igmon</code> is ignore_monsters, entities with a solid setting other than SOLID_BSP and a movetype other than MOVETYPE_PUSHSTEP (pushables) are ignored. If <code>pEntIgnore</code> is set, the entity will not be considered in traceline calculations.
| Uses point based bounds (zeroed out mins and maxs)
|-
| <code>void TraceLine(const Vector& in vecStart, const Vector& in vecEnd, IGNORE_MONSTERS igmon, IGNORE_GLASS ignoreGlass, edict_t@ pEntIgnore, TraceResult& out ptr)</code>
| Same as the above function, but also allows you to specify whether or not to ignore glass. If ignore_glass is specified, brush entities with a render mode other than normal and that don't have the <code>FL_WORLDBRUSH</code> flag set are ignored.
| Uses point based bounds (zeroed out mins and maxs)
|-
| <code>void TraceHull(const Vector& in vecStart, const Vector& in vecEnd, IGNORE_MONSTERS igmon, HULL_NUMBER hullNumber, edict_t@ pEntIgnore, TraceResult& out ptr)</code>
| Similar to TraceLine, but will use the specified hull's bounds instead of point based bounds.
| Uses the specified hull's bounds. Maps can specify these bounds in newer compilers, so avoid assuming a particular value is in use.
|-
| <code>void TraceToss(edict_t@ pEntity, edict_t@ pEntityToIgnore, TraceResult& out traceResult)</code>
| Traces a toss. This simulates tossing the entity using its current origin, velocity, angular velocity, angles and gravity. Note that this does not use the same code as MOVETYPE_TOSS, and may return different results.
| Uses the given entity's bounds.
|-
| <code>bool TraceMonsterHull(edict_t@ pEntity, const Vector& in vecStart, const Vector& in vecEnd, IGNORE_MONSTERS igmon, edict_t@ pEntityToIgnore, TraceResult& out ptr)</code>
| Performs a trace using the given entity's mins and maxs. This can be any entity, not just monsters. Returns true if the trace was entirely in a solid object, or if it hit something.
| Uses the given entity's bounds.
|-
| <code>void TraceModel(const Vector& in vecStart, const Vector& in vecEnd, int iHullNumber, edict_t@ pEntityToIgnore, TraceResult& out ptr)</code>
| Similar to TraceHull, but will instead perform a trace in the given world hull using the given entity's model's hulls. For studio models this will use the model's hitboxes.
| If the given entity's model is a studio model, uses its hitboxes. If it's a brush model, the brush model's hull for the given hull number is used (this may differ if custom brush hull sizes are in use). Otherwise, the entity bounds are converted into a hull.
|-
| <code>string TraceTexture(edict_t@ pEntity, const Vector& in vecStart, const Vector& in vecEnd)</code>
| Used to get the name of a texture. The given entity must have a brush model set. If the traceline intersects the model, the name of the texture of the surface it intersected is returned. Otherwise, returns an empty string.
| Uses point based bounds (zeroed out mins and maxs). CUtility::GetGlobalTrace() can be used to obtain this trace.
|-
| <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)</code>
| style="vertical-align:middle;" | Finds the hull intersection from a traceline in a given set of bounds. The given entity is the entity performing the traceline.
| The bounds are relative to the input traceline's endpoint.
|-
| <code>void TankTrace(const Vector& in vecStart, const Vector& in vecForward, const Vector& in vecSpread, TraceResult& out tr)</code>
| style="vertical-align:middle;" | Performs a traceline using a random spread based on the given spread amount. This is a CBaseTank method.
| Uses point based bounds (zeroed out mins and maxs)
|-
| <code>TraceResult GetGlobalTrace()<code>
| style="vertical-align:middle;" | Gets the global trace data stored in g_Engine as a TraceResult object. Results from entity Touch methods are obtained from this
|
|}

== Enums ==
===== IGNORE_MONSTERS =====
{| class="wikitable" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
! Constant
! Purpose
|-
| dont_ignore_monsters
| Don't ignore monsters.
|-
| ignore_monsters
| Ignore monsters.
|-
| missile
| The trace bounds are set to mins -15, -15, -15 and maxs 15, 15, 15. Otherwise, the bounds are specified by the traceline operation.
|}

===== IGNORE_GLASS =====
{| class="wikitable" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
! Constant
! Purpose
|-
| dont_ignore_glass
| Don't ignore glass.
|-
| ignore_glass
| Ignore glass.
|}

===== HULL_NUMBER =====
{| class="wikitable" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
! Constant
! Hull #
! Default Mins
! Default Maxs
! Default Size
|-
| point_hull
| 0
| 0, 0, 0
| 0, 0, 0
| 0x0x0
|-
| human_hull
| 1
| -16, -16, -36
| 16, 16, 36
| 32x32x72
|-
| large_hull
| 2
| -32, -32, -32
| 32, 32, 32
| 64x64x64
|-
| head_hull
| 3
| -16, -16, -18
| 16, 16, 18
| 32x32x36
|}

[[Category:Scripting]]

Running Scripts

2025-11-28T17:44:46Z

Outerbeast: /* Plugin List File */

Sven Co-op allows you to install scripts into the game through two main ways: map scripts and plugins.

* Map scripts run when a map is launched and terminate when a map ends
* Plugins run when the server is launched and continues to run until the server closes

Some API methods are exclusive to map scripts and some are exclusive to plugins.

== Execution ==

Scripts that are executed by the game have a few standard hooks in it that let you react to state changes in the game. These state changes cover the loading of maps, not gameplay state changes.

Note: These methods can not be used inside a class or namespace.

===== MapInit =====
When a new map is started, all scripts are initialized by calling their MapInit function.

It has the following signature:
<nowiki>
void MapInit()
{
// Code here
}</nowiki>

MapInit is called after all entities in the map have been created and spawned, but before they are activated. The sound list isn't written until after activation, which allows MapInit to precache sounds.

You cannot trigger entities in MapInit: not all entities created by other entities have been spawned yet. After MapInit has executed, the engine runs 2 frames of game logic and physics to start things up properly.

For this reason, if you want to trigger entities, either use MapStart, or use the scheduler to schedule a function for execution after the required amount of time. In this function you can trigger any entities you want.

If you're writing a map script and have any hooks you want to register, MapInit is where you should do it. It isn't required, but it's guaranteed to happen before any hooks are called.

If you have any custom entities to register or content to precache, it should be done in MapInit.

===== MapActivate =====
Like MapInit, only called after all mapper placed entities have been activated and the sound list has been written.
It has the following signature:
<nowiki>
void MapActivate()
{
// Code here
}</nowiki>

From this point onwards you are unable to register entities, or precache anything else as the sound list and resource list are already written and are ready to be sent to the player as soon as they connect.

===== MapStart =====
Called after 0.1 seconds of game activity, this is used to simplify the triggering on map start.
Think of it as trigger_auto, only as a script function.
It has the following signature:
<nowiki>
void MapStart()
{
// Code here
}</nowiki>

== Map Scripts ==
Sven Co-op allows maps to use scripts. A map script is active as long as the map itself is active, and can manipulate just about everything in the map.

===== A Simple Map Script =====
The simplest map script is an empty script, since there are no required parts to it. As covered by the Script fundamentals documentation, there are a few functions that are automatically called. Here's a script that will output "Hello World!" without quotes to the console when the script is initialized:
<nowiki>
void MapInit()
{
g_Game.AlertMessage( at_console, "Hello World!\n" );
}</nowiki>

Where to place map scripts
Map scripts must be placed in the scripts/maps directory. You can place them in a subdirectory if you want, but be aware that using long paths can cause issues, so avoid using deeply nested paths and long directory names.

It is recommended that you use directories to group scripts together to avoid cluttering the main directory, and to avoid using the same name as other scripts. Using the name of the map or map series you're making the script(s) for will usually suffice.

How to load map scripts
There are 2 ways to load map scripts: by specifying it in the map cfg, or in a trigger_script entity. The starting directory is scripts/maps.

When using a map cfg to specify it, you must use the map_script command. You can use this command multiple times to specify multiple scripts.

For example:
<nowiki>map_script HLSP</nowiki>

When using a trigger_script, specifying a script name in "Script to load" (m_iszScriptFile) will load it as though it were specified in the map cfg.

Console commands
There are a few console commands that apply to map scripts:

Command name Purpose Admin only?
as_listmapscriptinfo Outputs map script information No
as_scriptbaseclasses Shows the custom entity base class implementations (Warning: creates a substantial amount of console output!) Yes
API availability
Most of the API is available for map scripts to use, but there are a few things that are exclusive to them:

Entity user data: only map scripts can use this to avoid plugins altering the behavior of map scripts.
Custom entities: both map scripts and plugins can define and use custom entities. In the past this used to be available only for map scripts to avoid plugins from altering the gameplay of a map, and to avoid creating problems when plugins are (re)loaded while a map is active, this is no longer the case.
Entity loader: since this behaves like the map loading process, only map scripts can access it to prevent plugins from altering gameplay.
map and map temp directories in the filesystem: Ability to read/write files in these directories is restricted to map scripts.
* trigger_script
'''Hooks:'''
* PrimaryAttack
* SecondaryAttack
* TertiaryAttack
* PlayerUse
* PlayerPreThink
* PlayerPostThink
* GetPlayerSpawnSpot
Consult the documentation for the respective features for more information. For information on which parts of the API are exclusive to other script types, consult their documentation.

== Plugins ==
Sven Co-op supports the use of plugins for servers. This allows you to write scripts that run as long as the server is active, allowing you to do almost as much you can do in a map script.

=== A Simple Plugin ===
The minimum requirements for a plugin are that it provides a PluginInit function, and properly sets up the author and contact info fields. This is to prevent plugins with no known source from existing.
<pre>
void PluginInit()
{
g_Module.ScriptInfo.SetAuthor( "Sven Co-op Development Team" );
g_Module.ScriptInfo.SetContactInfo( "www.svencoop.com" );
}</pre>

In order to prevent malicious scripts from altering this information, you can only set this information from PluginInit itself. It should be the first thing you do in PluginInit, to avoid any confusion.

=== Where to place plugins ===
Plugins must be placed in the scripts/plugins directory. You can place them in a subdirectory if you want, but be aware that using long paths can cause issues, so avoid using deeply nested paths and long directory names.

It is recommended that you use directories to group scripts together to avoid cluttering the main directory, and to avoid using the same name as other scripts.

=== Plugin List File ===
The plugin list file is a text file, using the Keyvalues format, that contains a list of all plugins that the server will load.

The list uses the following format:
<pre>
"plugins"
{
"plugin"
{
"name" "PluginName"
"script" "PluginScriptName"
"adminlevel" "<admin level>"
"concommandns" "pluginns"
"included_maps" "list;of;bsp;names;seperated;by;semicolons"
"excluded_maps" "list;of;bsp;names;seperated;by;semicolons"
}
}</pre>
Each plugin has its own plugin block, which contains 2 required keyvalues: name and script. These define the name of the plugin (case insensitive, no duplicates allowed) and the main script file to include.

The adminlevel keyvalue is optional, and defines the minimum admin level required for players to use console commands and hooks that have the admin flag set, such as the ClientSay hook. You must choose one of these possible values:

{| class="wikitable" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
! Name
! Who can use commands
|-
| ADMIN_NO
| All players
|-
| ADMIN_YES
| Only admins and the server owner
|-
| ADMIN_OWNER
| Only the server owner
|}

The concommandns keyvalue is also optional, and defines the console command namespace used for plugin console commands (see console command system documentation).

The list file also allows the use of single line commands that start with "//".

Note: if your plugin is located in a subdirectory of the main plugin directory, you must also include that subdirectory in the script path. For instance, if your script is named "myplugin.as" and is located in "scripts/plugins/wip/", you will need to write the script name as wip/myplugin.

=== Console commands ===
There are a few console commands that apply to plugins:
{| class="wikitable" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
! Command name
! Purpose
! Admin only?
|-
| as_listplugins
| Shows a list of all plugins currently active on this server
| No
|-
| as_reloadplugin
| Reloads a plugin that is in the list of plugins
| Yes
|-
| as_reloadplugins
| Reloads all plugins from the plugin list file
| Yes
|-
| as_removeplugin
| Removes a plugin from the plugin list
| Yes
|-
| as_removeplugins
| Removes all plugins
| Yes
|}

=== API availability ===
Most of the API is available for plugins to use, but there are a few things that are exclusive to them:

* CAdminControl: administrative control for actions such as penalizing, killing, kicking, and banning players.
* Plugin and plugin temp directories in the filesystem: Ability to read/write files in these directories is restricted to plugins.
'''Hooks:'''
* CanPlayerUseReservedSlot
* ClientConnected
Consult the documentation for the respective features for more information. For information on which parts of the API are exclusive to other script types, consult their documentation.
== Importing scripts ==

Other script files can be imported if you wish to use components from them via the #include directive:

<nowiki>
#include "path/to/another/script"</nowiki>

This is inserted to the top of the script file above any code.

The path is relative to ''this'' script file, so if the script file you wish to import is in the same folder simply specify the filename. Otherwise you must set the path to the subfolder that the script file exists in.

[[Category:Scripting]]

Squadmaker

2025-10-21T14:27:32Z

Outerbeast: /* Keyvalues */

{{Entity_Infobox
| title=
}}

A point entity, which, in the creator's sense, allows you to spawn any amount of a specific monster type. This can also be used to spawn other entities as well, though only partially supported. It can be toggled on and off or spawn one monster every time it is triggered and allows many options to be set for the spawned monster(s).

== Keyvalues ==

{{Entity_keyvalue|Classification|classify|Set the class of the spawned monster. Think of how even though zombies and human grunts, by default, both are the players' enemies, yet have a dislike for and attack each other as well. This relation is created through the respective classes of the two monster types. For a complete table of how different classes react to each other, see [[Class Relationship Table|monster class relation table]].}}
{{Entity_keyvalue|Is not revivable|is_not_revivable|If set to 'Yes', monster cannot be revived (by allied players and monsters).}}
{{Entity_keyvalue|Target On Release|target|Targets which are fired whenever a monster is spawned.}}
{{Entity_keyvalue|Monster Type|monstertype|Set the classname of the monster, weapon, item, ammunition or whatever else may be spawned by squadmaker's without working incorrectly here. Click HERE for the list of monsters.}}
{{Entity_keyvalue|Childrens' Name|netname|If set, everything that is spawned by this squadmaker will receive this as its targetname.}}
{{Entity_keyvalue|Monster count|monstercount|Total amount of monsters which can be spawned by this squadmaker. If this value runs, the squadmaker won't spawn anything anymore. Setting this to '-1' means an endless supply.}}
{{Entity_keyvalue|Delay between spawns|delay|Delay, in seconds, between spawns.}}
{{Entity_keyvalue|Max live children|m_imaxlivechildren|Maximum amount of spawns by this squadmaker which may exist at a time. Note that for monsters, they will be counted as a live child till their corpse has faded out.}}
{{Entity_keyvalue|Blocked Spawn Handling|spawn_mode|By default, the next monster will spawn as soon as the delay between spawns is over and the spawn area is free. 'Block, spawn as soon as clear' does what it says, which is to ignore the delay between spawns and spawn as soon as the spawn area is clear. Not recommendable for spawning multiple monsters. 'Force spawn, never block' causes a monster to spawn every instant the delay between spawns is over, ignoring whether the spawn area is free or not. If the squadmaker is cyclic, this will be used as well.}}
{{Entity_keyvalue|Amount of Telefrag Damage|dmg|Amount of damage to apply to entities that are blocking this spawner. If the entity dies by this a new monster is spawned.}}
{{Entity_keyvalue|Trigger Condition|trigger_condition|Choose trigger condition for this monster. When condition is met, the "Trigger Target" is fired (e.g. 'Death' condition fires target when monster dies, 'hear player' fires target when monster hears player e.t.c.).}}
{{Entity_keyvalue|Trigger Target|trigger_target|Entity to fire when the above condition becomes true.}}
{{Entity_keyvalue|Body|new_body|This will set which body to use. Body's are different submodels/appearances in model files. Think of the different scientists. Not all models do have multiple body's. '-1' means random.}}
{{Entity_keyvalue|Is Player Ally|is_player_ally|Set whether the spawned monster is an ally or a foe of the players.}}
{{Entity_keyvalue|Override render mode|change_rendermode|If set to 'Yes', the rendermode of the spawned entity will be changed to the one set in this squadmaker.}}
{{Entity_keyvalue|Xenmaker template name|xenmaker|If you set the name of an [[env_xenmaker]] here, its effects will appear every time the squadmaker spawns something.}}
{{Entity_keyvalue|Not solid|notsolid|Set whether the spawned monsters will appear solid to each other and the players or not.}}
{{Entity_keyvalue|Gag|gag|Allows you to mute the spawned monsters.}}
{{Entity_keyvalue|Weapons (Grunt/Massn/etc)|weapons|Set which weapons the spawned monster will receive, depending on whether it is a grunt or an assassin.}}
{{Entity_keyvalue|Squad Name|squadname|Name of a squad for this monster to be part of. Monsters which share the same squadname/are in the same squad, will attempt to stay together and follow their squad's leader (monster with "SquadLeader" flag).}}
{{Entity_keyvalue|Squad leader|is_squad_leader|Set whether the spawned monsters will be leaders of their squad or not.}}
{{Entity_keyvalue|In-game Name|displayname|If set, this will overwrite the monster's default in-game name, which appears in the HUD monsterinfo, which can be enabled/disabled using the CVar 'mp_allowmonsterinfo'. You can use '\n' here to perform a line-break.}}
{{Entity_keyvalue|Blood Color|bloodcolor|Allows you to customize the monster's blood color (or disable it).}}
{{Entity_keyvalue|Custom Health|health|If set, this will overwrite the monster's default health value managed by the skill configuration.}}
{{Entity_keyvalue|Custom Model|new_model|If set, this will overwrite the monster's default model. This needs to be precached using a custom_precache point entity.}}
{{Entity_keyvalue|Custom Min Hullsize (X Y Z)|minhullsize|If set, this will overwrite the monster's default minimum hullsize. Minimum and maximum hullsize form a solid cuboid which define the monster's collision hull. Think of them as two span-vectors originating from the monster's origin.}}
{{Entity_keyvalue|Custom Max Hullsize (X Y Z)|maxhullsize|If set, this will overwrite the monster's default maximum hullsize. Minimum and maximum hullsize form a solid cuboid which define the monster's collision hull. Think of them as two span-vectors originating from the monster's origin.}}
{{Entity_keyvalue|Sound Replacement File|soundlist|Set the path to a sound replacement file for the spawned monsters. The path begins in 'svencoop/sound/mapname', whereas 'mapname' would be your map's name. You can go to the parent directory using '../'. A valid sound replacement file contains one or more lines with two sound-paths, which are seperated by a space and wrapped into quotes. The first sound is the sound to be replaced. The second sound is the new sound. Sound-paths start in the sound directory. You cannot go to the parent directory using '../' in that case. These sounds do not need to be precached using a custom_precache point entity.}}
{{Entity_keyvalue|Monster Roaming (nodes)|freeroam|Set whether monsters spawned by this squadmaker use nodes to freeroam and find their way or don't use nodes at all.}}
{{Entity_keyvalue|Path Name|path_name|Name of first path_waypoint to go to.}}
{{Entity_keyvalue|Entity To Guard|guard_ent|If set, the monster will try to follow and protect (attack its attackers) the given entity.}}
{{Entity_keyvalue|V_model (Weapons Only)|wpn_v_model|If spawning a weapon, this will replace its view model. (The weapon as seen in first person view).}}
{{Entity_keyvalue|W_model (Weapons Only)|wpn_w_model|If spawning a weapon, this will replace its world model. (The weapon as seen when lying somewhere).}}
{{Entity_keyvalue|P_model (Weapons Only)|wpn_p_model|If spawning a weapon, this will replace its player model. (The model as seen held by other players).}}
{{Entity_keyvalue|Angelscript function name|function_name|Name of the function to use from already parsed .as script files. When specified, the function will be called every time the squadmaker spawns a new monster. The function signature is as follows: <code>void Function(CBaseMonster@ pSquadmaker, CBaseEntity@ pMonster)</code>}}

== Flags ==

{{Entity_flag|1|Start on|The squadmaker will start on and start spawning as soon as the map loads.}}
{{Entity_flag|4|Cyclic|Changes the squadmaker's toggle-behaviour to a single-fire-behaviour. With this flag set, the entity will spawn one time every time it is fired.}}
{{Entity_flag|8|Monster clip|Monsters spawned by a squadmaker with this flag set will be blocked by the func_monsterclip brush entity.}}
{{Entity_flag|16|Prisoner|Causes the spawned monster to be an enemy regardless of the ally setting, but it won't attack or harm you in any way.}}
{{Entity_flag|32|Auto size BBox|When trying to spawn something, the squadmaker checks whether the spawn area is free or not. If it is not free, it won't spawn. By default, the checked area is way larger than the average monster. Checking this flag will resize the checked area depending on what you set the squadmaker to spawn. Setting this flag is highly recommended.}}
{{Entity_flag|64|Cyclic backlog|In case a monster was not spawned although the squadmaker is cyclic and was triggered, e.g. because the spawn was blocked, this will keep track of that and spawn the monster as soon as the spawn is free. This works for multiple monsters and makes a sort of spawn queue. This is useful when a game_counter of yours is triggered by monster death events and thus expects a minimum amount of monsters to be spawned, so the trigger can ever fire.}}
{{Entity_flag|128|Wait for script|If set, a spawned monster won't react to anything after being spawned until it enters a scripted sequence.}}
{{Entity_flag|1024|No respawn (Collectibles)|If the spawned entity is a weapon, an item or ammunition, it won't respawn after being collected when this flag is set.}}
== Issues ==
Not Solid key does not work.
== Changes ==

5.0 Steam Release: Added 'Is not revivable', 'Path Name' and 'Angelscript function name' keyvalues.

{{entity_title}}

[[Category:Entities]]
[[Category:Point entities]]

TE PLAYERDECAL

2025-10-21T14:14:00Z

Outerbeast: Created page with "TE_PLAYERDECAL Applies a player's custom spray to a world or entity surface. <code>CUtility</code> method: <code>void PlayerDecalTrace(Trace..."

[[File:TE PLAYERDECAL.gif|frame|TE_PLAYERDECAL]]
Applies a player's custom spray to a world or entity surface.

<code>CUtility</code> method:
<code>void PlayerDecalTrace(TraceResult& in trace, int iPlayerNum, int iDecalNumber, const bool bIsCustom)</code>

<pre>
void te_playerdecal(Vector pos, CBasePlayer@ plr, CBaseEntity@ brushEnt=null, NetworkMessageDest msgType=MSG_BROADCAST, edict_t@ dest=null)
{
NetworkMessage m(msgType, NetworkMessages::SVC_TEMPENTITY, dest);
m.WriteByte(TE_DECAL);
m.WriteByte(plr.entindex());
m.WriteCoord(pos.x);
m.WriteCoord(pos.y);
m.WriteCoord(pos.z);
m.WriteShort(brushEnt is null ? 0 : brushEnt.entindex());
m.WriteByte(0); // decal index does not apply here but it's still required
m.End();
}</pre>

Vector pos Center location of the decal. It needs to be witnin a few units of a surface.
CBasePlayer@ plr Player to load spray from
CBaseEntity@ brushEnt Brush entity to apply the decal to. If null, the decal is applied to the world instead.

TE MULTIGUNSHOT

2025-10-21T14:10:08Z

Outerbeast: Created page with "TE_MULTIGUNSHOT Applies multiple decals on the targgeted surface (brush entity or world). A ricochet sound effect is played if count is >= 3..."

[[File:TE MULTIGUNSHOT.gif|frame|TE_MULTIGUNSHOT]]
Applies multiple decals on the targgeted surface (brush entity or world). A ricochet sound effect is played if count is >= 3. No tracers are shown and monsters are ignored.

Unlike the other decal methods, the position of a decal is determined by the intersection of a shoot vector and a wall.

<pre>
void te_multigunshot(Vector pos, Vector dir, float spreadX=512.0f,
float spreadY=512.0f, uint8 count=8, string decal="{shot4",
NetworkMessageDest msgType=MSG_BROADCAST, edict_t@ dest=null)
{
NetworkMessage m(msgType, NetworkMessages::SVC_TEMPENTITY, dest);
m.WriteByte(TE_MULTIGUNSHOT);
m.WriteCoord(pos.x);
m.WriteCoord(pos.y);
m.WriteCoord(pos.z);
m.WriteCoord(dir.x);
m.WriteCoord(dir.y);
m.WriteCoord(dir.z);
m.WriteCoord(spreadX);
m.WriteCoord(spreadY);
m.WriteByte(count);
m.WriteByte(g_EngineFuncs.DecalIndex(decal));
m.End();
}
</pre>

* Vector pos Location to shoot from
* Vector dir Shoot direction
* float spreadX Amount to randomize direction for each trace/decal (horizontal)
* float spreadY Amount to randomize direction for each trace/decal (vertical)
* uint8 count Number of bullets to shoot / decals to apply
* string decal Texture name from decals.wad

SayParameters

2025-10-21T14:05:21Z

Outerbeast:

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 <code>bool ShouldHide</code>: Controls whether this text will be hidden or not. This is implemented as a property accessor and mutator. Default false.

{| class="wikitable" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
! Function
! Description
|-
| <code>CBasePlayer@ GetPlayer() const
| Gets the player that is saying something.
|-
| <code>ClientSayType GetSayType() const
| Gets the say type of this text.
|-
| <code>const string& GetCommand() const
| Gets the entire command string.
|-
| <code>const CCommand@ GetArguments() const
| Gets the arguments in this command.
|}
[[Category:Scripting]]

CSoundEngine

2025-10-21T14:00:20Z

Outerbeast: /* Methods */

The sound system allows you to play sounds, sentences and sentence groups, complete with sound replacement.

HTML documentation can be found [http://baso88.github.io/SC_AngelScript/docs/CSoundEngine.htm here].

Implemented in the CSoundEngine class.

A single global instance exists: <code>CSoundEngine g_SoundSystem;</code>

== Constants ==
All these constants exist in global scope.

==== SOUND_CHANNEL ====
Sound channels represent a number of audio channels that can simultaneously play sounds for any given entity. Note that despite what the name of some channels might imply, none of them are intended for any particular type of sound, with the exception of CHAN_STATIC due to its special behavior in networking code.

{| class="wikitable"
|-
! Channel
! Description
|-
| <code>CHAN_AUTO
| Automatically selects a channel for use. You cannot stop sounds while using this channel with StopSound, or in conjunction with the SND_STOP flag.
|-
| <code>CHAN_WEAPON
| Sound channel recommended for weapons.
|-
| <code>CHAN_VOICE
| Sound channel recommended for voice (speaking).
|-
| <code>CHAN_ITEM
| Sound channel recommended for items (pickup sounds, etc).
|-
| <code>CHAN_BODY
| Sound channel recommended for body events (footsteps, clothes, etc).
|-
| <code>CHAN_STREAM
| General purpose channel.
|-
| <code>CHAN_STATIC
| Channel used for sounds that loop, or sounds that play for a long time (e.g. music). Is always sent to players, even if they are not within the Potentially Audible Set (i.e. outside of the audible range).
|-
| <code>CHAN_NETWORKVOICE_BASE
| Reserved for player voice data. Do not use.
|-
| <code>CHAN_NETWORKVOICE_END
| Reserved for player voice data. Do not use.
|}


==== Sound flags ====

{| class="wikitable"
|-
! Constant
! Description
|-
| <code>SND_VOLUME
| If set, a volume other than 1 is used. Do not use directly, automatically set.
|-
| <code>SND_PITCH
| If set, a pitch other than 100 is used. Do not use directly, automatically set.
|-
| <code>SND_ATTENUATION
| If set, an attenuation other than ATTN_NORM is used. Do not use directly, automatically set.
|-
| <code>SND_ORIGIN
| If set, an origin is sent instead of using the entity origin. Do not use directly, automatically set.
|-
| <code>SND_ENT
| If set, the sound is being played for an entity and its origin should be used. Do not use directly, automatically set.
|-
| <code>SND_STOP
| Tells the client to stop playing a sound.
|-
| <code>SND_CHANGE_VOL
| If set, instead of restarting the sound, just changes its volume.
|-
| <code>SND_CHANGE_PITCH
| If set, instead of restarting the sound, just changes its pitch.
|-
| <code>SND_SENTENCE
| If set, this is a sentence. Do not use directly, automatically set.
|-
| <code>SND_REFRESH
| If set, the sound is refreshed so clients that previously did not receive the sound due to not being in the Potentially Audible Set (for all channels except CHAN_STATIC) or not on the server when the sound started (all channels) will still hear it.
|-
| <code>SND_FORCE_SINGLE
| If set, the sound will not loop even if it normally would, e.g. if it has a cue point.
|-
| <code>SND_FORCE_LOOP
| If set, the sound will loop even if it normally wouldn’t, e.g. if it does not have a cue point.
|-
| <code>SND_LINEAR
| If set, the given attenuation has linear falloff. See [[CSoundEngine#Attenuation|Attenuation]].
|-
| <code>SND_SKIP_ORIGIN_USE_ENT
| Don’t send the sound’s origin, instead, rely on entity index to re-create origin on client dll.
|}



==== Attenuation ====

Attenuation affects sound falloff.

Falloff normally occurs between 64 and ( 4 / attenuation ) * 256. The flag SND_LINEAR can override this to provide a custom falloff range. When SND_LINEAR is used, the attenuation value is defined as follows: The lower 4 bits are minimum falloff, the higher 4 bits are maximum falloff. Minimum is multiplied by 256, maximum is multiplied by 256 and added to 32.

{| class="wikitable"
|-
! Constant
! Description
|-
| <code>const float ATTN_NONE
| No attenuation is applied. Falloff is defined as minimum and maximum 10000. Equivalent to ambient_generic “play everywhere” flag.
|-
| <code>const float ATTN_NORM
| Normal attenuation. Equivalent to ambient_generic “large radius” flag.
|-
| <code>const float ATTN_IDLE
| Idle attenuation. Equivalent to ambient_generic “small radius” flag.
|-
| <code>const float ATTN_STATIC
| Static attenuation. Equivalent to ambient_generic “medium radius” flag.
|}


==== Pitch ====

Pitch affects playback speed and can be used to simulate different voice depths.

Values are possible in the range [0, 255], where 255 is very high.

{| class="wikitable"
|-
! Constant
! Value
! Description
|-
| <code>PITCH_NORM
| 100
| Non-pitch shifted.
|-
| <code>PITCH_LOW
| 95
| Low pitch. Can be used for deep voices.
|-
| <code>PITCH_HIGH
| 120
| High pitch. Can be used for high voices (helium, children, etc).
|}


==== Other ====

{| class="wikitable"
|-
! Constant
! Description
|-
| <code>const float VOL_NORM
| Normal volume level.
|}



== Methods ==
Note: For the methods that support <code>edict_t@ entity</code> paramater to set an entity to emit the sound-
* '''The entity must have a model''', otherwise the sound position does not get networked to clients. This is because the server knows where it is and can thus play the sound from there but clients won't know if/when the entity's position changes.
* Sounds emitted from an entity will not play if <code>EF_NODRAW</code> is set for the entity

==== PrecacheSound ====
<pre>void PrecacheSound(const string& in szFilename)</pre>
This method allows you to precache a sound for use. Sounds must be precached in MapInit or an entity’s Precache method.

The file path starts in sound/.

{| class="wikitable"
|-
! Argument
! Purpose
|-
| <code>szFilename
| Name of the file to precache.
|}


==== FindSoundReplacementSample ====

<pre>string FindSoundReplacementSample(CBaseEntity@ pEntity, const string& in szSample) const</pre>
Finds the sound replacement sample for the given entity and sample. If the sample is replaced, it will return the sample that is used instead. Otherwise, szSample is returned.

Both the entity’s sound replacement file as well as the global file will be checked.

{| class="wikitable"
|-
! Argument
! Purpose
|-
| <code>pEntity
| Entity whose sound replacement file will be checked. Must be valid.
|-
| <code>szSample
| Sample to look up.
|}


==== PlaySound ====

<pre>void PlaySound(edict_t@ entity, SOUND_CHANNEL channel, const string& in sample, float volume, float attenuation, int flags = 0, int pitch = PITCH_NORM, int target_ent_unreliable = 0, bool setOrigin = false, const Vector& in vecOrigin = g_vecZero)</pre>
Plays a sound. The sound is not considered for sound replacement.

{| class="wikitable"
|-
! Argument
! Purpose
|-
| <code>entity
| Entity that the sound will be attached to. Sounds are played at the entity’s origin.
|-
| <code>channel
| Sound channel to use. An entity can have a sound playing on every channel it has at the same time. See [[CSoundEngine#SOUND_CHANNEL|SOUND_CHANNEL]].
|-
| <code>sample
| Name of the sound to play.
|-
| <code>volume
| Volume to play the sound at. This value has a range of [0, 1], where 0 is muted, and 1 is maximum volume.
|-
| <code>attenuation
| Attenuation. Values lie in the range [0, 4]. Higher values decrease the falloff range. See [[CSoundEngine#Attenuation|Attenuation]].
|-
| <code>flags
| Bit vector containing a number of flags. See [[CSoundEngine#sound-flags|Sound flags]].
|-
| <code>pitch
| Pitch to use. See [[CSoundEngine#Pitch|Pitch]].
|-
| <code>target_ent_unreliable
| If not zero, this is the entity index of a player to send this sound to unreliably. Useful for non-critical sounds.
|-
| <code>setOrigin
| If true, use the given origin to play the sound, instead of the entity origin.
|-
| <code>vecOrigin
| If setOrigin is true, this is the origin in the world to play the sound at.
|}



==== StopSound ====

<pre>void StopSound(edict_t@ entity, SOUND_CHANNEL channel, const string& in szSample, const bool fUseSoundReplacement = true)</pre>
Stops a sound that is playing on the given entity’s channel.

{| class="wikitable"
|-
! Argument
! Purpose
|-
| <code>entity
| Entity whose sound will be stopped.
|-
| <code>channel
| Sound channel to stop.
|-
| <code>sample
| Name of the sound to stop.
|-
| <code>fUseSoundReplacement
| Whether to use sound replacement to find the actual sample or not.
|}



==== EmitSoundDyn ====

<pre>void EmitSoundDyn(edict_t@ entity, SOUND_CHANNEL channel, const string& in szSample, float flVolume, float flAttenuation, int iFlags = 0, int iPitch = PITCH_NORM, int target_ent_unreliable = 0)</pre>
Plays a sound on the given entity’s channel. The sound may be sound replaced if there is a replacement sample provided by a replacement file.

{| class="wikitable"
|-
! Argument
! Purpose
|-
| <code>entity
| Entity that the sound will be attached to. Sounds are played at the entity’s origin.
|-
| <code>channel
| Sound channel to use. An entity can have a sound playing on every channel it has at the same time. See [[SoundSystem#SOUND_CHANNEL|SOUND_CHANNEL]].
|-
| <code>szSample
| Name of the sound to play.
|-
| <code>flVolume
| Volume to play the sound at. This value has a range of [0, 1], where 0 is muted, and 1 is maximum volume.
|-
| <code>flAttenuation
| Attenuation. Values lie in the range [0, 4]. Higher values decrease the falloff range. See [[SoundSystem#Attenuation|Attenuation]].
|-
| <code>iFlags
| Bit vector containing a number of flags. See [[SoundSystem#Sound-flags|Sound flags]].
|-
| <code>iPitch
| Pitch to use. See [[SoundSystem#Pitch|Pitch]].
|-
| <code>target_ent_unreliable
| If not zero, this is the entity index of a player to send this sound to unreliably. Useful for non-critical sounds.
|}



==== EmitSound ====

<pre>void EmitSound(edict_t@ entity, SOUND_CHANNEL channel, const string& in szSample, float flVolume, float flAttenuation)</pre>
Identical to EmitSoundDyn, but provides default values for omitted arguments.



==== EmitSoundSuit ====

<pre>void EmitSoundSuit(edict_t@ entity, const string& in szSample)</pre>
Play a specific sentence over the HEV suit speaker - just pass player entity, and !sentencename. Pitch is randomly calculated to fall around PITCH_NORM, volume is determined by the suitvolume cvar. Attenuation is ATTN_NORM.

{| class="wikitable"
|-
! Argument
! Purpose
|-
| <code>entity
| Entity where the suit sound will be played. Can be any entity, not just a player.
|-
| <code>szSample
| Sentence to play.
|}



==== EmitGroupIdSuit ====

<pre>void EmitGroupIdSuit(edict_t@ entity, int isentencereg)</pre>
Play a sentence, randomly selected from the passed in group id, over the HEV suit speaker.

{| class="wikitable"
|-
! Argument
! Purpose
|-
| <code>entity
| Entity where the suit sound will be played. Can be any entity, not just a player.
|-
| <code>isentencereg
| Sentence group to play. Must be a sentence group id retrieved using the sound system’s sentence methods.
|}

==== EmitGroupNameSuit ====

<pre>void EmitGroupNameSuit(edict_t@ entity, const string& in szSample)</pre>
Play a sentence, randomly selected from the passed in groupname.

{| class="wikitable"
|-
! Argument
! Purpose
|-
| <code>entity
| Entity where the suit sound will be played. Can be any entity, not just a player.
|-
| <code>szSample
| Sentence group to select a sentence from.
|}

==== LookupSentenceIndex ====

<pre>int LookupSentenceIndex(const string& in sentenceName)</pre>
Looks up the sentence index of the given sentence.<code>sentenceName</code> is the name of the sentence to find.

Return value: Sentence index if it was found, 0 otherwise.

==== LookupSentenceGroupIndex ====

<pre>int LookupSentenceGroupIndex(const string& in szGroup)</pre>
Looks up the sentence group index of the given sentence.
<code>szGroup</code> is the name of the sentence group to find.

Return value: Sentence group index if it was found, 0 otherwise.

==== PlaySentenceGroup ====

<pre>int PlaySentenceGroup(edict_t@ entity, const string& in szGroupName, float volume, float attenuation, int flags, int pitch)</pre>
Plays a sentence from a sentence group. The sentence is randomly selected.

{| class="wikitable"
|-
! Argument
! Purpose
|-
| <code>entity
| Entity where the sentence will be played.
|-
| <code>szGroupName
| Group to select a sentence from.
|-
| <code>volume
| Volume.
|-
| <code>attenuation
| Attenuation.
|-
| <code>flags
| Sound flags.
|-
| <code>pitch
| Pitch.
|}

Return value: Index of the sentence that was played, or -1 if no such sentence group exists.

==== PlaySentenceGroup ====

<pre>int PlaySentenceGroup(edict_t@ entity, int iGroupIndex, float volume, float attenuation, int flags, int pitch)</pre>
Plays a sentence from a sentence group. The sentence is randomly selected.

{| class="wikitable"
|-
! Argument
! Purpose
|-
| <code>entity
| Entity where the sentence will be played.
|-
| <code>iGroupIndex
| Group index to select a sentence from.
|-
| <code>volume
| Volume.
|-
| <code>attenuation
| Attenuation.
|-
| <code>flags
| Sound flags.
|-
| <code>pitch
| Pitch.
|}

Return value:

Index of the sentence that was played.

==== PlaySentenceGroupSequential ====

<pre>int PlaySentenceGroupSequential(edict_t@ entity, const string& in szGroupName, float volume, float attenuation, int flags, int pitch, int ipick, const bool bReset)</pre>
Plays a sentence group sequentially.

{| class="wikitable"
|-
! Argument
! Purpose
|-
| <code>entity
| Entity where the sentence will be played.
|-
| szGroupName
| Name of the group to get the next sentence from.
|-
| <code>volume
| Volume.
|-
| <code>attenuation
| Attenuation.
|-
| <code>flags
| Sound flags.
|-
| <code>pitch
| Pitch.
|-
| <code>ipick
| Sentence to pick.
|-
| <code>bReset
| If true, the first sentence in the group will be used instead of ipick.
|}

Return value:

Index of the sentence after the sentence that was played.


==== EmitAmbientSound ====

<pre>void EmitAmbientSound(edict_t@ entity, const Vector& in vecOrigin, const string& in szSample, float flVolume, float flAttenuation, int fFlags, int iPitch)</pre>
Plays an ambient sound. Ambient sounds use CHAN_STATIC.

{| class="wikitable"
|-
! Argument
! Purpose
|-
| <code>entity
| Entity that the sound will be attached to. Sounds are played at the entity’s origin.
|-
| <code>vecOrigin
| Origin to play the sound at.
|-
| <code>szSample
| Name of the sound to play.
|-
| <code>flVolume
| Volume to play the sound at. This value has a range of [0, 1], where 0 is muted, and 1 is maximum volume.
|-
| <code>flAttenuation
| Attenuation. Values lie in the range [0, 4]. Higher values decrease the falloff range. See [[SoundSystem#Attenuation|Attenuation]].
|-
| <code>iFlags
| Bit vector containing a number of flags. See [[SoundSystem#Sound-flags|Sound flags]].
|-
| <code>iPitch
| Pitch to use. See [[SoundSystem#Pitch|Pitch]].
|}


==== PlayHitSound ====

<pre>float PlayHitSound(TraceResult& in tr, const Vector& in vecSrc, const Vector& in vecEnd, int iBulletType)</pre>
Plays a hit sound based on the trace result’s hit target. Returns the volume at which the hit is being played.

{| class="wikitable"
|-
! Argument
! Purpose
|-
| <code>tr
| Traceline to use.
|-
| <code>vecSrc
| Starting point for texture trace. Typically the location where a bullet is being fired from, or where a melee weapon starts its trace from.
|-
| <code>vecEnd
| End point for texture trace. Typically the location that defines the end position that a bullet traceline goes to, or where a melee weapon ends its trace at.
|-
| <code>iBulletType
| See the [[Bullet]] enum.
|}

[[Category:Scripting]]

CSoundEngine

2025-10-21T13:59:38Z

Outerbeast:

The sound system allows you to play sounds, sentences and sentence groups, complete with sound replacement.

HTML documentation can be found [http://baso88.github.io/SC_AngelScript/docs/CSoundEngine.htm here].

Implemented in the CSoundEngine class.

A single global instance exists: <code>CSoundEngine g_SoundSystem;</code>

== Constants ==
All these constants exist in global scope.

==== SOUND_CHANNEL ====
Sound channels represent a number of audio channels that can simultaneously play sounds for any given entity. Note that despite what the name of some channels might imply, none of them are intended for any particular type of sound, with the exception of CHAN_STATIC due to its special behavior in networking code.

{| class="wikitable"
|-
! Channel
! Description
|-
| <code>CHAN_AUTO
| Automatically selects a channel for use. You cannot stop sounds while using this channel with StopSound, or in conjunction with the SND_STOP flag.
|-
| <code>CHAN_WEAPON
| Sound channel recommended for weapons.
|-
| <code>CHAN_VOICE
| Sound channel recommended for voice (speaking).
|-
| <code>CHAN_ITEM
| Sound channel recommended for items (pickup sounds, etc).
|-
| <code>CHAN_BODY
| Sound channel recommended for body events (footsteps, clothes, etc).
|-
| <code>CHAN_STREAM
| General purpose channel.
|-
| <code>CHAN_STATIC
| Channel used for sounds that loop, or sounds that play for a long time (e.g. music). Is always sent to players, even if they are not within the Potentially Audible Set (i.e. outside of the audible range).
|-
| <code>CHAN_NETWORKVOICE_BASE
| Reserved for player voice data. Do not use.
|-
| <code>CHAN_NETWORKVOICE_END
| Reserved for player voice data. Do not use.
|}


==== Sound flags ====

{| class="wikitable"
|-
! Constant
! Description
|-
| <code>SND_VOLUME
| If set, a volume other than 1 is used. Do not use directly, automatically set.
|-
| <code>SND_PITCH
| If set, a pitch other than 100 is used. Do not use directly, automatically set.
|-
| <code>SND_ATTENUATION
| If set, an attenuation other than ATTN_NORM is used. Do not use directly, automatically set.
|-
| <code>SND_ORIGIN
| If set, an origin is sent instead of using the entity origin. Do not use directly, automatically set.
|-
| <code>SND_ENT
| If set, the sound is being played for an entity and its origin should be used. Do not use directly, automatically set.
|-
| <code>SND_STOP
| Tells the client to stop playing a sound.
|-
| <code>SND_CHANGE_VOL
| If set, instead of restarting the sound, just changes its volume.
|-
| <code>SND_CHANGE_PITCH
| If set, instead of restarting the sound, just changes its pitch.
|-
| <code>SND_SENTENCE
| If set, this is a sentence. Do not use directly, automatically set.
|-
| <code>SND_REFRESH
| If set, the sound is refreshed so clients that previously did not receive the sound due to not being in the Potentially Audible Set (for all channels except CHAN_STATIC) or not on the server when the sound started (all channels) will still hear it.
|-
| <code>SND_FORCE_SINGLE
| If set, the sound will not loop even if it normally would, e.g. if it has a cue point.
|-
| <code>SND_FORCE_LOOP
| If set, the sound will loop even if it normally wouldn’t, e.g. if it does not have a cue point.
|-
| <code>SND_LINEAR
| If set, the given attenuation has linear falloff. See [[CSoundEngine#Attenuation|Attenuation]].
|-
| <code>SND_SKIP_ORIGIN_USE_ENT
| Don’t send the sound’s origin, instead, rely on entity index to re-create origin on client dll.
|}



==== Attenuation ====

Attenuation affects sound falloff.

Falloff normally occurs between 64 and ( 4 / attenuation ) * 256. The flag SND_LINEAR can override this to provide a custom falloff range. When SND_LINEAR is used, the attenuation value is defined as follows: The lower 4 bits are minimum falloff, the higher 4 bits are maximum falloff. Minimum is multiplied by 256, maximum is multiplied by 256 and added to 32.

{| class="wikitable"
|-
! Constant
! Description
|-
| <code>const float ATTN_NONE
| No attenuation is applied. Falloff is defined as minimum and maximum 10000. Equivalent to ambient_generic “play everywhere” flag.
|-
| <code>const float ATTN_NORM
| Normal attenuation. Equivalent to ambient_generic “large radius” flag.
|-
| <code>const float ATTN_IDLE
| Idle attenuation. Equivalent to ambient_generic “small radius” flag.
|-
| <code>const float ATTN_STATIC
| Static attenuation. Equivalent to ambient_generic “medium radius” flag.
|}


==== Pitch ====

Pitch affects playback speed and can be used to simulate different voice depths.

Values are possible in the range [0, 255], where 255 is very high.

{| class="wikitable"
|-
! Constant
! Value
! Description
|-
| <code>PITCH_NORM
| 100
| Non-pitch shifted.
|-
| <code>PITCH_LOW
| 95
| Low pitch. Can be used for deep voices.
|-
| <code>PITCH_HIGH
| 120
| High pitch. Can be used for high voices (helium, children, etc).
|}


==== Other ====

{| class="wikitable"
|-
! Constant
! Description
|-
| <code>const float VOL_NORM
| Normal volume level.
|}



== Methods ==
Note: For the methods that support <code>edict_t@ entity</code> paramater to set an entity to emit the sound
* '''The entity must have a model''', otherwise the sound position does not get networked to clients. This is because the server knows where it is and can thus play the sound from there but clients won't know if/when the entity's position changes.
* Sounds emitted from an entity will not play if <code>EF_NODRAW</code> is set for the entity

==== PrecacheSound ====
<pre>void PrecacheSound(const string& in szFilename)</pre>
This method allows you to precache a sound for use. Sounds must be precached in MapInit or an entity’s Precache method.

The file path starts in sound/.

{| class="wikitable"
|-
! Argument
! Purpose
|-
| <code>szFilename
| Name of the file to precache.
|}


==== FindSoundReplacementSample ====

<pre>string FindSoundReplacementSample(CBaseEntity@ pEntity, const string& in szSample) const</pre>
Finds the sound replacement sample for the given entity and sample. If the sample is replaced, it will return the sample that is used instead. Otherwise, szSample is returned.

Both the entity’s sound replacement file as well as the global file will be checked.

{| class="wikitable"
|-
! Argument
! Purpose
|-
| <code>pEntity
| Entity whose sound replacement file will be checked. Must be valid.
|-
| <code>szSample
| Sample to look up.
|}


==== PlaySound ====

<pre>void PlaySound(edict_t@ entity, SOUND_CHANNEL channel, const string& in sample, float volume, float attenuation, int flags = 0, int pitch = PITCH_NORM, int target_ent_unreliable = 0, bool setOrigin = false, const Vector& in vecOrigin = g_vecZero)</pre>
Plays a sound. The sound is not considered for sound replacement.

{| class="wikitable"
|-
! Argument
! Purpose
|-
| <code>entity
| Entity that the sound will be attached to. Sounds are played at the entity’s origin.
|-
| <code>channel
| Sound channel to use. An entity can have a sound playing on every channel it has at the same time. See [[CSoundEngine#SOUND_CHANNEL|SOUND_CHANNEL]].
|-
| <code>sample
| Name of the sound to play.
|-
| <code>volume
| Volume to play the sound at. This value has a range of [0, 1], where 0 is muted, and 1 is maximum volume.
|-
| <code>attenuation
| Attenuation. Values lie in the range [0, 4]. Higher values decrease the falloff range. See [[CSoundEngine#Attenuation|Attenuation]].
|-
| <code>flags
| Bit vector containing a number of flags. See [[CSoundEngine#sound-flags|Sound flags]].
|-
| <code>pitch
| Pitch to use. See [[CSoundEngine#Pitch|Pitch]].
|-
| <code>target_ent_unreliable
| If not zero, this is the entity index of a player to send this sound to unreliably. Useful for non-critical sounds.
|-
| <code>setOrigin
| If true, use the given origin to play the sound, instead of the entity origin.
|-
| <code>vecOrigin
| If setOrigin is true, this is the origin in the world to play the sound at.
|}



==== StopSound ====

<pre>void StopSound(edict_t@ entity, SOUND_CHANNEL channel, const string& in szSample, const bool fUseSoundReplacement = true)</pre>
Stops a sound that is playing on the given entity’s channel.

{| class="wikitable"
|-
! Argument
! Purpose
|-
| <code>entity
| Entity whose sound will be stopped.
|-
| <code>channel
| Sound channel to stop.
|-
| <code>sample
| Name of the sound to stop.
|-
| <code>fUseSoundReplacement
| Whether to use sound replacement to find the actual sample or not.
|}



==== EmitSoundDyn ====

<pre>void EmitSoundDyn(edict_t@ entity, SOUND_CHANNEL channel, const string& in szSample, float flVolume, float flAttenuation, int iFlags = 0, int iPitch = PITCH_NORM, int target_ent_unreliable = 0)</pre>
Plays a sound on the given entity’s channel. The sound may be sound replaced if there is a replacement sample provided by a replacement file.

{| class="wikitable"
|-
! Argument
! Purpose
|-
| <code>entity
| Entity that the sound will be attached to. Sounds are played at the entity’s origin.
|-
| <code>channel
| Sound channel to use. An entity can have a sound playing on every channel it has at the same time. See [[SoundSystem#SOUND_CHANNEL|SOUND_CHANNEL]].
|-
| <code>szSample
| Name of the sound to play.
|-
| <code>flVolume
| Volume to play the sound at. This value has a range of [0, 1], where 0 is muted, and 1 is maximum volume.
|-
| <code>flAttenuation
| Attenuation. Values lie in the range [0, 4]. Higher values decrease the falloff range. See [[SoundSystem#Attenuation|Attenuation]].
|-
| <code>iFlags
| Bit vector containing a number of flags. See [[SoundSystem#Sound-flags|Sound flags]].
|-
| <code>iPitch
| Pitch to use. See [[SoundSystem#Pitch|Pitch]].
|-
| <code>target_ent_unreliable
| If not zero, this is the entity index of a player to send this sound to unreliably. Useful for non-critical sounds.
|}



==== EmitSound ====

<pre>void EmitSound(edict_t@ entity, SOUND_CHANNEL channel, const string& in szSample, float flVolume, float flAttenuation)</pre>
Identical to EmitSoundDyn, but provides default values for omitted arguments.



==== EmitSoundSuit ====

<pre>void EmitSoundSuit(edict_t@ entity, const string& in szSample)</pre>
Play a specific sentence over the HEV suit speaker - just pass player entity, and !sentencename. Pitch is randomly calculated to fall around PITCH_NORM, volume is determined by the suitvolume cvar. Attenuation is ATTN_NORM.

{| class="wikitable"
|-
! Argument
! Purpose
|-
| <code>entity
| Entity where the suit sound will be played. Can be any entity, not just a player.
|-
| <code>szSample
| Sentence to play.
|}



==== EmitGroupIdSuit ====

<pre>void EmitGroupIdSuit(edict_t@ entity, int isentencereg)</pre>
Play a sentence, randomly selected from the passed in group id, over the HEV suit speaker.

{| class="wikitable"
|-
! Argument
! Purpose
|-
| <code>entity
| Entity where the suit sound will be played. Can be any entity, not just a player.
|-
| <code>isentencereg
| Sentence group to play. Must be a sentence group id retrieved using the sound system’s sentence methods.
|}

==== EmitGroupNameSuit ====

<pre>void EmitGroupNameSuit(edict_t@ entity, const string& in szSample)</pre>
Play a sentence, randomly selected from the passed in groupname.

{| class="wikitable"
|-
! Argument
! Purpose
|-
| <code>entity
| Entity where the suit sound will be played. Can be any entity, not just a player.
|-
| <code>szSample
| Sentence group to select a sentence from.
|}

==== LookupSentenceIndex ====

<pre>int LookupSentenceIndex(const string& in sentenceName)</pre>
Looks up the sentence index of the given sentence.<code>sentenceName</code> is the name of the sentence to find.

Return value: Sentence index if it was found, 0 otherwise.

==== LookupSentenceGroupIndex ====

<pre>int LookupSentenceGroupIndex(const string& in szGroup)</pre>
Looks up the sentence group index of the given sentence.
<code>szGroup</code> is the name of the sentence group to find.

Return value: Sentence group index if it was found, 0 otherwise.

==== PlaySentenceGroup ====

<pre>int PlaySentenceGroup(edict_t@ entity, const string& in szGroupName, float volume, float attenuation, int flags, int pitch)</pre>
Plays a sentence from a sentence group. The sentence is randomly selected.

{| class="wikitable"
|-
! Argument
! Purpose
|-
| <code>entity
| Entity where the sentence will be played.
|-
| <code>szGroupName
| Group to select a sentence from.
|-
| <code>volume
| Volume.
|-
| <code>attenuation
| Attenuation.
|-
| <code>flags
| Sound flags.
|-
| <code>pitch
| Pitch.
|}

Return value: Index of the sentence that was played, or -1 if no such sentence group exists.

==== PlaySentenceGroup ====

<pre>int PlaySentenceGroup(edict_t@ entity, int iGroupIndex, float volume, float attenuation, int flags, int pitch)</pre>
Plays a sentence from a sentence group. The sentence is randomly selected.

{| class="wikitable"
|-
! Argument
! Purpose
|-
| <code>entity
| Entity where the sentence will be played.
|-
| <code>iGroupIndex
| Group index to select a sentence from.
|-
| <code>volume
| Volume.
|-
| <code>attenuation
| Attenuation.
|-
| <code>flags
| Sound flags.
|-
| <code>pitch
| Pitch.
|}

Return value:

Index of the sentence that was played.

==== PlaySentenceGroupSequential ====

<pre>int PlaySentenceGroupSequential(edict_t@ entity, const string& in szGroupName, float volume, float attenuation, int flags, int pitch, int ipick, const bool bReset)</pre>
Plays a sentence group sequentially.

{| class="wikitable"
|-
! Argument
! Purpose
|-
| <code>entity
| Entity where the sentence will be played.
|-
| szGroupName
| Name of the group to get the next sentence from.
|-
| <code>volume
| Volume.
|-
| <code>attenuation
| Attenuation.
|-
| <code>flags
| Sound flags.
|-
| <code>pitch
| Pitch.
|-
| <code>ipick
| Sentence to pick.
|-
| <code>bReset
| If true, the first sentence in the group will be used instead of ipick.
|}

Return value:

Index of the sentence after the sentence that was played.


==== EmitAmbientSound ====

<pre>void EmitAmbientSound(edict_t@ entity, const Vector& in vecOrigin, const string& in szSample, float flVolume, float flAttenuation, int fFlags, int iPitch)</pre>
Plays an ambient sound. Ambient sounds use CHAN_STATIC.

{| class="wikitable"
|-
! Argument
! Purpose
|-
| <code>entity
| Entity that the sound will be attached to. Sounds are played at the entity’s origin.
|-
| <code>vecOrigin
| Origin to play the sound at.
|-
| <code>szSample
| Name of the sound to play.
|-
| <code>flVolume
| Volume to play the sound at. This value has a range of [0, 1], where 0 is muted, and 1 is maximum volume.
|-
| <code>flAttenuation
| Attenuation. Values lie in the range [0, 4]. Higher values decrease the falloff range. See [[SoundSystem#Attenuation|Attenuation]].
|-
| <code>iFlags
| Bit vector containing a number of flags. See [[SoundSystem#Sound-flags|Sound flags]].
|-
| <code>iPitch
| Pitch to use. See [[SoundSystem#Pitch|Pitch]].
|}


==== PlayHitSound ====

<pre>float PlayHitSound(TraceResult& in tr, const Vector& in vecSrc, const Vector& in vecEnd, int iBulletType)</pre>
Plays a hit sound based on the trace result’s hit target. Returns the volume at which the hit is being played.

{| class="wikitable"
|-
! Argument
! Purpose
|-
| <code>tr
| Traceline to use.
|-
| <code>vecSrc
| Starting point for texture trace. Typically the location where a bullet is being fired from, or where a melee weapon starts its trace from.
|-
| <code>vecEnd
| End point for texture trace. Typically the location that defines the end position that a bullet traceline goes to, or where a melee weapon ends its trace at.
|-
| <code>iBulletType
| See the [[Bullet]] enum.
|}

[[Category:Scripting]]

Trigger changevalue

2025-10-07T10:06:27Z

Outerbeast: Remove /* Issues */

{{Entity_Infobox
| title=
}}

Trigger_changevalue can perform arithmetic and logic operations on base-keyvalues of entities, as well as replace their private keyvalues. See [[trigger_copyvalue]] for a variant of this with more options. Supports custom keyvalues.

== Keyvalues ==

{{Entity_keyvalue|Destination Entity|target|Name of the entity which's keyvalue is to changed. This can refer to more than one.}}
{{Entity_keyvalue|Destination Keyvalue|m_iszValueName|Name of the key which's value is to be changed.}}
{{Entity_keyvalue|Static source-value|m_iszNewValue|Value to be applied to the destination keyvalue.}}
{{Entity_keyvalue|Operation|m_iszValueType|This specifies how destination keyvalue and static source-value correlate. What exactly happens also depends on the types
of the two. There are some academic things in here, so I shall explain some of them:Pow: Source value to the power of destination value. To keep things simple, zero to the power of zero magically equals one and taking a negative value to the power of a non-integer will cause the base to be treated as positive.Mod: Short for "Modulo", this calculates the rest of a division. For example, 63 % 13 equals 11, because 63 - 13 = 50, 50 - 13 = 37, 37 - 13 = 24 and 24 - 13 = 11. Substracting a fifth time would deliver a negative result and is henceforth omitted. The actual computation of this value uses a smarter, fast method; this is just for presentiveness. Usage example: You have a value in seconds, e.g. 285, and want to know how many minutes and seconds that are, so you divide by 60 and get 4.75. Omitting the 0.75 you're left with 4. For the remaining seconds, you'd calculate 285 % 60 = 45, which
is the same as 60 * 0.75. Then you'd know that 285 seconds equals 4 minutes plus 45 seconds. Real numbers and negative values are supported.AND, OR, XOR, NAND, NOR, NXOR: These are logic operands which operate bitwise; the leading 'N' indicates bitwise negation after the operation. Example: An entity's spawnflags are stored in an integer which consists of 32 bits. Say you want to set the 7th checkbox of an entity's spawnflags, you need to make sure the 7th bit is set to 1. You hence need the integer number where only the 7th bit is set, which is 2 ^ (7 - 1) = 2 ^ 6 = 64. However, you cannot simply add this
to the existing spawnflags, because if the 7th bit was already set to 1, you'd cause it to be set to 0 and generate a carry which is sent to the 8th bit; the magic of positional notation systems - just as 500 + 500 equals 1000 in decimal, 100 + 100 equals 1000 in binary. You'd need to perform a bitwise OR. If you'd want only the 7th checkbox to be checked, you'd use replace-operation as usual. XOR means "Exclusive OR", as in "Either that or the other, but not both". AND means that both bits need to be 1 for the resulting bit to remain 1. You can imagine the logic operators perform 32 simultaneous operations on the combined 64 bits of two integers. Append (String concatenation): Appends your source value to the destination keyvalue. The later must be a string; otherwise this cannot work.}}
{{Entity_keyvalue|Trigonometric funcs. I/O|m_trigonometricBehaviour|When using trigonometric or arc-functions as per the "Operation"-keyvalue, this is used to determine what your input/desired output measure is. You'll usually want to stick to degrees.}}
{{Entity_keyvalue|Append spaces (for strings)|m_iAppendSpaces|When the destination keyvalue is a string, this specifies how many spaces to append after the operations. You'll usually want to use this with either the "Replace"- or "Append"-operation. This was implemented because Valve Hammer Editor omits any trailing spaces in keyvalues (but not leading ones).}}
{{Entity_keyvalue|Trigger after operation|message|Set entity/entities to be triggered after the trigger_changevalue has set the new keyvalue, by targetname as usual.
This is very useful when you need a chain of operations to happen in a specific order and without any delay in between.}}

== Flags ==

{{Entity_flag|1|Don't use X|When using vectors/arrays, this will ignore the first array. E.g., when setting render-color, specifying this flag would ignore the 'Red'-value.}}
{{Entity_flag|2|Don't use Y|When using vectors/arrays, this will ignore the second array. E.g., when setting angles, specifying this flag would ignore the 'Yaw'-value.}}
{{Entity_flag|4|Don't use Z|When using vectors/arrays, this will ignore the third array. E.g., when setting velocity, specifying this flag would ignore the vertical velocity.}}
{{Entity_flag|32|Invert target value|The destination keyvalue will be multiplied with minus one before proceeding.}}
{{Entity_flag|64|Invert source value|The source-value will be multiplied with minus one before proceeding; this change is only temporary and this keyvalue is rather useless, as you can always prepend a minus-sign to the static source-value.}}

== Notes ==

* Trigger_changevalue supports the use of "!activator" and "!caller" in the "Destination Entity" field.
* Trying to write a vector to a float or integer will cause the vector's length to be written. This is in respect to any ignored dimensions as per <code>spawnflags</code>.
* When trying to change the value of a [[Custom Keyvalues|custom key]] for an entity but that custom key doesn't yet exist, it will initialise that key first before writing to it.

{{entity_title}}

[[Category:Entities]]
[[Category:Point entities]]

Trigger changevalue

2025-10-07T10:05:53Z

Outerbeast: /* Notes */

{{Entity_Infobox
| title=
}}

Trigger_changevalue can perform arithmetic and logic operations on base-keyvalues of entities, as well as replace their private keyvalues. See [[trigger_copyvalue]] for a variant of this with more options. Supports custom keyvalues.

== Keyvalues ==

{{Entity_keyvalue|Destination Entity|target|Name of the entity which's keyvalue is to changed. This can refer to more than one.}}
{{Entity_keyvalue|Destination Keyvalue|m_iszValueName|Name of the key which's value is to be changed.}}
{{Entity_keyvalue|Static source-value|m_iszNewValue|Value to be applied to the destination keyvalue.}}
{{Entity_keyvalue|Operation|m_iszValueType|This specifies how destination keyvalue and static source-value correlate. What exactly happens also depends on the types
of the two. There are some academic things in here, so I shall explain some of them:Pow: Source value to the power of destination value. To keep things simple, zero to the power of zero magically equals one and taking a negative value to the power of a non-integer will cause the base to be treated as positive.Mod: Short for "Modulo", this calculates the rest of a division. For example, 63 % 13 equals 11, because 63 - 13 = 50, 50 - 13 = 37, 37 - 13 = 24 and 24 - 13 = 11. Substracting a fifth time would deliver a negative result and is henceforth omitted. The actual computation of this value uses a smarter, fast method; this is just for presentiveness. Usage example: You have a value in seconds, e.g. 285, and want to know how many minutes and seconds that are, so you divide by 60 and get 4.75. Omitting the 0.75 you're left with 4. For the remaining seconds, you'd calculate 285 % 60 = 45, which
is the same as 60 * 0.75. Then you'd know that 285 seconds equals 4 minutes plus 45 seconds. Real numbers and negative values are supported.AND, OR, XOR, NAND, NOR, NXOR: These are logic operands which operate bitwise; the leading 'N' indicates bitwise negation after the operation. Example: An entity's spawnflags are stored in an integer which consists of 32 bits. Say you want to set the 7th checkbox of an entity's spawnflags, you need to make sure the 7th bit is set to 1. You hence need the integer number where only the 7th bit is set, which is 2 ^ (7 - 1) = 2 ^ 6 = 64. However, you cannot simply add this
to the existing spawnflags, because if the 7th bit was already set to 1, you'd cause it to be set to 0 and generate a carry which is sent to the 8th bit; the magic of positional notation systems - just as 500 + 500 equals 1000 in decimal, 100 + 100 equals 1000 in binary. You'd need to perform a bitwise OR. If you'd want only the 7th checkbox to be checked, you'd use replace-operation as usual. XOR means "Exclusive OR", as in "Either that or the other, but not both". AND means that both bits need to be 1 for the resulting bit to remain 1. You can imagine the logic operators perform 32 simultaneous operations on the combined 64 bits of two integers. Append (String concatenation): Appends your source value to the destination keyvalue. The later must be a string; otherwise this cannot work.}}
{{Entity_keyvalue|Trigonometric funcs. I/O|m_trigonometricBehaviour|When using trigonometric or arc-functions as per the "Operation"-keyvalue, this is used to determine what your input/desired output measure is. You'll usually want to stick to degrees.}}
{{Entity_keyvalue|Append spaces (for strings)|m_iAppendSpaces|When the destination keyvalue is a string, this specifies how many spaces to append after the operations. You'll usually want to use this with either the "Replace"- or "Append"-operation. This was implemented because Valve Hammer Editor omits any trailing spaces in keyvalues (but not leading ones).}}
{{Entity_keyvalue|Trigger after operation|message|Set entity/entities to be triggered after the trigger_changevalue has set the new keyvalue, by targetname as usual.
This is very useful when you need a chain of operations to happen in a specific order and without any delay in between.}}

== Flags ==

{{Entity_flag|1|Don't use X|When using vectors/arrays, this will ignore the first array. E.g., when setting render-color, specifying this flag would ignore the 'Red'-value.}}
{{Entity_flag|2|Don't use Y|When using vectors/arrays, this will ignore the second array. E.g., when setting angles, specifying this flag would ignore the 'Yaw'-value.}}
{{Entity_flag|4|Don't use Z|When using vectors/arrays, this will ignore the third array. E.g., when setting velocity, specifying this flag would ignore the vertical velocity.}}
{{Entity_flag|32|Invert target value|The destination keyvalue will be multiplied with minus one before proceeding.}}
{{Entity_flag|64|Invert source value|The source-value will be multiplied with minus one before proceeding; this change is only temporary and this keyvalue is rather useless, as you can always prepend a minus-sign to the static source-value.}}

== Notes ==

* Trigger_changevalue supports the use of "!activator" and "!caller" in the "Destination Entity" field.
* Trying to write a vector to a float or integer will cause the vector's length to be written. This is in respect to any ignored dimensions as per <code>spawnflags</code>.
* When trying to change the value of a [[Custom Keyvalues|custom key]] for an entity but that custom key doesn't yet exist, it will initialise that key first before writing to it.

== Issues ==
trigger_changetarget only changes the target of one entity, the first one it can find, if there are several entities of the same name that the changetarget targets - trigger_changevalue can update multiple entities at the same time if they share the same name, so this can be used instead.
 This is fixed in 5.26.

{{entity_title}}

[[Category:Entities]]
[[Category:Point entities]]

TE EXPLODEMODEL

2025-09-13T19:33:38Z

Outerbeast:

Spawns multiple rotating models with gravity, collisions, particle trails, and flashing orange lights.
[[File:TE EXPLODEMODEL.gif|frame|TE_EXPLODEMODEL]]
<pre>
void te_explodemodel(Vector pos, float velocity,
string model="models/hgibs.mdl", uint16 count=8, uint8 life=32,
NetworkMessageDest msgType=MSG_BROADCAST, edict_t@ dest=null)
{
NetworkMessage m(msgType, NetworkMessages::SVC_TEMPENTITY, dest);
m.WriteByte(TE_EXPLODEMODEL);
m.WriteCoord(pos.x);
m.WriteCoord(pos.y);
m.WriteCoord(pos.z);
m.WriteCoord(velocity);
m.WriteShort(g_EngineFuncs.ModelIndex(model));
m.WriteShort(count);
m.WriteByte(life);
m.End();
}
</pre>

* <code>Vector pos</code> Center point for the effect
* <code>float velocity</code> Ejection speed for all models
* <code>string model</code> Model to display
* <code>uint16 count</code> Number of models to spawn
* <code>uint8 life</code> Time to display all models (seconds * 0.1)

[[Category:Scripting]]

Ambient music

2025-08-29T19:41:35Z

Outerbeast:

{{Entity_Infobox
| title=
}}

This entity is used to play music within a level. The difference from [[ambient_generic|Ambient Generic]] is the volume being controlled via the CVar 'mp3volume' instead of 'volume'.
Plays everywhere, is not affected by 3D positioning, reverberation, or filters.
Mappers can adjust volume of individual music tracks by "volume" key value, but the final volume is determined on the client-side based on a value of "MP3Volume" CVAR.
Music will play even for players that joined after the entity was triggered. Playback will start with an appropriate offset for them.
Music can be looped.
== Keyvalues ==

{{Entity_keyvalue|Sound File|message|Name of the sound file to play. File Path starts in the 'sound'-folder, example: 'mymap/musicfile.ogg'.}}
{{Entity_keyvalue|Volume|volume|Set how loud the sound shall be in a range from 0 (not audible) to 10 (normal), but ultimately controlled by the player from the options menu.}}

== Flags ==

{{Entity_flag|1|Start Silent|Music starts once the entity is triggered.}}
{{Entity_flag|2|Loop|Replays the music until toggled off.}}
{{Entity_flag|4|Activator Only|Music can be played for an individual player (activator).}}

{{entity_title}}

[[Category:Entities]]
[[Category:Point entities]]

Ambient music

2025-08-29T19:35:38Z

Outerbeast:

{{Entity_Infobox
| title=
}}

This entity is used to play music within a level. The difference from [[ambient_generic|Ambient Generic]] is the volume being controlled via the CVar 'mp3volume' instead of 'volume'.
Plays everywhere, is not affected by 3D positioning, reverberation, or filters.
Mappers can adjust volume of individual music tracks by "volume" key value, but the final volume is determined on the client-side based on a value of "MP3Volume" CVAR.
Music will play even for players that joined after the entity was triggered. Playback will start with an appropriate offset for them.
Music can be looped.

== Keyvalues ==

{{Entity_keyvalue|Sound File|message|Name of the sound file to play. File Path starts in the 'sound'-folder, example: 'mymap/musicfile.ogg'.}}
{{Entity_keyvalue|Volume|volume|Set how loud the sound shall be in a range from 0 (not audible) to 10 (normal), but ultimately controlled by the player from the options menu.}}

== Flags ==

{{Entity_flag|1|Start Silent|Music starts once the entity is triggered.}}
{{Entity_flag|2|Loop|Replays the music until toggled off.}}
{{Entity_flag|4|Activator Only|Music can be played for an individual player (activator).}}

{{entity_title}}

[[Category:Entities]]
[[Category:Point entities]]

Mapping/Game Triggering System

2025-08-22T17:15:08Z

Outerbeast: /* Special Targetnames */

== Introduction ==
The game engine holds all entities in one chained list. Every entity has an internal unique entity id by which it can be referenced.
For every entity there is, one edict is required. An edict is a sort of entity slot. The default amount of edicts is 885 + (maxplayers* 15) and cannot be changed while a map is running on a server. The number '885' in that formula can be altered by using the command line parameter 'num_edicts #', whereas the hash has to be replaced with a number greater than 885. This is commonly set to <code>8192</code> for Sven Co-op servers. If an entity has to be created, but no free edicts are available, the game will crash with the error <code>ED_Alloc: No free edicts.</code>.
== Triggering ==
Entities can trigger each other with different inputs. The following is a list of these inputs. This guide may refer to these at some points in order to explain things better, so make sure you remember them.
* Activator: The first entity in a trigger chain. E.g.: A player pressing a [[func_button]], which then triggers further entities. Entities which make use of their activator, depending on their configuration, for example, are: [[game_text]], [[env_fade]] or [[game_player_hurt]]. For all entities where a delay between them being triggered and them triggering their target is expected, the activator they pass on to their targets is, by default, replaced by themselves. This is to prevent cases of entities which have already been removed from the game being referenced, resulting in unwanted behavior. An activator can, in some cases, be referenced to using the special string <code>!activator</code>. This does not consistently apply everywhere. See the specific entity entries in this guide for whether a specific entity supports this or not.
* Caller: The previous entity in a trigger chain. E.g.: The aforementioned func_button triggers a [[multi_manager]], hence the multi_manager's caller would be the func_button. A caller can, in some cases, be referenced to using the special string <code>!caller</code>. This does not consistently apply everywhere. See the specific entity entries in this guide for whether a specific entity supports this or not.
* Use-type: Tells the targeted entity what to do. This is not implemented consistently. An entity will only react according to the use-type if the exact behavior for the according use-type case has been explicitly written in the game's source code, which is not the case for every entity and use-type. The following explains all five use-types currently present in the game engine.
** Off: Turn the targeted entity off.
** On: Turn the targeted entity on.
** Set: A specific value of the target entity, if it supports it, is set and the targeted entity may react accordingly.
** Toggle: If the targeted entity is on, turn it off. If the targeted entity is off, turn it on.
** Kill: Remove the targeted entity from the game.

* Value: A real number, which is used for different purposes, depending on triggering and targeted entity. E.g., a [[game_zone_player]], when triggered, will trigger its 'out-counter' (which should be a game_counter entity) with use-type 'Set' and set the transmitted value to the amount of players outside of its collision hull. The [[game_counter]] will recognize the use-type 'Set' and set its current value to the one forwarded by the game_zone_player entity. Furthermore, the game_counter will then check if the new value matches its "Limit value" and trigger its target(s) in case that is true. A completely different usage, however, can, for example, be seen when a func_button triggers an entity. The func_button puts its delay before reset as the value, but does not allow use-type 'Set'. You can see the effect of this when triggering a multisource entity with a func_button. The multisource entity's state will only be 'unlocked' for as long as the func_button's delay before reset has not been reached. This is because the multisource entity knows the exact delay from when it was triggered by the func_button with its delay before reset being set as the transmitted value.

== Wildcards ==
There is possibility to trigger multiple entities with same prefix at once, making it faster to target or killtarget them without using multi_manager or [[Trigger relay|relays]]. Just write an entity name in the target field and add asterisk (*) at the end of string. Any entity that begins with that string will be targeted. Example: func_door target is <code>action_*</code>, so it will fire entities like <code>action_door</code>, <code>action_wall</code>, <code>action_grunts</code> e.t.c. You can do the same with kill-targeting entities.

== Expected Default Behavior ==
Some default behaviour is to be expected from most entities, in which cases this guide will not specifically explain the according keyvalue(s) and/or spawnflag(s). Whenever an entity can have a target, it will usually mean that all entities by the name specified
as the target will be fired. Same goes for kill-target, which will remove all targeted entities from the game. Whenever an entity
allows 'Trigger-state' to be set, this guide should not be expected to explain what that means, as you should already have read about use-types above. This guide, for most of it, only explains things which work different from the normally to-be-expected default behaviour. I am not here to copy and paste the same basic keyvalues a thousand times for every entity, as this guide is written in pure HTML entirely, without any help from programs other than Notepad2. I also do not intend to make this a guide about mapping in general. It is mainly for reference on how specific entities work in Sven Co-op 4.5. Mapping experience withsome GoldSource mod is expected.

== Special Targetnames ==
The game engine knows five special targetnames. Entities which are named with these are triggered with use-type 'Toggle' whenever the according player-event occurs. Activator and caller are set to the player who causes the event.
* <code>game_playerkill</code>: A player kills another player. Activator and caller are set to the player who killed.
* <code>game_playerdie</code>: A player dies. Activator and caller are set to the player who died.
* <code>game_playerrevive</code>: A player is revived. Activator and caller are set to the player who was revived.
* <code>game_playerjoin</code>: A player joins the game. Activator and caller are set to the joining player.
* <code>game_playerleave</code>: A player leaves the game. Activator and caller are set to the leaving player.
* <code>game_playerspawn</code>: A player spawns or respawns. Activator and caller are set to the spawning/respawning player.

On another note, entity names should never start with <code>0</code>.

[[Category:Mapping]]
[[Category:Tutorials]]

Angelscript

2025-08-21T19:47:27Z

Outerbeast: /* Getting Started */

This page contains basic coverage and tutorials for Sven Co-op's Angelscript API.

[https://r4to0.github.io/asautodocs/nd_prerelease/index.html API auto-generated documentation is available here.]
For information on the AngelScript language, visit the [https://www.angelcode.com/angelscript/sdk/docs/manual/doc_script.html official AngelScript manual here]
== Getting Started ==
{| class="wikitable"
|-
! style="text-decoration:underline;" | Tutorials
! style="vertical-align:middle;" | Basics of building scripts
|-
| style="text-decoration:underline; " | [[Running Scripts]]
| style="vertical-align:middle; " | Covers how to import and execute script files, such as map scripts and plugins
|-
| style="text-decoration:underline; " | [[Typecasting]]
| style="vertical-align:middle; " | Covers how and when to use typecasts
|-
| style="text-decoration:underline; " | [[Debugging]]
| style="vertical-align:middle; " | Debugging scripts
|-
| style="text-decoration:underline; " | [[Entity Basics]]
| style="vertical-align:middle; " | Covers the basics of what entities are and how to use them.
|-
| style="text-decoration:underline; " | [[Entity Intermediate]]
| style="vertical-align:middle; " | Covers intermediate topics regarding entities.
|-
| style="text-decoration:underline; " | [[Custom Entities]]
| style="vertical-align:middle; " | Build your own custom entity
|-
| style="text-decoration:underline; " | [https://gist.github.com/anggaranothing/539db1684f33a1c371b5cacdf29af0e4 Class Inheritance Tree]
| style="vertical-align:middle; " | Class hierarchy diagram for CBaseEntity classes exposed to the API
|}

== API Features ==
{| class="wikitable"
|-
! style="text-decoration:underline;" | API Features
! style="vertical-align:middle;" | Covers some fundamental aspects of writing scripts for Sven Co-op
|-
| style="text-decoration:underline; " | [[CEntityFuncs|Entity Functions]]
| style="vertical-align:middle; " | How to use the various entity functions.
|-
| style="text-decoration:underline; " | [[CPlayerFuncs|Player Functions]]
| style="vertical-align:middle; " | Various player related functions
|-
| style="text-decoration:underline; " | [[CSoundEngine|Sound System]]
| style="vertical-align:middle; " | How to use the sound system.
|-
| style="text-decoration:underline; " | [[CEngineFuncs|Engine Functions]]
| style="vertical-align:middle; " | How to use engine functions.
|-
| style="text-decoration:underline; " | [[Mapping/Custom_Keyvalues#Custom_keyvalues_in_Angelscript|Custom Keyvalues]]
| style="vertical-align:middle; " | Covers the usage of custom keyvalues in scripts.
|-
| style="text-decoration:underline; " | [[CEngine]]
| style="vertical-align:middle; " | Covers the CEngine class. This class includes the current time and frametime, as well as engine configuration and the global trace.
|-
| style="text-decoration:underline; " | [[CGame]]
| style="vertical-align:middle; " | Contains methods integral to the game's operation.
|-
| style="text-decoration:underline; " | [[Tracing]]
| style="vertical-align:middle; " | Covers performing traces and usage of the TraceResult class, as well as related enumerations.
|-
| style="text-decoration:underline; " | [[CUtility|Utility Functions]]
| style="vertical-align:middle; " | Covers various utility methods
|-
| style="text-decoration:underline; " | [[Hooks]]
| style="vertical-align:middle; " | Covers the purpose and use of hooks.
|-
| style="text-decoration:underline; " | [[Scheduler]]
| style="vertical-align:middle; " | Covers the use of the scheduler.
|-
| style="text-decoration:underline; " | [[CMath|Math]]
| style="vertical-align:middle; " | Covers the use of various math operations
|-
| style="text-decoration:underline; " | [[HUD]]
| style="vertical-align:middle; " | Covers the usage of various HUD elements
|-
| style="text-decoration:underline; " | [[Temporary Effects]]
| style="vertical-align:middle; " | Covers the use of temporary entities.
|-
| style="text-decoration:underline; " | [[File System]]
| style="vertical-align:middle; " | Covers the use of the virtual file system
|-
| style="text-decoration:underline; " | [[CConCommandSystem| Console Command System]]
| style="vertical-align:middle; " | Covers the console command system. This is used to add console commands and variables.
|-
| style="text-decoration:underline; " | [[Trigger_script#Scripting|trigger_script]]
| style="vertical-align:middle; " | Build a trigger_script entity function
|-
| style="text-decoration:underline; " | [[squadmaker function]]
| style="vertical-align:middle; " | Describes the usage of the squadmaker entity to call script functions.
|-
| style="text-decoration:underline; " | [[ondestroyfn]]
| style="vertical-align:middle; " | Describes the usage of the "ondestroyfn" function
|}

== Data Types ==
{| class="wikitable"
|-
! style="text-decoration:underline;" | Data Types
! style="vertical-align:middle;" | Covers some common data types used in scripts
|-
| style="text-decoration:underline;" | [[Strings]]
| style="vertical-align:middle;" | Covers the basics of strings in scripts
|-
| style="text-decoration:underline;" | [[Vector|Vectors]]
| style="vertical-align:middle;" | Covers the basics of Vectors in scripts
|-
| style="text-decoration:underline;" | [[RGBA]]
| style="vertical-align:middle;" | Covers the basics of the RGBA structure
|-
| style="text-decoration:underline;" | [[EHandle]]
| style="vertical-align:middle;" | Covers the usage of EHandle structure for storing entity handles
|-
| style="text-decoration:underline;" | [[CCVar]]
| style="vertical-align:middle;" | Covers how to create and use custom CVars
|-
|}

== Miscellaneous ==
{| class="wikitable"
|-
! style="text-decoration:underline;" | Page
! style="vertical-align:middle;" | Description
|-
| style="text-decoration:underline;" | [[DateTime]]
| style="vertical-align:middle;" | Covers the basics of the date and time structure
|-
| style="text-decoration:underline;" | [[SayParameters]]
| style="vertical-align:middle;" | Stores data used by the ClientSay [[Hooks|hook]].
|-
| style="text-decoration:underline;" | [[Animation Extensions]]
| style="vertical-align:middle;" | Animation Extensions used by weapons for player models.
|-
| style="text-decoration:underline;" | [[Default Ammo Types]]
| style="vertical-align:middle;" | Default Ammo Types used by the game.
|-
| style="text-decoration:underline;" | [[Bullet]]
| style="vertical-align:middle;" | The Bullet enum contains bullet types used by the game.
|-
| style="text-decoration:underline;" | [[KeyValueBuffer]]
| style="vertical-align:middle;" | Key Value Buffer
|-
|}

[[Category:Scripting]]

Angelscript

2025-08-21T19:43:28Z

Outerbeast: /* Getting Started */

This page contains basic coverage and tutorials for Sven Co-op's Angelscript API.

[https://r4to0.github.io/asautodocs/nd_prerelease/index.html API auto-generated documentation is available here.]
For information on the AngelScript language, visit the [https://www.angelcode.com/angelscript/sdk/docs/manual/doc_script.html official AngelScript manual here]
== Getting Started ==
{| class="wikitable"
|-
! style="text-decoration:underline;" | Tutorials
! style="vertical-align:middle;" | Basics of building scripts
|-
| style="text-decoration:underline; " | [[Running Scripts]]
| style="vertical-align:middle; " | Covers how to import and execute script files, such as map scripts and plugins
|-
| style="text-decoration:underline; " | [[Typecasting]]
| style="vertical-align:middle; " | Covers how and when to use typecasts
|-
| style="text-decoration:underline; " | [[Debugging]]
| style="vertical-align:middle; " | Debugging scripts
|-
| style="text-decoration:underline; " | [[Entity Basics]]
| style="vertical-align:middle; " | Covers the basics of what entities are and how to use them.
|-
| style="text-decoration:underline; " | [[Entity Intermediate]]
| style="vertical-align:middle; " | Covers intermediate topics regarding entities.
|-
| style="text-decoration:underline; " | [[Custom Entities]]
| style="vertical-align:middle; " | Build your own custom entity
|-
| style="text-decoration:underline; " | [[Class Inheritance Tree]]
| style="vertical-align:middle; " | Class hierarchy diagram for CBaseEntity classes exposed to the API
|}

== API Features ==
{| class="wikitable"
|-
! style="text-decoration:underline;" | API Features
! style="vertical-align:middle;" | Covers some fundamental aspects of writing scripts for Sven Co-op
|-
| style="text-decoration:underline; " | [[CEntityFuncs|Entity Functions]]
| style="vertical-align:middle; " | How to use the various entity functions.
|-
| style="text-decoration:underline; " | [[CPlayerFuncs|Player Functions]]
| style="vertical-align:middle; " | Various player related functions
|-
| style="text-decoration:underline; " | [[CSoundEngine|Sound System]]
| style="vertical-align:middle; " | How to use the sound system.
|-
| style="text-decoration:underline; " | [[CEngineFuncs|Engine Functions]]
| style="vertical-align:middle; " | How to use engine functions.
|-
| style="text-decoration:underline; " | [[Mapping/Custom_Keyvalues#Custom_keyvalues_in_Angelscript|Custom Keyvalues]]
| style="vertical-align:middle; " | Covers the usage of custom keyvalues in scripts.
|-
| style="text-decoration:underline; " | [[CEngine]]
| style="vertical-align:middle; " | Covers the CEngine class. This class includes the current time and frametime, as well as engine configuration and the global trace.
|-
| style="text-decoration:underline; " | [[CGame]]
| style="vertical-align:middle; " | Contains methods integral to the game's operation.
|-
| style="text-decoration:underline; " | [[Tracing]]
| style="vertical-align:middle; " | Covers performing traces and usage of the TraceResult class, as well as related enumerations.
|-
| style="text-decoration:underline; " | [[CUtility|Utility Functions]]
| style="vertical-align:middle; " | Covers various utility methods
|-
| style="text-decoration:underline; " | [[Hooks]]
| style="vertical-align:middle; " | Covers the purpose and use of hooks.
|-
| style="text-decoration:underline; " | [[Scheduler]]
| style="vertical-align:middle; " | Covers the use of the scheduler.
|-
| style="text-decoration:underline; " | [[CMath|Math]]
| style="vertical-align:middle; " | Covers the use of various math operations
|-
| style="text-decoration:underline; " | [[HUD]]
| style="vertical-align:middle; " | Covers the usage of various HUD elements
|-
| style="text-decoration:underline; " | [[Temporary Effects]]
| style="vertical-align:middle; " | Covers the use of temporary entities.
|-
| style="text-decoration:underline; " | [[File System]]
| style="vertical-align:middle; " | Covers the use of the virtual file system
|-
| style="text-decoration:underline; " | [[CConCommandSystem| Console Command System]]
| style="vertical-align:middle; " | Covers the console command system. This is used to add console commands and variables.
|-
| style="text-decoration:underline; " | [[Trigger_script#Scripting|trigger_script]]
| style="vertical-align:middle; " | Build a trigger_script entity function
|-
| style="text-decoration:underline; " | [[squadmaker function]]
| style="vertical-align:middle; " | Describes the usage of the squadmaker entity to call script functions.
|-
| style="text-decoration:underline; " | [[ondestroyfn]]
| style="vertical-align:middle; " | Describes the usage of the "ondestroyfn" function
|}

== Data Types ==
{| class="wikitable"
|-
! style="text-decoration:underline;" | Data Types
! style="vertical-align:middle;" | Covers some common data types used in scripts
|-
| style="text-decoration:underline;" | [[Strings]]
| style="vertical-align:middle;" | Covers the basics of strings in scripts
|-
| style="text-decoration:underline;" | [[Vector|Vectors]]
| style="vertical-align:middle;" | Covers the basics of Vectors in scripts
|-
| style="text-decoration:underline;" | [[RGBA]]
| style="vertical-align:middle;" | Covers the basics of the RGBA structure
|-
| style="text-decoration:underline;" | [[EHandle]]
| style="vertical-align:middle;" | Covers the usage of EHandle structure for storing entity handles
|-
| style="text-decoration:underline;" | [[CCVar]]
| style="vertical-align:middle;" | Covers how to create and use custom CVars
|-
|}

== Miscellaneous ==
{| class="wikitable"
|-
! style="text-decoration:underline;" | Page
! style="vertical-align:middle;" | Description
|-
| style="text-decoration:underline;" | [[DateTime]]
| style="vertical-align:middle;" | Covers the basics of the date and time structure
|-
| style="text-decoration:underline;" | [[SayParameters]]
| style="vertical-align:middle;" | Stores data used by the ClientSay [[Hooks|hook]].
|-
| style="text-decoration:underline;" | [[Animation Extensions]]
| style="vertical-align:middle;" | Animation Extensions used by weapons for player models.
|-
| style="text-decoration:underline;" | [[Default Ammo Types]]
| style="vertical-align:middle;" | Default Ammo Types used by the game.
|-
| style="text-decoration:underline;" | [[Bullet]]
| style="vertical-align:middle;" | The Bullet enum contains bullet types used by the game.
|-
| style="text-decoration:underline;" | [[KeyValueBuffer]]
| style="vertical-align:middle;" | Key Value Buffer
|-
|}

[[Category:Scripting]]

Hooks

2025-07-25T19:07:05Z

Outerbeast: /* Monster Hooks */

Hooks are a form of events that scripts can hook into. When you register a hook, the function you’ve registered will be called whenever the associated event occurs.

Multiple scripts can hook into the same hook, and the same script can hook the same hook multiple times. Map scripts will always come first when hooks that both map scripts and plugins can use are executed.

== Hook return code ==

All hooks have to return a code to indicate whether they’ve handled the event or not.

If a hook has handled the event, it should return <code>HOOK_HANDLED</code>. Otherwise, it should return <code>HOOK_CONTINUE</code>.


== Hook definition and usage ==

All hooks are defined in the namespace “Hooks”.

All hooks have funcdefs defined for them that have the syntax <name>Hook, where <name> is the name of the constant without any namespaces prepended. For example, the <code>Hooks::Game::MapChange</code> hook has the funcdef <code>MapChangeHook</code>. This can be used to register object methods as hooks.

You can get an up to date list of hook by typing as_dumphooks <filename> in the console. You must be the server admin to be able to do this. The filename should not have an extension. The file extension is .txt.


=== Registering hooks ===

To register a hook, you must use the g_Hooks global object. This object is defined as follows:

<pre>CModuleHookManager g_Hooks;</pre>
(The actual definition uses a global property accessor, but it behaves like a variable as shown above)

Registering a hook is done as follows:

<pre>HookReturnCode MapChange( const string& in szNextMap )
{
// Handle map change
}

g_Hooks.RegisterHook( Hooks::Game::MapChange, MapChange );</pre>
Removing a hook is done much like registering it:

<pre>g_Hooks.RemoveHook( Hooks::Game::MapChange, MapChange );</pre>

If you are trying to register a method to a hook, you need to pass the method handle in via a delegate, this is done as follows:
<pre>g_Hooks.RegisterHook( Hooks::Game::MapChange, MapChangeHook( obj.MapChange ) )</pre>

It is also possible to remove all of the hook functions registered for a particular hook in the current script by calling RemoveHook with just the hook ID parameter:

<pre>g_Hooks.RemoveHook( Hooks::Game::MapChange );</pre>

=== Stop Modes ===

Hooks can have one of a few stop modes. This mode defines when hook execution should stop.

{| class="wikitable"
|-
! Name
! Action
|-
| <code>ON_HANDLED
| As soon as a hook has returned HOOK_HANDLED, stop execution.
|-
| <code>MODULE_HANDLED
| As soon as a single script has return HOOK_HANDLED from any of its hooks, stop execution.
|-
| <code>CALL_ALL
| Regardless of the return code, execute all hooks.
|}



== Available hooks ==
=== Game Hooks ===
<code>Hooks::Game::</code>
{| class="wikitable"
|- style="font-weight:bold; text-align:center; vertical-align:middle;"
! Constant
! Signature
! style="border-color:inherit;" | Description
! style="border-color:inherit;" | Stop Mode
! style="border-color:inherit;" | Availability
|-
| <code>MapChange</code>
| <code>HookReturnCode Function( const string& in szNextMap )</code>
| When the map changes, this hook is called. Note that this happens when the world is destroyed. There may still be entities that exist at this point. This is caused by engine limitations.
| <code>CALL_ALL</code>
| All
|-
| <code>EntityCreated</code>
| <code>HookReturnCode Function( CBaseEntity@ pEntity )</code>
| Called when a new entity is created. At this point the entity is not spawned yet and may not be fully initialized.
| <code>ON_HANDLED</code>
| All
|}

=== Player Hooks ===
<code>Hooks::Player::</code>
{| class="wikitable"
|- style="font-weight:bold; text-align:center; vertical-align:middle;"
! Constant
! Signature
! style="border-color:inherit;" | Description
! style="border-color:inherit;" | Stop Mode
! style="border-color:inherit;" | Availability
|- style="vertical-align:middle;"
| style="background-color:#F8F9FA; color:#202122;" | <code>CanPlayerUseReservedSlot
| style="background-color:#F8F9FA; color:#202122;" | <code>HookReturnCode Function( edict_t@ pEntity, const string& in szPlayerName, const string& in szIPAddress, bool& out bAllowJoin )
| style="background-color:#F8F9FA; color:#202122; border-color:inherit;" | Called when a player connects to the server, and the number of slots left on the server is <= the number of reserved slots. Set bAllowJoin to true to allow the player to join (default false). Note: At this point in time the player’s CBasePlayer instance does not yet exist. Do not try to use it, as it will not work.
| style="border-color:inherit;" | <code>ON_HANDLED
| style="border-color:inherit;" | Plugins only
|- style="vertical-align:middle;"
| style="background-color:#F8F9FA; color:#202122;" | <code>ClientConnected
| style="background-color:#F8F9FA; color:#202122;" | <code>HookReturnCode Function( edict_t@ pEntity, const string& in szPlayerName, const string& in szIPAddress, bool& out bDisallowJoin, string& out szRejectReason )
| style="background-color:#F8F9FA; color:#202122; border-color:inherit;" | Called when a player connects to the server. if bDisallowJoin is set to false, the player is disconnected. szRejectReason is shown to the player if disconnected. the maximum length of the reject reason string is 127 characters. Note: At this point in time the player’s CBasePlayer instance does not yet exist. Do not try to use it, as it will not work.
| style="border-color:inherit;" | <code>CALL_ALL
| style="border-color:inherit;" | Plugins only
|-
| style="vertical-align:middle; background-color:#F8F9FA; color:#202122;" | <code>ClientPutInServer
| style="background-color:#F8F9FA; color:#202122;" | <code>HookReturnCode Function( CBasePlayer@ pPlayer )
| style="vertical-align:middle; background-color:#F8F9FA; color:#202122; border-color:inherit;" | Called when a player has finished connecting and is put into the world. It is safe to send network messages to the player at this point. The player’s CBasePlayer instance is created right before this hook is executed.
| style="vertical-align:middle; border-color:inherit;" | <code>CALL_ALL
| style="vertical-align:middle; border-color:inherit;" | All
|-
| <code>ClientDisconnect
| <code>HookReturnCode Function( CBasePlayer@ pPlayer )
| style="border-color:inherit;" | Called when a player disconnects. Note that this is only called if the player was fully connected, meaning the player went through ClientPutInServer. This is never called for the local host, since it can’t disconnect before shutting the server itself down.
| style="border-color:inherit;" | <code>CALL_ALL
| style="border-color:inherit;" | All
|-
| <code>ClientSay
| <code>HookReturnCode Function( SayParameters@ pParams )
| style="border-color:inherit;" | Called when a player says something in game chat. The SayParameters class can be used to manipulate input and veto the message.
| style="border-color:inherit;" | <code>ON_HANDLED
| style="border-color:inherit;" | All
|- style="border-color:inherit;"
| <code>GetPlayerSpawnSpot
| <code>HookReturnCode Function( CBasePlayer@ pPlayer, CBaseEntity@& out ppEntSpawnSpot )
| Called when the game is trying to find a spawn spot for a player. To specify a spawn spot (or no spawn spot), set ppEntSpawnSpot to the spot you wish to use, and return HOOK_HANDLED. Setting null will cause the game to spawn the player dead.
|
|
|- style="border-color:inherit;"
| <code>PlayerSpawn
| <code>HookReturnCode Function( CBasePlayer@ pPlayer )
| Called when a player (re)spawns. Player render settings and equipment changes are unavailable at this point.
| <code>CALL_ALL
| All
|- style="border-color:inherit;"
| <code>PlayerCanRespawn
| <code>HookReturnCode Function( CBasePlayer@ pPlayer, bool& out bCanRespawn )
| Called when the game wants to know if the player should be able to respawn or not. Set bCanRespawn to false to disallow, default true.
| <code>ON_HANDLED
| All
|- style="border-color:inherit;"
| <code>PlayerTakeDamage
| <code>HookReturnCode PlayerTakeDamageHook( DamageInfo@ pDamageInfo )
| Called when a player takes damage. Note that the victim entity can’t be changed at this point.
|
| All
|-
| style="border-color:inherit;" | <code>PlayerKilled
| style="border-color:inherit;" | <code>HookReturnCode Function( CBasePlayer@ pPlayer, CBaseEntity@ pAttacker, int iGib )
| Called when a player is killed. pAttacker is the entity responsible for killing the player, and may be null. iGib is one of the GIB enum values, indicating whether or not the player should be gibbed or not.
| style="border-color:inherit;" |
| style="border-color:inherit;" | All
|- style="border-color:inherit;"
| <code>PlayerRevived</code>
| <code>HookReturnCode Function( CBasePlayer@ pPlayer )</code>
| Called when a player is revived. At this point all the revival process is finished.
| style="border-color:inherit;" | <code>CALL_ALL
| style="border-color:inherit;" | All
|-
| <code>PlayerUse
| <code>HookReturnCode Function( CBasePlayer@ pPlayer, uint& out uiFlags )
| Called when the game is processing player button input. Note that this occurs even if the player has not pressed any keys. uiFlags is used to skip player use processing after the hook returns. Setting the flag PlrHook_SkipUse will skip processing.
|
| All
|-
| style="border-color:inherit;" | <code>PlayerPreThink
| style="border-color:inherit;" | <code>HookReturnCode Function( CBasePlayer@ pPlayer, uint& out uiFlags )
| Called when the player is processing pre think events. uiFlags is used to skip pre think processing after the hook returns. Setting the flag PlrHook_SkipVehicles will skip vehicle processing.
| style="border-color:inherit;" |
| style="border-color:inherit;" |
|-
| style="border-color:inherit;" | <code>PlayerPostThink
| style="border-color:inherit;" | <code>HookReturnCode Function( CBasePlayer@ pPlayer )
| Called when the player is processing post think events.
| style="border-color:inherit;" |
| style="border-color:inherit;" |
|-
| <code>PlayerPreDecal
| <code>HookReturnCode Function( CBasePlayer@, const TraceResult& in, bool& out bResult)
| Called when a player attempts to spraypaint a decal onto a surface. The given trace result contains the surface information. Set bResult to false if the player shouldn’t be able to spray.
| style="border-color:inherit;" |
| style="border-color:inherit;" |
|-
| <code>PlayerDecal
| <code>HookReturnCode Function( CBasePlayer@ pPlayer, const TraceResult& in trace )
| Called when a player is spraypainting a decal onto a surface. The given trace result contains the surface information.
| style="border-color:inherit;" |
| style="border-color:inherit;" |
|-
| <code>PlayerEnteredObserver
| <code>HookReturnCode Function( CBasePlayer@ pPlayer )
| Called when a player enters observer mode.
| style="border-color:inherit;" |
| style="border-color:inherit;" |
|-
| <code>PlayerLeftObserver
| <code>HookReturnCode Function( CBasePlayer@ pPlayer )
| Called when a player leaves observer mode.
| style="border-color:inherit;" |
| style="border-color:inherit;" |
|}

=== Monster Hooks ===
<code>Hooks::Monster::</code>

'''Note:''' Players are technically CBaseMonster instances, so player TakeDamage and Killed events will also be hooked. Ensure the function code accommodates for this.
{| class="wikitable"
|-
! Constant
! Signature
! Description
! Stop Mode
! Availability
|-
| <code>MonsterKilledHook
| <code>HookReturnCode Function( CBaseMonster@ pMonster, CBaseEntity@ pAttacker, int iGib )
| Called when a monster is killed (This hook isn’t called for grenade entities/monster_sentry/monster_barnacle). This hook may have spam issues.
| <code>ON_HANDLED
| All
|-
| <code>MonsterTakeDamage
| <code>HookReturnCode Function( DamageInfo@ pDamageInfo )
| Called when a monster takes damage.
| <code>ON_HANDLED
| All
|}

=== Weapon Hooks ===
<code>Hooks::Weapon::</code>
{| class="wikitable"
|-
! Constant
! Signature
! Description
! Stop Mode
! Availability
|-
| <code>WeaponPrimaryAttack
| <code>HookReturnCode Function( CBasePlayer@ pPlayer, CBasePlayerWeapon@ pWeapon )
| Called when a player fires a weapon's primary attack.
| <code>ON_HANDLED
| All
|-
| <code>WeaponSecondaryAttack
| <code>HookReturnCode Function( CBasePlayer@ pPlayer, CBasePlayerWeapon@ pWeapon )
| Called when a player fires a weapon's secondary attack.
| <code>ON_HANDLED
| All
|-
| <code>WeaponTertiaryAttack
| <code>HookReturnCode Function( CBasePlayer@ pPlayer, CBasePlayerWeapon@ pWeapon )
| Called when a player fires a weapon's tertiary attack.
| <code>ON_HANDLED
| All
|-
| <code>WeaponReload
| <code>HookReturnCode Function( CBasePlayer@ pPlayer, CBasePlayerWeapon@ pWeapon )
| Called a player reloads a weapon (or calls BaseClass::Reload()).
| <code>CALL_ALL
| All
|}

=== Pickup Hooks ===
<code>Hooks::PickupObject::</code>
{| class="wikitable"
|-
! Constant
! Signature
! Description
! Stop Mode
! Availability
|- style="border-color:inherit;"
| <code>Materialize
| <code>HookReturnCode Function( CBaseEntity@ pPickup )
| Called when a pickup object materializes.
| <code>CALL_ALL
| All
|-
| style="border-color:inherit;" | <code>CanCollect
| style="border-color:inherit;" | <code>HookReturnCode Function( CBaseEntity@ pPickup, CBaseEntity@ pOther, bool& out bResult )
| style="border-color:inherit;" | Called when a pickup object is about to be collected by a player. Note that basic checks are done before this hook is called. Set bResult to false if the player shouldn’t be able to pick up the object.
| <code>ON_HANDLED
| style="border-color:inherit;" | All
|- style="border-color:inherit;"
| <code>Collected
| <code>HookReturnCode Function( CBaseEntity@ pPickup, CBaseEntity@ pOther )
| Called when a pickup object is collected by a player.
| <code>CALL_ALL
| All
|}

[[Category:Scripting]]

TE FIREFIELD

2025-07-23T14:16:51Z

Outerbeast:

[[File:TE FIREFIELD.gif|frame|TE_FIREFIELD]]
Spawns randomly positioned sprites in a cube or on a square plane.
<pre>
void te_firefield(Vector pos, uint16 radius=128,
string sprite="sprites/grenade.spr", uint8 count=128,
uint8 flags=30, uint8 life=5,
NetworkMessageDest msgType=MSG_BROADCAST, edict_t@ dest=null)
{
NetworkMessage m(msgType, NetworkMessages::SVC_TEMPENTITY, dest);
m.WriteByte(TE_FIREFIELD);
m.WriteCoord(pos.x);
m.WriteCoord(pos.y);
m.WriteCoord(pos.z);
m.WriteShort(radius);
m.WriteShort(g_EngineFuncs.ModelIndex(sprite));
m.WriteByte(count);
m.WriteByte(flags);
m.WriteByte(life);
m.End();
}</pre>

* <code>Vector pos</code> Center point of the effect
* <code>uint16 radius</code> Size of the cube or square (distance from center point to a side)
* <code>string sprite</code> Sprite to display (alpha transparency)
* <code>uint8 count</code> Number of sprites to spawn
* <code>uint8 flags</code> Combinable options:
1 : All sprites will drift upwards
 
2 : 50% of the sprites will drift upwards
 
4 : Loop sprites at 15fps instead of playing one cycle stretched to fit the "life" time
 
8 : Display sprites at 50% opacity
 
16 : Spawn sprites on a flat plane instead of in cube
 
* <code>uint8 life</code> Time to display sprites (seconds * 0.1 +/- some random amount)
[[Category:Scripting]]

TE FIREFIELD

2025-07-22T18:42:49Z

Outerbeast: Created page with "TE_FIREFIELD Spawns randomly positioned sprites in a cube or on a square plane. <pre> void te_firefield(Vector pos, uint16 radius=128, string..."

[[File:TE FIREFIELD.gif|frame|TE_FIREFIELD]]
Spawns randomly positioned sprites in a cube or on a square plane.
<pre>
void te_firefield(Vector pos, uint16 radius=128,
string sprite="sprites/grenade.spr", uint8 count=128,
uint8 flags=30, uint8 life=5,
NetworkMessageDest msgType=MSG_BROADCAST, edict_t@ dest=null)
{
NetworkMessage m(msgType, NetworkMessages::SVC_TEMPENTITY, dest);
m.WriteByte(TE_FIREFIELD);
m.WriteCoord(pos.x);
m.WriteCoord(pos.y);
m.WriteCoord(pos.z);
m.WriteShort(radius);
m.WriteShort(g_EngineFuncs.ModelIndex(sprite));
m.WriteByte(count);
m.WriteByte(flags);
m.WriteByte(life);
m.End();
}</pre>

* <code>Vector pos</code> Center point of the effect
* <code>uint16 radius</code> Size of the cube or square (distance from center point to a side)
* <code>string sprite</code> Sprite to display (alpha transparency)
* <code>uint8 count</code> Number of sprites to spawn
* <code>uint8 flags</code> Combinable options:
1 : All sprites will drift upwards
2 : 50% of the sprites will drift upwards
4 : Loop sprites at 15fps instead of playing one cycle stretched to fit the "life" time
8 : Display sprites at 50% opacity
16 : Spawn sprites on a flat plane instead of in cube
* <code>uint8 life</code> Time to display sprites (seconds * 0.1 +/- some random amount)
[[Category:Scripting]]

Trigger createentity

2025-07-13T15:53:40Z

Outerbeast: activator/caller is supported

{{Entity_Infobox
| title=
}}

This entity allows you to create any entity at runtime as you trigger it. Set the desired classname and new targetname, if wanted, then disable Valve Hammer Editor's smart edit-mode to set keyvalues to initialize the to-be-spawned entity with. For key, write a minus ('-') followed by the key you want to set, and as value, set the value you want that key to be set to. Alternatively, you can copy a keyvalue from another entity. To do this, prepend a plus ('+') instead of a minus and write the name of the entity to copy from as the value instead of the value itself. You cannot copy from entity-specific keyvalues, as these cannot be read from the outside. Examples: Key "-health" with value "50.0" to set the health-keyvalue to a value of 50.0. Key "-message" with value "Hello world!" to set the message-keyvalue to "Hello world!". Key "+model" with value "crate_6" to copy the model-keyvalue of the entity by the targetname "crate_6" to the model-keyvalue of the spawned entity. The name can also be the special targetnames <code>!activator</code>/<code>!caller</code> so that the keyvalue can be received from this trigger_createentity's activator/caller entity.

== Keyvalues ==

{{Entity_keyvalue|Child Classname|m_iszCrtEntChildClass|Name of an entity-class to determine what type of entity to spawn. This is required.}}
{{Entity_keyvalue|Child Targetname|m_iszCrtEntChildName|New targetname to set on the spawned entity. This is optional. You can also copy the targetname of another entity using the method explained above and leave this empty instead.}}
{{Entity_keyvalue|Trigger after spawn|m_iszTriggerAfter|Target to trigger after spawning the new entity. This will not be triggered if spawning failed for some reason.}}

== Notes ==

Spawnflags actually are a keyvalue called spawnflags, so you will have to use that instead of setting spawnflags on the trigger_createentity itself. Value of 1 means 1st checkbox is checked; value of 2 means 2nd checkbox is checked; value of 4 means 3rd checkbox is checked; value of 8 means 4th checkbox is checked. As you can see, the value doubles with every further checkbox. To combine spawnflags, add up the values. For example, a value of 5 would mean that the 1st and 3rd checkbox are checked, because it combines only of 1 (1st checkbox) plus 4 (3rd checkbox).If you try to create a brush-entity, make sure you have another brush-entity to copy its model from. Also make sure that that entity has an origin-brush tied to it then, or your new entity will be spawned with an offset from the center of the coordinate system to the entity which's model you copy.If you try to copy the model-keyvalue from another entity, but the other entity is not found, the trigger_createentity will refuse to spawn the entity, because spawning a brush-entity with an empty model is prone to crashing the game.Note that the call to finally spawn the created entity is done after all keyvalues have been set, as normally is the case in the game engine. Should the keyvalues you have set require for unprecached model-files to be precached, the game will shut down. This can, for example, happen when you spawn a func_breakable with a material which requires metal-gibs to be precached, but have not otherwise been detected to be required in the map. In that case you'd have to precache them with a custom_precache entity, or make sure you'd have at least one func_breakable which had material-type "metal".

{{entity_title}}

[[Category:Entities]]
[[Category:Point entities]]

TE GUNSHOT

2025-07-07T18:22:45Z

Outerbeast: Created page with "TE_GUNSHOT Small group of gray dots with a ricochet sound. <code>Vector pos</code> is the center point for the effect. <pre> void te_gunshot(Vect..."

[[File:TE GUNSHOT.gif|frame|TE_GUNSHOT]]
Small group of gray dots with a ricochet sound.
<code>Vector pos</code> is the center point for the effect.
<pre>
void te_gunshot(Vector pos,
NetworkMessageDest msgType=MSG_BROADCAST, edict_t@ dest=null)
{
NetworkMessage m(msgType, NetworkMessages::SVC_TEMPENTITY, dest);
m.WriteByte(TE_GUNSHOT);
m.WriteCoord(pos.x);
m.WriteCoord(pos.y);
m.WriteCoord(pos.z);
m.End();
}
</pre>
[[Category:Scripting]]

TE LINE

2025-07-07T18:15:36Z

Outerbeast:

[[File:TE LINE.gif|frame|TE_LINE]]
Draws a dotted line between two points. Colors with green in them don't seem to work very well.
<pre>
void te_line(Vector start, Vector end, uint16 life=32, RGBA c=RGBA_PURPLE,
NetworkMessageDest msgType=MSG_BROADCAST, edict_t@ dest=null)
{
NetworkMessage m(msgType, NetworkMessages::SVC_TEMPENTITY, dest);
m.WriteByte(TE_LINE);
m.WriteCoord(start.x);
m.WriteCoord(start.y);
m.WriteCoord(start.z);
m.WriteCoord(end.x);
m.WriteCoord(end.y);
m.WriteCoord(end.z);
m.WriteShort(life);
m.WriteByte(c.r);
m.WriteByte(c.g);
m.WriteByte(c.b);
m.End();
}</pre>

* Vector start Starting point for the line
* Vector end End point for the line
* uint16 life Time to display the line (seconds * 0.1)
* RGBA c Line color
[[Category:Scripting]]

TE LINE

2025-07-07T18:15:21Z

Outerbeast: Created page with "TE_LINE Draws a dotted line between two points. Colors with green in them don't seem to work very well. <pre> void te_line(Vector start, Vector end,..."

[[File:TE LINE.gif|frame|TE_LINE]]
Draws a dotted line between two points. Colors with green in them don't seem to work very well.
<pre>
void te_line(Vector start, Vector end, uint16 life=32, RGBA c=RGBA_PURPLE,
NetworkMessageDest msgType=MSG_BROADCAST, edict_t@ dest=null)
{
NetworkMessage m(msgType, NetworkMessages::SVC_TEMPENTITY, dest);
m.WriteByte(TE_LINE);
m.WriteCoord(start.x);
m.WriteCoord(start.y);
m.WriteCoord(start.z);
m.WriteCoord(end.x);
m.WriteCoord(end.y);
m.WriteCoord(end.z);
m.WriteShort(life);
m.WriteByte(c.r);
m.WriteByte(c.g);
m.WriteByte(c.b);
m.End();
}</pre>

Vector start Starting point for the line
Vector end End point for the line
uint16 life Time to display the line (seconds * 0.1)
RGBA c Line color
[[Category:Scripting]]

TE SHOWLINE

2025-07-07T18:09:50Z

Outerbeast: Created page with "TE_SHOWLINE Draws a red dotted line between two points that disappears after 30 seconds. Uses fewer dots than TE_LINE. <pre> void te_showlin..."

[[File:TE SHOWLINE.gif|frame|TE_SHOWLINE]]
Draws a red dotted line between two points that disappears after 30 seconds. Uses fewer dots than [[TE_LINE]].
<pre>
void te_showline(Vector start, Vector end, Color c=PURPLE,
NetworkMessageDest msgType=MSG_BROADCAST, edict_t@ dest=null)
{
NetworkMessage m(msgType, NetworkMessages::SVC_TEMPENTITY, dest);
m.WriteByte(TE_SHOWLINE);
m.WriteCoord(start.x);
m.WriteCoord(start.y);
m.WriteCoord(start.z);
m.WriteCoord(end.x);
m.WriteCoord(end.y);
m.WriteCoord(end.z);
m.End();
}</pre>
* Vector start Starting point for the line
* Vector end End point for the line
[[Category:Scripting]]

TE BOX

2025-07-07T18:08:01Z

Outerbeast: Created page with "TE_BOX Draws an axis-aligned box made up of dotted lines. <pre> void te_box(Vector mins, Vector maxs, uint16 life=16, RGBA c=RGBA_PURPLE, NetworkMes..."

[[File:TE BOX.gif|frame|TE_BOX]]
Draws an axis-aligned box made up of dotted lines.
<pre>
void te_box(Vector mins, Vector maxs, uint16 life=16, RGBA c=RGBA_PURPLE,
NetworkMessageDest msgType=MSG_BROADCAST, edict_t@ dest=null)
{
NetworkMessage m(msgType, NetworkMessages::SVC_TEMPENTITY, dest);
m.WriteByte(TE_BOX);
m.WriteCoord(mins.x);
m.WriteCoord(mins.y);
m.WriteCoord(mins.z);
m.WriteCoord(maxs.x);
m.WriteCoord(maxs.y);
m.WriteCoord(maxs.z);
m.WriteShort(life);
m.WriteByte(c.r);
m.WriteByte(c.g);
m.WriteByte(c.b);
m.End();
}</pre>

* Vector mins Bottom-left-back corner of the box
* Vector maxs Top-right-front corner of the box
* uint16 life Time to display the box (seconds * 0.1)
* RGBA c Line color
[[Category:Scripting]]

TE DLIGHT

2025-07-07T18:05:11Z

Outerbeast:

[[File:TE DLIGHT.gif|frame|TE_DLIGHT]]
A spherical dynamic light that fades over time.
<pre>
void te_dlight(Vector pos, uint8 radius=32, Color c=PURPLE,
uint8 life=255, uint8 decayRate=50,
NetworkMessageDest msgType=MSG_BROADCAST, edict_t@ dest=null)
{
NetworkMessage m(msgType, NetworkMessages::SVC_TEMPENTITY, dest);
m.WriteByte(TE_DLIGHT);
m.WriteCoord(pos.x);
m.WriteCoord(pos.y);
m.WriteCoord(pos.z);
m.WriteByte(radius);
m.WriteByte(c.r);
m.WriteByte(c.g);
m.WriteByte(c.b);
m.WriteByte(life);
m.WriteByte(decayRate);
m.End();
}
</pre>

* <code>Vector pos</code> Center point for the effect
* <code>float radius</code> Radius of the light sphere
* <code>RGBA c</code> Light color
* <code>uint8 life</code> Time to display the light (seconds * 0.1)
* <code>uint8 decayRate</code> Light fade speed
[[Category:Scripting]]

TE ELIGHT

2025-07-07T18:03:53Z

Outerbeast: Created page with "TE_ELIGHT A spherical dynamic light that fades over time and only affects point entities. This appears to be the same effect used with the EF_MUZZ..."

[[File:TE ELIGHT.gif|frame|TE_ELIGHT]]
A spherical dynamic light that fades over time and only affects point entities. This appears to be the same effect used with the EF_MUZZLEFLASH effect (seen with the gauss gun primary fire).
<pre>
void te_elight(CBaseEntity@ target, Vector pos, float radius=1024.0f,
RGBA c=PURPLE, uint8 life=16, float decayRate=2000.0f,
NetworkMessageDest msgType=MSG_BROADCAST, edict_t@ dest=null)
{
NetworkMessage m(msgType, NetworkMessages::SVC_TEMPENTITY, dest);
m.WriteByte(TE_ELIGHT);
m.WriteShort(target.entindex());
m.WriteCoord(pos.x);
m.WriteCoord(pos.y);
m.WriteCoord(pos.z);
m.WriteCoord(radius);
m.WriteByte(c.r);
m.WriteByte(c.g);
m.WriteByte(c.b);
m.WriteByte(life);
m.WriteCoord(decayRate);
m.End();
}</pre>
* Vector pos Center point for the effect
* float radius Radius of the light sphere
* RGBA c Light color
* uint8 life Time to display the light (seconds * 0.1)
* uint8 decayRate Light fade speed
[[Category:Scripting]]

TE DLIGHT

2025-07-07T18:02:06Z

Outerbeast:

[[File:TE DLIGHT.gif|frame|TE_DLIGHT]]
A spherical dynamic light that fades over time and only affects point entities. This appears to be the same effect used with the EF_MUZZLEFLASH effect (seen with the gauss gun primary fire).
<pre>
void te_dlight(Vector pos, uint8 radius=32, RGBA c=RGBA_PURPLE,
uint8 life=255, uint8 decayRate=50,
NetworkMessageDest msgType=MSG_BROADCAST, edict_t@ dest=null)
{
NetworkMessage m(msgType, NetworkMessages::SVC_TEMPENTITY, dest);
m.WriteByte(TE_DLIGHT);
m.WriteCoord(pos.x);
m.WriteCoord(pos.y);
m.WriteCoord(pos.z);
m.WriteByte(radius);
m.WriteByte(c.r);
m.WriteByte(c.g);
m.WriteByte(c.b);
m.WriteByte(life);
m.WriteByte(decayRate);
m.End();
}
</pre>

* <code>Vector pos</code> Center point for the effect
* <code>float radius</code> Radius of the light sphere
* <code>RGBA c</code> Light color
* <code>uint8 life</code> Time to display the light (seconds * 0.1)
* <code>uint8 decayRate</code> Light fade speed
[[Category:Scripting]]

TE DLIGHT

2025-07-07T18:01:09Z

Outerbeast:

TE DLIGHT

2025-07-07T18:01:02Z

Outerbeast: Created page with "TE_DLIGHT A spherical dynamic light that fades over time and only affects point entities. This appears to be the same effect used with the EF_MUZZ..."

[[File:TE DLIGHT.gif|frame|TE_DLIGHT]]
A spherical dynamic light that fades over time and only affects point entities. This appears to be the same effect used with the EF_MUZZLEFLASH effect (seen with the gauss gun primary fire).
<pre>
void te_dlight(Vector pos, uint8 radius=32, RGBA c=RGBA_PURPLE,
uint8 life=255, uint8 decayRate=50,
NetworkMessageDest msgType=MSG_BROADCAST, edict_t@ dest=null)
{
NetworkMessage m(msgType, NetworkMessages::SVC_TEMPENTITY, dest);
m.WriteByte(TE_DLIGHT);
m.WriteCoord(pos.x);
m.WriteCoord(pos.y);
m.WriteCoord(pos.z);
m.WriteByte(radius);
m.WriteByte(c.r);
m.WriteByte(c.g);
m.WriteByte(c.b);
m.WriteByte(life);
m.WriteByte(decayRate);
m.End();
}
<pre>

* <code>Vector pos</code> Center point for the effect
* <code>float radius</code> Radius of the light sphere
* <code>RGBA c</code> Light color
* <code>uint8 life</code> Time to display the light (seconds * 0.1)
* <code>uint8 decayRate</code> Light fade speed

Mapping/Sven Co-op FGD

2025-07-07T13:09:42Z

Outerbeast:

<pre>
//
// Sven Co-op game definition file (*.FGD)
//
// Based on the Half-Life definition file "version 3.0.0.1" by Chris "Autolycus" Bokitch.
// Updated by Sniper and Protector to include the Sven Co-op 4.5 Entities.
// VHE 3.5b-ready by Puchi, JPolito, and AdamR. (Model support)
// Tidied up by AdamR because you all suck hard at white spacing.
// Guidelines below added by Silencer so this file stops becoming a mess.
// Sorted by Puchi and Silencer. Proper filter options added by Puchi.

//
// - FGD EDITING GUIDELINES - KEEP THIS FILE CLEAN -
//
//
//
// � Get unity into it. (Commenting, line breaks, use of BaseClasses)
//
// � Cut explanations of entities, keys and values out of the file and store them elsewhere for
// reference.
//
// � When adding a necessary comment on some part in the file, isolate that part from everything
// else with a blank line above and below of it, and add the comment in a new line directly
// above the part you are commenting on. If the line is getting too long, (>100 chars) add a new
// line to continue.
//
// � One space (' ') directly after every "//". An exception is when you comment actual entity
// keys, predefined values (drop-down list) or spawnflags out.
//
// � Indent comments.
//
// � Indent with single tabs only. NO SPACES!
// E.g. under Notepad 2: Go to Settings -> Tab Settings -> Uncheck "Insert tabs as spaces".
//
// � No unnecessary spaces. Sometimes there are two or more spaces between words or at the end of
// lines to have a comment added, which looks ugly.
//
// � Sort ALL entries by name, and KEEP THEM SORTED.
//
//
// � Allow for custom models/sprites to be displayed by entities specifically made for doing so.
// (cycler/cycler_sprite/env_sprite/item_generic)
//
// � Make sure all entities are properly sized. Some used to have unreasonably sized hulls. E.g.
// info_teleport_destination used to be a (-8 -8 0 8 8 16)-hullsized 16� cube, not really
// revealing any information about the output-height of the teleported player/monster/object.
//
// � Give different entities colors! Anything that helps to differentiate between those vast amount
// of purple blocks is welcome!
//
// � Make use of the iconsprite(sprite[]) parameter! We could have awesome sprites for many of the
// point entities, which also helps differentiating. Having varying sizes and colors on top of
// that also helps differentiating in the 2D views.
//

//
// All entities must have this baseclass
//
@BaseClass = Mandatory
[
ondestroyfn(string) : "OnDestroy Function"
]

//
// worldspawn
//

@SolidClass base(Mandatory) = worldspawn : "World entity"
[
message(string) : "Map description / title"
skyname(string) : "Environment map (cl_skyname)"
sounds(integer) : "CD track to play" : 1
light(integer) : "Default light level"
WaveHeight(string) : "Default wave height"
MaxRange(string) : "Max viewable distance" : "32768"
chaptertitle(string) : "Chapter title message"
startdark(choices) : "Level fade in" : 0 =
[
0 : "No"
1 : "Yes"
]
gametitle(choices) : "Display game title" : 0 =
[
0 : "No"
1 : "Yes"
]
newunit(choices) : "New level unit" : 1 =
[
0 : "No, keep current"
1 : "Yes, clear previous levels"
]
mapteams(string) : "Map team List"
defaultteam(choices) : "Default team" : 0 =
[
0 : "Fewest Players"
1 : "First Team"
]
freeroam(choices) : "Roaming monsters (node graph)" : 0 =
[
0 : "No"
1 : "Yes"
]
sentence_file(string) : "Custom Sentences File"
materials_file(string) : "Custom Materials File"
globalsoundlist(string) : "Global Sound Replacement File"
globalmodellist(string) : "Global Model Replacement File"
forcepmodels(string) : "Force Player Models a;b;c etc"

// If enabled, the map will use the player class settings file. "mapname_class.cfg"
//enableclasses(choices) : "Enable Player Classes" : 0 =
//[
// 0 : "No"
// 1 : "Yes"
//]

scversion2(choices) : "Minimum game version" : 526 =
[
526 : "5.26 Patch"
525 : "5.25 Patch"
524 : "5.24 Patch"
523 : "5.23 Patch"
522 : "5.22 Patch"
521 : "5.21 Patch"
520 : "5.20 Patch"
519 : "5.19 Patch"
518 : "5.18 Patch"
517 : "5.17 Patch"
516 : "5.16 Patch"
515 : "5.15 Patch"
514 : "5.14 Patch"
513 : "5.13 Patch"
512 : "5.12 Patch"
511 : "5.11 Patch"
510 : "5.10 Patch"
509 : "5.09 Patch"
508 : "5.08 Patch"
507 : "5.07 Patch"
506 : "5.06 Patch"
505 : "5.05 Patch"
504 : "5.04 Patch"
503 : "5.03 Patch"
502 : "5.02 Patch"
501 : "5.01 Patch"
500 : "5.0 Milestone"
480 : "4.8 Update"
470 : "4.7 Update"
460 : "4.6 Update"
450 : "4.5 Update"
407 : "4.07 Hotfix"
406 : "4.06 Hotfix"
405 : "4.05 Hotfix"
401 : "4.0b1 Milestone"
400 : "4.0 Internal"
300 : "3.0 (or earlier)"
]
]

@BaseClass = FilterIn
[
tinfilter(string) : "Name In Filter"
tinfiltertype(choices) : "Name In Filter Type" : 0 =
[
0: "Exclude"
1: "Include"
]

cinfilter(string) : "Class In Filter"
cinfiltertype(choices) : "Class In Filter Type" : 0 =
[
0: "Exclude"
1: "Include"
]
]

@BaseClass = FilterOut
[
toutfilter(string) : "Name Out Filter"
toutfiltertype(choices) : "Name Out Filter Type" : 0 =
[
0: "Exclude"
1: "Include"
]

coutfilter(string) : "Class Out Filter"
coutfiltertype(choices) : "Class Out Filter Type" : 0 =
[
0: "Exclude"
1: "Include"
]
]

@BaseClass = ZHLTbmodel
[
zhlt_usemodel(string) : "ZHLT Template Model Target"
zhlt_copylight(string) : "ZHLT Copy Lighting From Target"
zhlt_noclip(choices) : "ZHLT Disable Clipping" : 0 =
[
0 : "Default"
1 : "Always non-solid"
]
zhlt_invisible(choices) : "ZHLT Invisible" : 0 =
[
0 : "Visible (default)"
1 : "Invisible"
]
zhlt_customshadow(string) : "ZHLT Custom Shadow (when opaque)"
zhlt_embedlightmap(choices) : "ZHLT Embed Light Map (when translucent)" : 0 =
[
0 : "No (default)"
1 : "Yes"
]
zhlt_embedlightmapresolution(integer) : "ZHLT Embed Light Map Resolution" : 4
]

@BaseClass base(ZHLTbmodel) = ZHLT
[
zhlt_lightflags(choices) : "ZHLT Light Flags" : 0 =
[
0 : "Default"
1 : "Embedded Fix"
2 : "Opaque (blocks light)"
3 : "Opaque + Embedded fix"
6 : "Opaque + Concave Fix"
]
light_origin(string) : "ZHLT Light Origin Target"
]

@BaseClass = ZHLTpoint
[
_fade(string) : "ZHLT Light Fade" : "1.0"
_falloff(choices) : "ZHLT Light Falloff" : 0 =
[
0 : "Default"
1 : "Inverse Linear"
2 : "Inverse Square"
]
]

@BaseClass = Appearflags
[
spawnflags(Flags) =
[
2048 : "Not in Deathmatch" : 0
]
]

@BaseClass = AttackObject
[
classify(choices) : "Classification" : 0 =
[
-1 : "None"
0 : "Object Default"
1 : "Machine"
2 : "Player"
3 : "Human Passive"
4 : "Human Military"
5 : "Alien Military"
6 : "Alien Passive"
7 : "Alien Monster"
8 : "Alien Prey"
9 : "Alien Predator"
10 : "Insect"
11 : "Player Ally"
12 : "Player Hornet/Snark"
13 : "Alien Hornet/Snark"
14 : "X-Race"
15 : "X-Race: Shocktrooper/Voltigore"
16 : "Team 1"
17 : "Team 2"
18 : "Team 3"
19 : "Team 4"
]
]

@BaseClass = Angles
[
angles(string) : "Pitch Yaw Roll (X Y Z)" : "0 0 0"
]

@BaseClass base(Mandatory) = Targetname
[
targetname(target_source) : "Name"
]

@BaseClass = Target
[
target(target_destination) : "Target"
]

@BaseClass size(0 0 0, 32 32 32) color(80 0 200) base(Targetname, Appearflags, Angles) = Pickup
[
spawnflags(Flags) =
[
128 : "TOUCH Only" : 0
256 : "USE Only" : 0
512 : "Can Use w/o LoS" : 0
1024: "Disable Respawn" : 0
]
renderfx(choices) : "Render FX" : 0 =
[
0: "Normal"
1: "Slow Pulse"
2: "Fast Pulse"
3: "Slow Wide Pulse"
4: "Fast Wide Pulse"
9: "Slow Strobe"
10: "Fast Strobe"
11: "Faster Strobe"
12: "Slow Flicker"
13: "Fast Flicker"
5: "Slow Fade Away"
6: "Fast Fade Away"
7: "Slow Become Solid"
8: "Fast Become Solid"
14: "Constant Glow"
15: "Distort"
16: "Hologram (Distort + fade)"
19: "Glow Shell"
]
rendermode(choices) : "Render Mode" : 0 =
[
0: "Normal"
1: "Color"
2: "Texture"
3: "Glow"
4: "Solid"
5: "Additive"
]
renderamt(integer) : "FX Amount (1 - 255)"
rendercolor(color255) : "FX Color (R G B)" : "0 0 0"
movetype(choices) : "Gravity Setting" : 0 =
[
-1: "Unmoveable"
0: "Fall to the ground (default)"
5: "Hover in the air"
8: "Hover in the air, ignore brush collision"
]
]

@BaseClass = ExclusiveHold
[
exclusivehold(choices) : "Exclusive Hold" : 0 =
[
0 : "No"
1 : "Yes"
]
]

@BaseClass = CustomRespawnDelay
[
m_flCustomRespawnTime(string) : "Custom respawn time"
]

@BaseClass size(-16 -16 0, 16 16 32) color(2 64 240) base(Pickup, CustomRespawnDelay) = Weapon
[
dmg(integer) : "Custom Damage" : 0

wpn_v_model(studio) : "Custom V_Model" : ""
wpn_w_model(studio) : "Custom W_Model" : ""
wpn_p_model(studio) : "Custom P_Model" : ""

soundlist(string) : "Sound Replacement File"

CustomSpriteDir(string) : "Custom sprite directory"

IsNotAmmoItem(choices) : "Is Ammo Item" : 0 =
[
0 : "Yes"
1 : "No"
]
]

@BaseClass size(-8 -8 0, 8 8 16) color(4 128 240) base(Pickup, CustomRespawnDelay) = Ammo
[
model(studio) : "Custom Model" : ""
]

@BaseClass size(-8 -8 0, 8 8 16) color(0 0 200) base(Pickup, CustomRespawnDelay) = Item
[
model(studio) : "Custom Model" : ""
skin(integer) : "Skin" : 0
body(integer) : "Body" : 0
sequencename(string) : "Sequence Name" : "idle"
sequence(integer) : "Sequence Number (overrides name)" : 0
scale(string) : "Scale Model" : "1"

minhullsize(string) : "Custom Min Hull Size (X Y Z)" : "0 0 0"
maxhullsize(string) : "Custom Max Hull Size (X Y Z)" : "0 0 0"

soundlist(string) : "Sound Replacement File"
]

@BaseClass size(-8 -8 0, 8 8 16) color(0 0 200) base(Pickup) = ItemWithDefaultModel
[
solid(choices) : "Solid Setting" : 0 =
[
-1: "Hollow"
0: "Touch on edge, non-blocking (default)"
2: "Touch on edge, blocking (requires hull sizes!)"
]
model(studio) : "Custom Model" : "models/egg.mdl"
skin(integer) : "Skin" : 0
body(integer) : "Body" : 0
sequencename(string) : "Sequence Name" : "idle"
sequence(integer) : "Sequence Number (overrides name)" : 0
scale(string) : "Scale Model" : "1"

minhullsize(string) : "Custom Min Hull Size (X Y Z)" : "0 0 0"
maxhullsize(string) : "Custom Max Hull Size (X Y Z)" : "0 0 0"

soundlist(string) : "Sound Replacement File"
]

@BaseClass = Global
[
globalname(string) : "Global Entity Name"
]

@BaseClass base(Target) = Targetx
[
delay(string) : "Delay Before Trigger" : "0"
killtarget(target_destination) : "Kill Target"
]

@BaseClass = InventoryRules
[
item_name_required(string) : "Inventory: Need item(s)" : ""
item_group_required(string) : "Inventory: Need item(s) from group(s)" : ""
item_group_required_num(integer) : "Inventory: Item count in group need have (0 = all)" : 0
item_name_canthave(string) : "Inventory: CAN'T have item" : ""
item_group_canthave(string) : "Inventory: CAN'T have item from group" : ""
item_group_canthave_num(integer) : "Inventory: Item count in group CAN'T have (0 = all)" : 0

pass_ignore_use_triggers(choices) : "On pass: Ignore item's on use triggers?" : 0 =
[
0 : "No"
1 : "Yes"
]
pass_drop_item_name(string) : "On pass: Drop item(s)" : ""
pass_drop_item_group(string) : "On pass: Drop item(s) from group(s)" : ""
pass_ignore_drop_triggers(choices) : "On pass: Ignore item's on drop triggers?" : 0 =
[
0 : "No"
1 : "Yes"
]
pass_return_item_name(string) : "On pass: Return item(s)" : ""
pass_return_item_group(string) : "On pass: Return item(s) from group(s)" : ""
pass_ignore_return_triggers(choices) : "On pass: Ignore item's on return triggers?" : 0 =
[
0 : "No"
1 : "Yes"
]
pass_destroy_item_name(string) : "On pass: Destroy item(s)" : ""
pass_destroy_item_group(string) : "On pass: Destroy item(s) from group(s)" : ""
pass_ignore_destroy_triggers(choices) : "On pass: Ignore item's on destroy triggers?" : 0 =
[
0 : "No"
1 : "Yes"
]

target_on_fail(string) : "Target: Inventory rules failed" : ""
]

@BaseClass = RenderFxChoices
[
renderfx(choices) : "Render FX" : 0 =
[
0: "Normal"
1: "Slow Pulse"
2: "Fast Pulse"
3: "Slow Wide Pulse"
4: "Fast Wide Pulse"
9: "Slow Strobe"
10: "Fast Strobe"
11: "Faster Strobe"
12: "Slow Flicker"
13: "Fast Flicker"
5: "Slow Fade Away"
6: "Fast Fade Away"
7: "Slow Become Solid"
8: "Fast Become Solid"
14: "Constant Glow"
15: "Distort"
16: "Hologram (Distort + fade)"
17: "Dead Player (DONT USE!)"
18: "Explode (Garg Like)"
19: "Glow Shell"
20: "ClampMinScale (Sprites)"
]
]

@BaseClass base(RenderFxChoices, Appearflags) = RenderFields
[
rendermode(choices) : "Render Mode" : 0 =
[
0: "Normal"
1: "Color"
2: "Texture"
3: "Glow"
4: "Solid"
5: "Additive"
]
renderamt(integer) : "FX Amount (1 - 255)"
rendercolor(color255) : "FX Color (R G B)" : "0 0 0"
]

@BaseClass base(Targetname, Target, Appearflags, Angles) size(-16 -16 -36, 16 16 36) color(0 255 0) = PlayerClass []

@BaseClass base(Targetname, Target, Appearflags, Angles) size(-16 -16 -36, 16 16 36) color(0 255 0) = PlayerDmClass
[
spawnflags(Flags) =
[
// Disable this spawn point when the map starts
2 : "Start Off" : 0

// Player will spawn repeling down a rope (like repeling soldiers)
4 : "Repel Spawn" : 0

// Only spawn player if his targetname equals to message
8 : "Filter player targetname" : 0

// Invert player targetname filter (can use if DOESN'T match) -- needs flag 8!
16 : "Invert Filter" : 0

// Fire target when player spawns here, rather than when the spawn point is toggled on/off
32 : "Trigger on spawn" : 0
]
netname(string) : "New Player Targetname"
// Use a semi-colon ';' to specify multiple targetnames
message(string) : "Filter Player Targetname"
master(string) : "Master"
frags(string) : "Repel Speed"
triggerstate(choices) : "Trigger State" : 2 =
[
0: "Off"
1: "On"
2: "Toggle"
]
]

@BaseClass = NotRevivable
[
//Whether the monster can be revived or not
is_not_revivable(choices) : "Is not revivable" : 0 =
[
0 : "No"
1 : "Yes"
]
]

@BaseClass base(Targetname, Target, RenderFields, Angles, AttackObject, NotRevivable) color(0 200 200) = Monster
[
spawnflags(Flags) =
[
1 : "WaitTillSeen" : 0
2 : "Gag" : 0
4 : "MonsterClip" : 0
16: "Prisoner" : 0
128: "WaitForScript" : 0
256: "Pre-Disaster" : 0
512: "Don't Fade Corpse" : 0
16384: "No Dyn Collision" : 0
]
TriggerCondition(Choices) : "Trigger Condition" : 0 =
[
0 : "No Trigger"
1 : "See Player, Mad at Player"
2 : "Take Damage"
3 : "50% Health Remaining"
4 : "Death"
7 : "Hear World"
8 : "Hear Player"
9 : "Hear Combat"
10: "See Player Unconditional"
11: "See Player, Not In Combat"
]
TriggerTarget(String) : "Trigger Condition Target"
body(choices) : "Body" : 0 =
[
0 : "0"
]
skin(choices) : "Skin" : 0 =
[
0 : "0"
]
is_player_ally(Choices) : "Is Player Ally?" : 0 =
[
0 : "No (Default)"
1 : "Yes"
]
displayname(string) : "In-game Name" : ""
bloodcolor(choices) : "Blood Color" : 0 =
[
0 : "Monster Default"
-1 : "No Blood"
1 : "Red"
2 : "Yellow"
]
health(integer) : "Custom Health" : 0
model(studio) : "Custom Model"
minhullsize(string) : "Custom Min Hull Size (X Y Z)" : "0 0 0"
maxhullsize(string) : "Custom Max Hull Size (X Y Z)" : "0 0 0"
soundlist(string) : "Sound Replacement File"
freeroam(Choices) : "Monster Roaming (nodes)" : 0 =
[
0 : "Map Default"
1 : "Never"
2 : "Always"
]

path_name(string) : "Path Name" //The name of the path_waypoint, path_condition, or path_condition_controller this monster will look to.

// This will make the monster follow/protect whoever is specified
guard_ent(string): "Entity to Guard" : ""
]

@BaseClass = TalkMonster
[
UseSentence(String) : "Use Sentence"
UnUseSentence(String) : "Un-Use Sentence"

is_player_ally(Choices) : "Is Player Ally?" : 0 =
[
0 : "Yes (Default)"
1 : "No"
]
]

@BaseClass base(Targetname, Angles) size(-8 -8 -8, 8 8 8) = GibShooterBase
[
spawnflags(Flags) =
[
1 : "Repeatable" : 0
]

// how many pieces to create
m_iGibs(integer) : "Number of Gibs" : 3

// delay (in seconds) between shots. If 0, all gibs shoot at once.
delay(string) : "Delay between shots" : "0"

// how fast the gibs are fired
m_flVelocity(integer) : "Gib Velocity" : 200

// Course variance
m_flVariance(string) : "Course Variance" : "0.15"

// Time in seconds for gibs to live +/- 5%
m_flGibLife(string) : "Gib Life" : "4"
]

@BaseClass = Light
[
_light(color255) : "Brightness" : "255 255 128 200"
style(Choices) : "Appearance" : 0 =
[
0 : "Normal"
10: "Fluorescent flicker"
2 : "Slow, strong pulse"
11: "Slow pulse, noblack"
5 : "Gentle pulse"
1 : "Flicker A"
6 : "Flicker B"
3 : "Candle A"
7 : "Candle B"
8 : "Candle C"
4 : "Fast strobe"
9 : "Slow strobe"
]
pattern(string) : "Custom Appearance"
spawnflags(Flags) = [ 2 : "Remove on Spawn" : 0 ]
]

@BaseClass base(Targetname, Targetx, Global, AttackObject, RenderFields, ZHLT) = Breakable
[
//target(target_destination) : "Target on break" //Duplicate, already defined by Target
health(integer) : "Strength" : 1
material(choices) : "Material type" : 0 =
[
0: "Glass"
1: "Wood"
2: "Metal"
3: "Flesh"
4: "Cinder Block"
5: "Ceiling Tile"
6: "Computer"
7: "Unbreakable Glass"
8: "Rocks"
]
weapon(choices) : "Instant Break Weapon" : 1 =
[
1: "Crowbar"
19: "Crowbar (Electric Only)"
20: "Pipe Wrench"
]
explosion(choices) : "Gibs' direction and velocity" : 1 =
[
0: "Random direction; no velocity"
1: "Relative to attack/dmg./mat."
]
gibmodel(studio) : "Gib Model" : ""
spawnobject(choices) : "Spawn On Break" : 0 =
[
0: "Nothing"
1: "Battery"
2: "Healthkit"
3: "9mm Handgun"
4: "9mm Clip"
5: "Machine Gun"
6: "Machine Gun Clip"
7: "Machine Gun Grenades"
8: "Shotgun"
9: "Shotgun Shells"
10: "Crossbow"
11: "Crossbow Bolts"
12: "357"
13: "357 Clip"
14: "RPG"
15: "RPG Clip"
16: "Gauss Clip"
17: "Hand grenade"
18: "Tripmine"
19: "Satchel Charge"
20: "Snark"
21: "Hornet Gun"
22: "Crowbar"
23: "Pipewrench"
24: "Sniperrifle"
25: "Sniperrifle ammo"
26: "M16 Rifle"
27: "M249 Squad Automatic Weapon"
28: "Minigun"
29: "556 Ammo Box"
30: "Sporelauncher"
31: "Spore Clip"
32: "9mm Box"
33: "Uzi"
34: "Uzi akimbo"
35: "Desert Eagle"
36: "Barnacle Grapple"
37: "Medkit (portable)"
38: "HEV Suit"
39: "Antidote"
]
explodemagnitude(integer) : "Explode Magnitude (0=none)" : 0
soundlist(string) : "Sound Replacement File"
]

@BaseClass = BaseLockable
[
locked_sound(choices) : "Locked Sound" : 0 =
[
0: "None"
2: "Access Denied"
8: "Small zap"
10: "Buzz"
11: "Buzz Off"
12: "Latch Locked"
]
unlocked_sound(choices) : "Unlocked Sound" : 0 =
[
0: "None"
1: "Big zap & Warmup"
3: "Access Granted"
4: "Quick Combolock"
5: "Power Deadbolt 1"
6: "Power Deadbolt 2"
7: "Plunger"
8: "Small zap"
9: "Keycard Sound"
10: "Buzz"
13: "Latch Unlocked"
14: "Lightswitch"
]
locked_sentence(choices) : "Locked Sentence" : 0 =
[
0: "None"
1: "Gen. Access Denied"
2: "Security Lockout"
3: "Blast Door"
4: "Fire Door"
5: "Chemical Door"
6: "Radiation Door"
7: "Gen. Containment"
8: "Maintenance Door"
9: "Broken Shut Door"
]
unlocked_sentence(choices) : "Unlocked Sentence" : 0 =
[
0: "None"
1: "Gen. Access Granted"
2: "Security Disengaged"
3: "Blast Door"
4: "Fire Door"
5: "Chemical Door"
6: "Radiation Door"
7: "Gen. Containment"
8: "Maintenance area"
]

locked_sound_override(sound) : "Locked Sound Override"
unlocked_sound_override(sound) : "Unlocked Sound Override"
locked_sentence_override(string) : "Locked Sentence Override"
unlocked_sentence_override(string) : "Unlocked Sentence Override"
]

@BaseClass = StartStopable
[
fireonstart(string) : "Fire On Start"
fireonstart_triggerstate(choices) : "Fire On Start Trigger State" : 2 =
[
0: "Off"
1: "On"
2: "Toggle"
]

fireonstop(string) : "Fire On Stop"
fireonstop_triggerstate(choices) : "Fire On Stop Trigger State" : 2 =
[
0: "Off"
1: "On"
2: "Toggle"
]
]

@BaseClass = OpenClosable
[
fireonopening(string) : "Fire On Open Start"
fireonopening_triggerstate(choices) : "Fire On Open Start Trigger State" : 2 =
[
0: "Off"
1: "On"
2: "Toggle"
]

fireonclosing(string) : "Fire On Close Start"
fireonclosing_triggerstate(choices) : "Fire On Close Start Trigger State" : 2 =
[
0: "Off"
1: "On"
2: "Toggle"
]

// This can also be done with "fireonopen" (backward compatibility)
fireonopened(string) : "Fire On Open End"
fireonopened_triggerstate(choices) : "Fire On Open End Trigger State" : 2 =
[
0: "Off"
1: "On"
2: "Toggle"
]

// This can also be done with "netname" (backward compatibility)
fireonclosed(string) : "Fire On Close End"
fireonclosed_triggerstate(choices) : "Fire On Close End Trigger State" : 2 =
[
0: "Off"
1: "On"
2: "Toggle"
]
]

@BaseClass base(Appearflags, Global, Targetname, Targetx, FilterIn, FilterOut, InventoryRules, AttackObject, RenderFields, Angles, ZHLT, BaseLockable, StartStopable, OpenClosable) = Door
[
speed(integer) : "Speed" : 100
master(string) : "Master"
movesnd(choices) : "Move Sound" : 0 =
[
0: "No Sound"
1: "Servo (Sliding)"
2: "Pneumatic (Sliding)"
3: "Pneumatic (Rolling)"
4: "Vacuum"
5: "Power Hydraulic"
6: "Large Rollers"
7: "Track Door"
8: "Snappy Metal Door"
9: "Squeaky 1"
10: "Squeaky 2"
]
movesnd_loop(choices) : "Move Sound Loops?" : 0 =
[
0: "No"
1: "Yes"
]
stopsnd(choices) : "Stop Sound" : 0 =
[
0: "No Sound"
1: "Clang with brake"
2: "Clang reverb"
3: "Ratchet Stop"
4: "Chunk"
5: "Light airbrake"
6: "Metal Slide Stop"
7: "Metal Lock Stop"
8: "Snappy Metal Stop"
]
noise1(sound) : "Move Sound Override"
noise2(sound) : "Stop Sound Override"
wait(integer) : "delay before close, -1 stay open " : 4
lip(integer) : "Lip"
dmg(integer) : "Damage inflicted when blocked" : 0
message(string) : "Message if triggered"
health(integer) : "Strength" : 0
_minlight(string) : "Minimum light level"
soundlist(string) : "Sound Replacement File"
m_iOpenFlags(choices) : "Who can open this" : 0 =
[
0: "Default (0)"
1: "Pushables (1)"
2: "No clients (2)"
3: "1 + 2"
4: "Everything else (4)"
5: "1 + 4"
6: "2 + 4"
7: "1 + 2 + 4"
]
m_fIgnoreTargetname(choices) : "Ignore Targetname" : 0 =
[
0: "No"
1: "Yes"
]
m_iObeyTriggerMode(choices) : "Obey Trigger Mode" : 2 =
[
0 : "No"
1 : "Yes"
2 : "Yes, even when currently moving"
]
spawnflags(flags) =
[
1 : "Starts Open" : 0
4 : "Don't link" : 0
8: "Passable" : 0
32: "Toggle" : 0
256: "USE Only" : 0
512: "Monsters Can't" : 0
1024: "No Link-Checking" : 0
]
breakable(choices) : "Breakable" : 0 =
[
0: "No"
1: "Yes"
]
fireonbreak(target_destination) : "Fire on break"
material(choices) : "Material type" : 0 =
[
0: "Glass"
1: "Wood"
2: "Metal"
3: "Flesh"
4: "Cinder Block"
5: "Ceiling Tile"
6: "Computer"
7: "Unbreakable Glass"
8: "Rocks"
]
instantbreak(choices) : "Instant Break" : 0 =
[
0 : "No"
1 : "Yes"
]
weapon(choices) : "Instant Break Weapon" : 1 =
[
1: "Crowbar"
19: "Crowbar (Electric Only)"
20: "Pipe Wrench"
]
explosion(choices) : "Gibs' direction and velocity" : 1 =
[
0: "Random direction; no velocity"
1: "Relative to attack/dmg./mat."
]
gibmodel(studio) : "Gib Model" : ""
explodemagnitude(integer) : "Explode Magnitude (0=none)" : 0
displayname(string) : "HUD Info name"
onlytrigger(choices) : "Only Trigger" : 0 =
[
0 : "No"
1 : "Yes"
]
breakontrigger(choices) : "Break On Trigger" : 0 =
[
0 : "No"
1 : "Yes"
]
repairable(choices) : "Repairable" : 0 =
[
0 : "No"
1 : "Yes"
]
showhudinfo(choices) : "Show HUD Info" : 0 =
[
0 : "No"
1 : "Yes"
]
immunetoclients(choices) : "Immune To Clients" : 0 =
[
0 : "No"
1 : "Yes"
]
explosivesonly(choices) : "Explosives Only" : 0 =
[
0 : "No"
1 : "Yes"
]
]

@BaseClass base(Targetname, Target, RenderFields, Global, Angles) = BaseTank
[
spawnflags(flags) =
[
1 : "Active" : 0
16: "Only Direct" : 0
32: "Controllable" : 0
512: "Use Relations" : 0
1024: "Player can't fire" : 0
]

// Mainly for use with v.1.0.0.9's team settings (game_team_master)
master(string) : "(Team) Master"

yawrate(string) : "Yaw Rate" : "30"
yawrange(string) : "Yaw Range" : "180"
yawtolerance(string) : "Yaw Tolerance" : "15"
pitchrate(string) : "Pitch Rate" : "0"
pitchrange(string) : "Pitch Range" : "0"
pitchtolerance(string) : "Pitch Tolerance" : "5"
barrel(string) : "Barrel Length" : "0"
barrely(string) : "Barrel Horizontal" : "0"
barrelz(string) : "Barrel Vertical" : "0"
spritesmoke(string) : "Smoke Sprite" : ""
spriteflash(string) : "Flash Sprite" : ""
spritescale(string) : "Sprite Scale" : "1"
rotatesound(sound) : "Rotate Sound" : ""
firerate(string) : "Rate of Fire" : "1"
bullet_damage(string) : "Damage Per Bullet" : "0"
persistence(string) : "Firing Persistence" : "1"
firespread(choices) : "Bullet Accuracy" : 0 =
[
0: "Perfect Shot"
1: "Small cone"
2: "Medium cone"
3: "Large cone"
4: "Extra-large cone"
]
minRange(string) : "Minmum target range" : "0"
maxRange(string) : "Maximum target range" : "0"
_minlight(string) : "Minimum light level"
relation_player(choices) : "R Player" : 0 =
[
-2: "Ally"
-1: "Friend"
0: "No Relation"
1: "Dislike"
2: "Hate"
3: "Nemesis"
]
relation_none(choices) : "R Unknown" : 0 =
[
-2: "Ally"
-1: "Friend"
0: "No Relation"
1: "Dislike"
2: "Hate"
3: "Nemesis"
]
relation_machine(choices) : "R Machine" : 0 =
[
-2: "Ally"
-1: "Friend"
0: "No Relation"
1: "Dislike"
2: "Hate"
3: "Nemesis"
]
relation_human_passive(choices) : "R Human Passive" : 0 =
[
-2: "Ally"
-1: "Friend"
0: "No Relation"
1: "Dislike"
2: "Hate"
3: "Nemesis"
]
relation_human_militar(choices) : "R Human Military" : 0 =
[
-2: "Ally"
-1: "Friend"
0: "No Relation"
1: "Dislike"
2: "Hate"
3: "Nemesis"
]
relation_alien_militar(choices) : "R Alien Military" : 0 =
[
-2: "Ally"
-1: "Friend"
0: "No Relation"
1: "Dislike"
2: "Hate"
3: "Nemesis"
]
relation_alien_passive(choices) : "R Alien Passive" : 0 =
[
-2: "Ally"
-1: "Friend"
0: "No Relation"
1: "Dislike"
2: "Hate"
3: "Nemesis"
]
relation_alien_monster(choices) : "R Alien Monster" : 0 =
[
-2: "Ally"
-1: "Friend"
0: "No Relation"
1: "Dislike"
2: "Hate"
3: "Nemesis"
]
relation_alien_prey(choices) : "R Alien Prey" : 0 =
[
-2: "Ally"
-1: "Friend"
0: "No Relation"
1: "Dislike"
2: "Hate"
3: "Nemesis"
]
relation_alien_predator(choices) : "R Alien Predator" : 0 =
[
-2: "Ally"
-1: "Friend"
0: "No Relation"
1: "Dislike"
2: "Hate"
3: "Nemesis"
]
relation_insect(choices) : "R Insect" : 0 =
[
-2: "Ally"
-1: "Friend"
0: "No Relation"
1: "Dislike"
2: "Hate"
3: "Nemesis"
]
relation_player_ally(choices) : "R Player Ally" : 0 =
[
-2: "Ally"
-1: "Friend"
0: "No Relation"
1: "Dislike"
2: "Hate"
3: "Nemesis"
]
relation_player_bioweapon(choices) : "R Player BioWeapon" : 0 =
[
-2: "Ally"
-1: "Friend"
0: "No Relation"
1: "Dislike"
2: "Hate"
3: "Nemesis"
]
relation_monster_bioweapon(choices) : "R Monster BioWeapon" : 0 =
[
-2: "Ally"
-1: "Friend"
0: "No Relation"
1: "Dislike"
2: "Hate"
3: "Nemesis"
]
relation_machine(choices) : "R Machine" : 0 =
[
-2: "Ally"
-1: "Friend"
0: "No Relation"
1: "Dislike"
2: "Hate"
3: "Nemesis"
]
]

@BaseClass = PlatSounds
[
movesnd(choices) : "Move Sound" : 0 =
[
0: "No Sound"
1: "big elev 1"
2: "big elev 2"
3: "tech elev 1"
4: "tech elev 2"
5: "tech elev 3"
6: "freight elev 1"
7: "freight elev 2"
8: "heavy elev"
9: "rack elev"
10: "rail elev"
11: "squeek elev"
12: "odd elev 1"
13: "odd elev 2"
]
movesnd_loop(choices) : "Move Sound Loops?" : 0 =
[
0: "No"
1: "Yes"
]
stopsnd(choices) : "Stop Sound" : 0 =
[
0: "No Sound"
1: "big elev stop1"
2: "big elev stop2"
3: "freight elev stop"
4: "heavy elev stop"
5: "rack stop"
6: "rail stop"
7: "squeek stop"
8: "quick stop"
]
noise(sound) : "Move Sound Override"
noise1(sound) : "Stop Sound Override"
volume(string) : "Sound Volume 0.0 - 1.0" : "0.85"
soundlist(string) : "Sound Replacement File"
]

@BaseClass base(Appearflags, StartStopable, OpenClosable) = BasePlat
[
dmg(integer) : "Damage inflicted when blocked" : 0
]

@BaseClass base(Targetname, RenderFields, Global, PlatSounds, BasePlat) = Trackchange
[
height(integer) : "Travel altitude" : 0
spawnflags(flags) =
[
1: "Auto Activate train" : 0
2: "Relink track" : 0
8: "Start at Bottom" : 0
16: "Rotate Only" : 0
64: "X Axis" : 0
128: "Y Axis" : 0
]
rotation(integer) : "Spin amount" : 0
train(target_destination) : "Train to switch"
toptrack(target_destination) : "Top track"
bottomtrack(target_destination) : "Bottom track"
speed(integer) : "Move/Rotate speed" : 0
noise2(sound) : "Blocked Sound"
]

@BaseClass base(Targetx, Targetname, FilterIn, FilterOut, InventoryRules, ZHLTbmodel, Appearflags) = Trigger
[
netname(target_destination) : "Target Path"
master(string) : "Master"
sounds(choices) : "Sound style" : 0 =
[
0 : "No Sound"
]
message(string) : "Message (set sound too!)"
tiny_monsters(Choices) : "Allow tiny monsters (insects/hornets)" : 0 =
[
0 : "No"
1 : "Yes"
]
spawnflags(flags) =
[
1: "Monsters" : 0
2: "No Clients" : 0
4: "Pushables": 0
8: "Everything else": 0
16: "Fire On Enter": 0
32: "Fire On Exit": 0
]
]

@BaseClass base(Targetname, Target, Angles) = PortalBase
[
spawnflags(flags) =
[
1: "Solid" : 1
2: "Start Disabled" : 0
16: "Render only every 2nd frame": 0
]
zoom(integer) : "Zoom" : 1
fps(integer) : "Max FPS" : 0
mindist(integer) : "Min Render Distance" : 0
maxdist(integer) : "Max Render Distance" : 0
textureMode(choices) : "Texture Mode" : 1 =
[
0 : "{ Textures"
1 : "All Textures"
2 : "Named Texture"
]
textureName(string) : "Texture Name"
]

//
// Entities start here. Sorted by Name just like Hammer displays them.
//

@PointClass base(Targetname, Targetx, Angles) size(-16 -16 0, 16 16 72) color(164 0 255) = aiscripted_sequence : "AI Scripted Sequence"
[
m_iszEntity(string) : "Target Monster"
m_iszPlay(string) : "Action Animation" : ""
m_flRadius(integer) : "Search Radius" : 512
m_flRepeat(integer) : "Repeat Rate ms" : 0
m_fMoveTo(Choices) : "Move to Position" : 0 =
[
0 : "No"
1 : "Walk"
2 : "Run"
4 : "Instantaneous"
5 : "No - Turn to Face"
]
moveto_radius(integer) : "Move to Radius" : 0
m_iFinishSchedule(Choices) : "AI Schedule when done" : 0 =
[
0 : "Default AI"
1 : "Ambush"
]
spawnflags(Flags) =
[
4 : "Repeatable" : 0
8 : "Leave Corpse" : 0
]
]

@PointClass iconsprite("sprites/vhe-iconsprites/ambient_generic.spr") base(Targetname) color(220 220 220) = ambient_generic : "Universal Ambient"
[
message(sound) : "Sound File"
health(integer) : "Volume (10 = loudest)" : 10
playmode(choices) : "Play Mode" : 0 =
[
0: "Default"
1: "Play Once"
2: "Loop"
5: "Linear / Play Once"
6: "Linear / Loop"
]
preset(choices) : "Dynamic Presets" : 0 =
[
0: "None"
1: "Huge Machine"
2: "Big Machine"
3: "Machine"
4: "Slow Fade in"
5: "Fade in"
6: "Quick Fade in"
7: "Slow Pulse"
8: "Pulse"
9: "Quick pulse"
10: "Slow Oscillator"
11: "Oscillator"
12: "Quick Oscillator"
13: "Grunge pitch"
14: "Very low pitch"
15: "Low pitch"
16: "High pitch"
17: "Very high pitch"
18: "Screaming pitch"
19: "Oscillate spinup/down"
20: "Pulse spinup/down"
21: "Random pitch"
22: "Random pitch fast"
23: "Incremental Spinup"
24: "Alien"
25: "Bizzare"
26: "Planet X"
27: "Haunted"
]
volstart(integer) : "Start Volume" : 0
fadein(integer) : "Fade in time (0-100)" : 0
fadeout(integer) : "Fade out time (0-100)" : 0
pitch(integer) : "Pitch (> 100 = higher)" : 100
pitchstart(integer) : "Start Pitch" : 100
spinup(integer) : "Spin up time (0-100)" : 0
spindown(integer) : "Spin down time (0-100)" : 0
lfotype(choices) : "LFO type" : 0 =
[
0: "Off"
1: "Square Wave"
2: "Triangle Wave"
3: "Random"
4: "Saw Tooth Wave"
5: "Sine Wave"
]
lforate(integer) : "LFO rate (0-1000)" : 0
lfomodpitch(integer) : "LFO mod pitch (0-100)" : 0
lfomodvol(integer) : "LFO mod vol (0-100)" : 0
cspinup(integer) : "Incremental spinup count" : 0
linearmin(choices) : "Linear Min Radius" : 2 =
[
0: "0 - 0 units"
1: "1 - 256 units"
2: "2 - 512 units"
3: "3 - 768 units"
4: "4 - 1,024 units"
5: "5 - 1,280 units"
6: "6 - 1,536 units"
7: "7 - 1,792 units"
8: "8 - 2,048 units"
9: "9 - 2,304 units"
10: "10 - 2,560 units"
11: "11 - 2,816 units"
12: "12 - 3,072 units"
13: "13 - 3,328 units"
14: "14 - 3,584 units"
15: "15 - 3,840 units"
16: "16 - 4,096 units"
]
linearmax(choices) : "Linear End Radius" : 5 =
[
1: "1 - 256 units"
2: "2 - 512 units"
3: "3 - 768 units"
4: "4 - 1,024 units"
5: "5 - 1,280 units"
6: "6 - 1,536 units"
7: "7 - 1,792 units"
8: "8 - 2,048 units"
9: "9 - 2,304 units"
10: "10 - 2,560 units"
11: "11 - 2,816 units"
12: "12 - 3,072 units"
13: "13 - 3,328 units"
14: "14 - 3,584 units"
15: "15 - 3,840 units"
16: "16 - 4,096 units"
]
spawnflags(flags) =
[
1 : "Play Everywhere" : 0
2 : "Small Radius (~384)" : 0
4 : "Medium Radius (~768)" : 1
8 : "Large Radius (~1536)" : 0
16 : "Start Silent": 0
32 : "Un-looped|Cyclic": 0
64 : "User Only (+origin)" : 0
]
]

@PointClass iconsprite("sprites/vhe-iconsprites/ambient_generic.spr") base(Targetname) color(220 220 220) = ambient_music : "Ambient Music"
[
message(sound) : "Sound File"
volume(integer) : "Volume (10 = loudest)" : 10
spawnflags(flags) =
[
1 : "Start Silent" : 1
2 : "Loop" : 0
4 : "Activator Only" : 0
]
]

@PointClass base(Ammo, Targetx) studio("models/w_357ammobox.mdl") = ammo_357 : "357 / desert eagle round box" []

@PointClass base(Ammo, Targetx) studio("models/w_saw_clip.mdl") = ammo_556 : "5.56mm round box" []

@PointClass base(Ammo, Targetx) studio("models/w_9mmARclip.mdl") = ammo_556clip : "5.56mm M16 rifle magazine" []

@PointClass base(Ammo, Targetx) studio("models/w_m40a1clip.mdl") = ammo_762 : "7.62mm sniper rifle magazine" []

@PointClass base(Ammo, Targetx) studio("models/w_mp5_clip.mdl") = ammo_9mmAR : "9mm assault rifle magazine" []

@PointClass base(Ammo, Targetx) studio("models/w_chainammo.mdl") = ammo_9mmbox : "9mm round box (big)" []

@PointClass base(Ammo, Targetx) studio("models/w_9mmclip.mdl") = ammo_9mmclip : "9mm pistol magazine" []

@PointClass base(Ammo, Targetx) studio("models/w_argrenade.mdl") = ammo_ARgrenades : "M16's M203 grenades (x2)" []

@PointClass base(Ammo, Targetx) studio("models/w_shotbox.mdl") = ammo_buckshot : "Shotgun shell box" []

@PointClass base(Ammo, Targetx) studio("models/w_crossbow_clip.mdl") = ammo_crossbow : "Crossbow bolt magazine" []

@PointClass base(Ammo, Targetx) studio("models/w_gaussammo.mdl") = ammo_gaussclip : "Gauss/Gluon gun battery" []

@PointClass base(Ammo, Targetx) studio("models/w_rpgammo.mdl") = ammo_rpgclip : "Rockets (x2)" []

@PointClass base(Ammo, Targetx) size(-16 -16 -16, 16 16 16) studio("models/vhe-models/spore_ammo_hammer.mdl") = ammo_spore : "Spore plant"
[
movetype(choices) : "Gravity Setting" : 8 =
[
-1: "Unmoveable"
0: "Fall to the ground (OP4 maps only)"
5: "Hover in the air"
8: "Hover in the air, ignore brush collision"
]
]

@PointClass base(Ammo, Targetx) studio("models/spore.mdl") = ammo_sporeclip : "Spore" []

@PointClass base(Ammo, Targetx) studio("models/w_uzi_clip.mdl") = ammo_uziclip : "9mm Uzi magazine" []

@SolidClass base(Target, ZHLT) = button_target : "Target Button"
[
spawnflags(flags) =
[
1: "Use Activates" : 1
2: "Start On" : 0
]
master(string) : "Master"
renderfx(choices) : "Render FX" : 0 =
[
0: "Normal"
1: "Slow Pulse"
2: "Fast Pulse"
3: "Slow Wide Pulse"
4: "Fast Wide Pulse"
9: "Slow Strobe"
10: "Fast Strobe"
11: "Faster Strobe"
12: "Slow Flicker"
13: "Fast Flicker"
5: "Slow Fade Away"
6: "Fast Fade Away"
7: "Slow Become Solid"
8: "Fast Become Solid"
14: "Constant Glow"
15: "Distort"
16: "Hologram (Distort + fade)"
]
rendermode(choices) : "Render Mode" : 0 =
[
0: "Normal"
1: "Color"
2: "Texture"
3: "Glow"
4: "Solid"
5: "Additive"
]
renderamt(integer) : "FX Amount (1 - 255)"
rendercolor(color255) : "FX Color (R G B)" : "0 0 0"
use_type(choices) : "Use Type" : 3 =
[
0: "Off"
1: "On"
2: "Set"
3: "Toggle"
]
]

@PointClass color(165 185 160) = custom_precache : "Custom Precache"
[
model_1(studio): "Model 1"
model_2(studio): "Model 2"
model_3(studio): "Model 3"
model_4(studio): "Model 4"
model_5(studio): "Model 5"
model_6(studio): "Model 6"
model_7(studio): "Model 7"
model_8(studio): "Model 8"
model_9(studio): "Model 9"

sound_1(sound): "Sound 1"
sound_2(sound): "Sound 2"
sound_3(sound): "Sound 3"
sound_4(sound): "Sound 4"
sound_5(sound): "Sound 5"
sound_6(sound): "Sound 6"
sound_7(sound): "Sound 7"
sound_8(sound): "Sound 8"
sound_9(sound): "Sound 9"

sky_1(string): "Sky map 1"
sky_2(string): "Sky map 2"
sky_3(string): "Sky map 3"
sky_4(string): "Sky map 4"
sky_5(string): "Sky map 5"
sky_6(string): "Sky map 6"
sky_7(string): "Sky map 7"
sky_8(string): "Sky map 8"
sky_9(string): "Sky map 9"
]

@PointClass base(Targetname, Angles) size(-16 -16 0, 16 16 72) studio() color(128 128 128) = cycler : "Monster Cycler"
[
model(studio) : "Model"
renderfx(choices) : "Render FX" : 0 =
[
0: "Normal"
1: "Slow Pulse"
2: "Fast Pulse"
3: "Slow Wide Pulse"
4: "Fast Wide Pulse"
9: "Slow Strobe"
10: "Fast Strobe"
11: "Faster Strobe"
12: "Slow Flicker"
13: "Fast Flicker"
5: "Slow Fade Away"
6: "Fast Fade Away"
7: "Slow Become Solid"
8: "Fast Become Solid"
14: "Constant Glow"
15: "Distort"
16: "Hologram (Distort + fade)"
]
rendermode(choices) : "Render Mode" : 0 =
[
0: "Normal"
1: "Color"
2: "Texture"
3: "Glow"
4: "Solid"
5: "Additive"
]
renderamt(integer) : "FX Amount (1 - 255)"
rendercolor(color255) : "FX Color (R G B)" : "0 0 0"
]

@PointClass base(Targetname, Angles) sprite() color(128 128 128) = cycler_sprite : "Sprite Cycler"
[
model(sprite) : "Sprite"
framerate(integer) : "Frames per second" : 10
renderfx(choices) : "Render FX" : 0 =
[
0: "Normal"
1: "Slow Pulse"
2: "Fast Pulse"
3: "Slow Wide Pulse"
4: "Fast Wide Pulse"
9: "Slow Strobe"
10: "Fast Strobe"
11: "Faster Strobe"
12: "Slow Flicker"
13: "Fast Flicker"
5: "Slow Fade Away"
6: "Fast Fade Away"
7: "Slow Become Solid"
8: "Fast Become Solid"
14: "Constant Glow"
15: "Distort"
16: "Hologram (Distort + fade)"
]
rendermode(choices) : "Render Mode" : 0 =
[
0: "Normal"
1: "Color"
2: "Texture"
3: "Glow"
4: "Solid"
5: "Additive"
]
renderamt(integer) : "FX Amount (1 - 255)"
rendercolor(color255) : "FX Color (R G B)" : "0 0 0"
]

@PointClass base(Monster) size(-16 -16 -16, 16 16 16) studio() color(140 120 120) = cycler_weapon : "Weapon Cycler"[]

@PointClass sprite() base(Targetname, RenderFields, Angles) size(-4 -4 -4, 4 4 4) sprite() color(70 70 70) = cycler_wreckage : "Wreckage"
[
framerate(string) : "Framerate" : "10.0"
model(sprite) : "Sprite Name" : "sprites/fire.spr"
scale(string) : "Scale" : "1"
spawnflags(flags) =
[
32: "Toggle" : 0
64: "Start ON" : 0
]
]

@BaseClass = BaseCustomEntity : "Custom entity base" // Use this baseclass for custom entities, since they all allow for script files to be defined
[
m_iszScriptFile(string) : "Script file"
]

@BaseClass base(Global, RenderFields, ZHLT) = BaseCharger : "Base Charger"
[
// dmdelay(integer) : "Deathmatch recharge delay" : 0
_minlight(string) : "Minimum light level"
soundlist(string) : "Sound Replacement File"

CustomJuice(integer) : "Custom Juice Amount" : 0
CustomRechargeTime(integer) : "Custom Recharge Time" : 0

TriggerOnEmpty(target_destination) : "Trigger On Empty"
TriggerOnRecharged(target_destination) : "Trigger on Recharged"

CustomDeniedSound(sound) : "Custom Denied Sound"
CustomStartSound(sound) : "Custom Start Sound"
CustomLoopSound(sound) : "Custom Loop Sound"
]

@BaseClass = BeamStartEnd
[
LightningStart(target_destination) : "Start Entity"
LightningEnd(target_destination) : "Ending Entity"
]

@PointClass base(Targetname, BeamStartEnd, RenderFxChoices) size(-12 -12 -12, 12 12 12) color(255 250 230) = env_beam : "Energy Beam Effect"
[
renderamt(integer) : "Brightness (1 - 255)" : 100
rendercolor(color255) : "Beam Color (R G B)" : "0 0 0"
Radius(integer) : "Radius" : 256
life(string) : "Life (seconds 0 = infinite)" : "1"
BoltWidth(integer) : "Width of beam (pixels*0.1 0-255)" : 20
NoiseAmplitude(integer) : "Amount of noise (0-255)" : 0
texture(sprite) : "Sprite Name" : "sprites/laserbeam.spr"
TextureScroll(integer) : "Texture Scroll Rate (0-100)" : 35
framerate(integer) : "Frames per 10 seconds" : 0
framestart(integer) : "Starting frame" : 0
StrikeTime(string) : "Strike again time (secs)" : "1"
damage(string) : "Damage / second" : "0"
spawnflags(flags) =
[
1 : "Start On" : 0
2 : "Toggle" : 0
4 : "Random Strike" : 0
8 : "Ring" : 0
16: "StartSparks" : 0
32: "EndSparks" : 0
64: "Decal End" : 0
128: "Shade Start" : 0
256: "Shade End" : 0
]
]

@PointClass base(Targetname, Angles) size(-4 -4 -4, 4 4 4) studio("models/can.mdl") color(128 64 2) = env_beverage : "Beverage Dispenser"
[
health(integer) : "Capacity" : 10
skin(choices) : "Beverage Type" : 0 =
[
0 : "Coca-Cola"
1 : "Sprite"
2 : "Diet Coke"
3 : "Orange"
4 : "Surge"
5 : "Moxie"
6 : "Random"
]
model(string) : "Custom Model" : ""
weapons(integer) : "Health for Pickup" : 1
]

@PointClass base(Targetname, Angles) size(-8 -8 -8, 8 8 8) color(210 0 0) = env_blood : "Blood Effects"
[
color(choices) : "Blood Color" : 0 =
[
0 : "Red (Human)"
1 : "Yellow (Alien)"
]
amount(string) : "Amount of blood (damage to simulate)" : "100"
spawnflags(flags) =
[
1: "Random Direction" : 0
2: "Blood Stream" : 0
4: "On Player" : 0
8: "Spray decals" : 0
]
]

@SolidClass base(Targetname, ZHLTbmodel) = env_bubbles : "Bubble Volume"
[
density(integer) : "Bubble density" : 2
frequency(integer) : "Bubble frequency" : 2
current(integer) : "Speed of Current" : 0
spawnflags(Flags) =
[
1 : "Start Off" : 0
]
]

@PointClass base(Targetname) size(-12 -12 -12, 12 12 12) color(255 220 15) = env_explosion : "Explosion"
[
iMagnitude(Integer) : "Magnitude" : 100
spawnflags(flags) =
[
1: "No Damage" : 0
2: "Repeatable" : 0
4: "No Fireball" : 0
8: "No Smoke" : 0
16: "No Decal" : 0
32: "No Sparks" : 0
]
]

@PointClass base(Targetname) color(100 150 100) = env_fade : "Screen Fade"
[
spawnflags(flags) =
[
1: "Fade From" : 0
2: "Modulate" : 0
4: "Activator Only" : 0
]
duration(string) : "Duration (seconds)" : "2"
holdtime(string) : "Hold Fade (seconds)" : "0"
renderamt(integer) : "Fade Alpha" : 255
rendercolor(color255) : "Fade Color (R G B)" : "0 0 0"
]

@PointClass base(Targetname) color(196 195 192) = env_fog : "Fog Field"
[
spawnflags(flags) =
[
1: "Start Off" : 0
]
rendercolor(color255) : "Fog Color (RGB)" : "0 0 0"
// iuser1(integer) : "Fog Field Radius" : 8192
iuser2(integer) : "Start Distance" : 128
iuser3(integer) : "End Distance" : 1024
]

@PointClass base(Targetname) size(-16 -16 -16, 16 16 16) color(128 255 32) = env_funnel : "Large Portal Funnel"
[
sprite(sprite) : "Custom sprite"
spawnflags(flags) =
[
1 : "Reverse" : 0
2 : "Reusable" : 0
]
]

@PointClass base(Targetname) color(255 255 128) color(4 32 250) = env_global : "Global State"
[
globalstate(string) : "Global State to Set"
triggermode(choices) : "Trigger Mode" : 0 =
[
0 : "Off"
1 : "On"
2 : "Dead"
3 : "Toggle"
]
initialstate(choices) : "Initial State" : 0 =
[
0 : "Off"
1 : "On"
2 : "Dead"
]
spawnflags(flags) =
[
1 : "Set Initial State" : 0
]
]

@PointClass sprite() base(Targetname, RenderFields) size(-4 -4 -4, 4 4 4) color(60 200 5) = env_glow : "Light Glow/Haze"
[
model(sprite) : "Sprite Name" : "sprites/glow01.spr"
scale(string) : "Scale" : "1"
framestart(integer) : "Starting frame" : 0
]

@PointClass base(Targetname, RenderFxChoices, Angles) size(-8 -8 -8, 8 8 8) color(255 64 2) = env_laser : "Laser Beam Effect"
[
LaserTarget(target_destination) : "Target of Laser"
renderamt(integer) : "Brightness (1 - 255)" : 100
rendercolor(color255) : "Beam Color (R G B)" : "0 0 0"
width(integer) : "Width of beam (pixels*0.1 0-255)" : 20
NoiseAmplitude(integer) : "Amount of noise (0-255)" : 0
texture(sprite) : "Sprite Name" : "sprites/laserbeam.spr"
EndSprite(sprite) : "End Sprite" : ""
TextureScroll(integer) : "Texture Scroll Rate (0-100)" : 35
framestart(integer) : "Starting frame" : 0
damage(string) : "Damage / second" : "100"
spawnflags(flags) =
[
1 : "Start On" : 0
16: "StartSparks" : 0
32: "EndSparks" : 0
64: "Decal End" : 0
]
]

@PointClass base(Targetname, Target) color(255 0 255) = env_message : "HUD Text Message"
[
message(string) : "Message Name"
spawnflags(flags) =
[
1: "Play Once" : 0
2: "All Clients" : 0
]
messagesound(sound) : "Sound Effect"
messagevolume(string) : "Volume 0-10" : "10"
messageattenuation(Choices) : "Sound Radius" : 0 =
[
0 : "Small Radius (~384)"
1 : "Medium Radius (~768)"
2 : "Large Radius (~1536)"
3 : "Play Everywhere"
]
]

@PointClass base(Targetname, Target, RenderFields) color(110 120 0) = env_render : "Render Controls"
[
spawnflags(flags) =
[
1: "No Renderfx" : 0
2: "No Renderamt" : 0
4: "No Rendermode" : 0
8: "No Rendercolor" : 0

// Automatically change rendermode, do it by searching
16: "Auto Apply" : 0

]
armorvalue(string): "radius (0 disables)" : "0"
]

@PointClass base(Targetname, RenderFields) = env_render_individual : "Per-player render settings for entities"
[
spawnflags(Flags) =
[
1: "No Renderfx" : 0
2: "No Renderamt" : 0
4: "No Rendermode" : 0
8: "No Rendercolor" : 0

16: "Auto Apply" : 0
32: "Start On" : 0

64 : "Affect Activator (ignore netname)" : 0
128 : "Use Entity to copy from" : 0
]
target(string) : "Entity to affect"
netname(string) : "Player to affect"
message(string) : "Entity to copy from"
]

@PointClass base(Target, Targetname) size(-16 -16 -16, 16 16 16) iconsprite("sprites/vhe-iconsprites/env_sentence.spr") color(164 128 164) = env_sentence : "Announcement Sentence"
[
spawnflags(Flags) =
[
1 : "Activator Only" : 0
]
_text(string) : "Sentence"
]

@PointClass base(Targetname) color(188 180 172) = env_shake : "Screen Shake"
[
spawnflags(flags) =
[
1: "Global Shake" : 0
]
amplitude(string) : "Amplitude (degrees; 0-16)" : "4.0"
radius(string) : "Effect radius (if not global)" : "500"
duration(string) : "Duration (seconds; fades out)" : "1.0"
frequency(string) : "Frequency (Hz; 0-255)" : "2.5"
]

@PointClass base(GibShooterBase, RenderFields) color(184 90 164) = env_shooter : "Model Shooter"
[
shootmodel(studio) : "Model or Sprite name" : ""
shootsounds(choices) : "Material Sound" : -1 =
[
-1: "None"
0: "Glass"
1: "Wood"
2: "Metal"
3: "Flesh"
4: "Concrete"
]
scale(string) : "Gib Scale" : ""
skin(integer) : "Gib Skin" : 0
]

@PointClass base(Targetname) iconsprite("sprites/vhe-iconsprites/env_sound.spr") color(150 150 150) = env_sound : "DSP Sound"
[
spawnflags(flags) =
[
1: "USE Only" : 0
]
radius(integer) : "Radius" : 128
roomtype(Choices) : "Room Type" : 0 =
[
0 : "Normal (off)"
1 : "Generic"

2 : "Metal Small"
3 : "Metal Medium"
4 : "Metal Large"

5 : "Tunnel Small"
6 : "Tunnel Medium"
7 : "Tunnel Large"

8 : "Chamber Small"
9 : "Chamber Medium"
10: "Chamber Large"

11: "Bright Small"
12: "Bright Medium"
13: "Bright Large"

14: "Water Small"
15: "Water Medium"
16: "Water Large"

17: "Concrete Small"
18: "Concrete Medium"
19: "Concrete Large"

20: "Big Room"
21: "Bigger Room"
22: "Biggest Room"

23: "Cavern Small"
24: "Cavern Medium"
25: "Cavern Large"

26: "Weirdo - Drugged"
27: "Weirdo - Dizzy"
28: "Weirdo - Psychotic"
]
]

@PointClass base(Targetname, Angles) size(-8 -8 -8, 8 8 8) color(255 220 15) = env_spark : "Spark"
[
MaxDelay(string) : "Max Delay" : "0"
spawnflags(flags) =
[
32: "Toggle" : 0
64: "Start ON" : 0
]
]

@PointClass sprite() base(Targetname, RenderFields, Angles) size(-4 -4 -4, 4 4 4) color(190 200 180) = env_sprite : "Sprite Effect"
[
framerate(string) : "Framerate" : "10.0"
framestart(integer) : "Starting frame" : 0
model(sprite) : "Sprite Name" : "sprites/glow01.spr"
scale(string) : "Scale" : "1"
vp_type(choices) : "Draw Type / Orientation" : 0 =
[
0: "Default"
// These reflect the VP_ types in the sprite but are +1'd, so 0 can mean default
3: "Parallel"
1: "Parallel Upright"
5: "Parallel Orientated"
2: "Facing Upright"
4: "Orientated"
]
spawnflags(flags) =
[
1: "Start on" : 0
2: "Play Once" : 0
4: "Once + Remove" : 0
]
]

@BaseClass base(Targetname, Global, RenderFields, PlatSounds) = BaseTrain
[
target(target_source) : "First stop target"
speed(integer) : "Speed (units per second)" : 64
m_iObeyTriggerMode(choices) : "Obey Trigger Mode" : 1 =
[
0 : "No"
1 : "Yes"
]
]

@PointClass base(BaseTrain) color(190 200 180) = env_spritetrain : "Sprite Train"
[
model(sprite) : "Sprite Name" : "sprites/glow01.spr"
scale(string) : "Sprite Scale"
]

@SolidClass base(Targetname, RenderFields, Angles, ZHLTbmodel) = env_weather : "Weather Effect"
[
spawnflags(Flags) =
[
1 : "Start On" : 1
]

drop_model(string) : "Sprite (or Model) name"
drop_scale(string) : "Sprite Scale" : "1"
drop_vp_type(choices) : "Sprite Draw Type / Orientation" : 0 =
[
0: "Default"
// These reflect the VP_ types in the sprite but are +1'd, so 0 can mean default
3: "Parallel"
1: "Parallel Upright"
5: "Parallel Orientated"
2: "Facing Upright"
4: "Orientated"
]

splash_model(string) : "Splash Sprite (or Model) name"
splash_scale(string) : "Splash Sprite Scale" : "1"
splash_vp_type(choices) : "Splash Sprite Draw Type / Orientation" : 0 =
[
0: "Default"
// These reflect the VP_ types in the sprite but are +1'd, so 0 can mean default
3: "Parallel"
1: "Parallel Upright"
5: "Parallel Orientated"
2: "Facing Upright"
4: "Orientated"
]

speed(integer) : "Speed" : 50
density(integer) : "Density" : 30
angle_variance(integer) : "Angle Variance" : 10
speed_variance(integer) : "Speed Variance" : 10
]

@PointClass base(Targetname, Target, Angles) size(-16 -16 -16, 16 16 56) color(80 220 110) = env_xenmaker : "Xen Portal"
[
spawnflags(flags) =
[
1: "Try Once" : 0
2: "No Spawn" : 0
]

monstertype(string) : "Monster Type" : "monster_headcrab"

m_flBeamRadius(integer) : "Beam Radius (max)" : 255
m_iBeamAlpha(integer) : "Beam Alpha" : 128
m_iBeamCount(integer) : "Beam Count" : 8
m_vBeamColor(color255) : "Beam Color" : "217 226 146"

m_flLightRadius(integer) : "Light Radius" : 160
m_vLightColor(color255) : "Light Color" : "39 209 137"

m_flStartSpriteFramerate(integer) : "Sprite1 Framerate" : 12
m_flStartSpriteScale(string) : "Sprite1 Scale" : "1.0"
m_iStartSpriteAlpha(integer) : "Sprite1 Alpha" : 255
m_vStartSpriteColor(color255) : "Sprite1 Color" : "65 209 61"

m_flEndSpriteFramerate(integer) : "Sprite2 Framerate" : 12
m_flEndSpriteScale(string) : "Sprite2 Scale" : "1.0"
m_iEndSpriteAlpha(integer) : "Sprite2 Alpha" : 255
m_vEndSpriteColor(color255) : "Sprite2 Color" : "159 240 214"
]

@SolidClass base(Breakable) = func_breakable : "Breakable Object"
[
spawnflags(flags) =
[
1 : "Only Trigger" : 0
2 : "Touch" : 0
4 : "Pressure" : 0
8: "Repairable" : 0
32: "Show HUD Info" : 0
64: "Immune To Clients" : 0
256: "Instant Break" : 0
512: "Explosives Only" : 0
]
displayname(string) : "HUD Info name"
_minlight(string) : "Minimum light level"
]

@SolidClass base(Global, Targetname, Targetx, InventoryRules, AttackObject, RenderFields, Angles, ZHLT, BaseLockable) = func_button : "Button"
[
speed(integer) : "Speed" : 5
health(integer) : "Health (shootable if > 0)" : 0
lip(integer) : "Lip"
master(string) : "Master"
sounds(choices) : "Sounds" : 0 =
[
0: "None"
1: "Big zap & Warmup"
2: "Access Denied"
3: "Access Granted"
4: "Quick Combolock"
5: "Power Deadbolt 1"
6: "Power Deadbolt 2"
7: "Plunger"
8: "Small zap"
9: "Keycard Sound"
10: "Buzz"
11: "Buzz Off"
14: "Lightswitch"
]
noise(sound) : "Sound Override"
wait(integer) : "delay before reset (-1 stay)" : 3
spawnflags(flags) =
[
1: "Don't move" : 0
32: "Toggle" : 0
64: "Sparks" : 0
256: "Touch Activates": 0
]
_minlight(string) : "Minimum light level"
use_type(choices) : "Use Type" : 3 =
[
0: "Off"
1: "On"
2: "Set"
3: "Toggle"
]
]

@SolidClass base(Targetname, Angles, ZHLTbmodel) = func_clip : "Clip"
[
spawnflags(Flags) =
[
1 : "Start Off" : 1
2 : "Directional (Angles)" : 0
4 : "No Clients" : 0
8 : "Monsters" : 0
16 : "Pushables" : 0
32 : "Everything else" : 0
64 : "item_inv (thrown)" : 0
]
frags(String) : "Direction Tolerance" : "90"
]

@SolidClass base(Global, RenderFields, Targetname, Angles, ZHLT) = func_conveyor : "Conveyor Belt"
[
spawnflags(flags) =
[
1 : "No Push" : 0
2 : "Not Solid" : 0
]
speed(string) : "Conveyor Speed" : "100"
_minlight(string) : "Minimum light level"
]

@SolidClass = func_detail : "Detail Brushes"
[
zhlt_detaillevel(integer) : "Detail level" : 1
zhlt_chopdown(integer) : "Lower its level to chop others" : 0
zhlt_chopup(integer) : "Raise its level to get chopped" : 0
zhlt_coplanarpriority(integer) : "Priority when faces overlap" : 0
zhlt_clipnodedetaillevel(integer) : "Detail level of clip hulls" : 1
zhlt_noclip(choices) : "Disable clipping" : 0 =
[
0 : "Default"
1 : "Always non-solid"
]
]

@SolidClass base(Door) = func_door : "Basic door" []

@SolidClass base(Door) = func_door_rotating : "Rotating door"
[
spawnflags(flags) =
[
2 : "Reverse Dir" : 0
16: "One-way" : 0
64: "X Axis" : 0
128: "Y Axis" : 0
]
distance(integer) : "Distance (deg)" : 90
]

@SolidClass base(Appearflags, RenderFields, ZHLT) = func_friction : "Surface with a change in friction"
[
modifier(integer) : "Percentage of standard (0 - 100)" : 15
]

@SolidClass = func_group : "Non-entity solid brush group"
[
zhlt_coplanarpriority(integer) : "Priority when faces overlap" : 0
zhlt_noclip(choices) : "Disable clipping" : 0 =
[
0 : "Default"
1 : "Always non-solid"
]
]

@SolidClass base(Targetname, RenderFields, AttackObject, Global, ZHLT) = func_guntarget : "Moving platform"
[
spawnflags(Flags) =
[
1 : "Start On" : 0
]

speed(integer) : "Speed (units per second)" : 100
target(target_source) : "First stop target"
message(target_source) : "Fire on damage"
health(integer) : "Damage to Take" : 0
_minlight(string) : "Minimum light level"
]

@SolidClass base(BaseCharger) = func_healthcharger: "Wall health recharger"
[
]

@SolidClass base(Targetname, RenderFields, ZHLT) = func_illusionary : "Fake Wall/Light"
[
style(choices) : "Texlight style" : 0 =
[
0 : "Normal"
-3: "Grouped"
10: "Fluorescent flicker"
2 : "Slow, strong pulse"
11: "Slow pulse, noblack"
5 : "Gentle pulse"
1 : "Flicker A"
6 : "Flicker B"
3 : "Candle A"
7 : "Candle B"
8 : "Candle C"
4 : "Fast strobe"
9 : "Slow strobe"
12: "Underwater"
]
skin(choices) : "Contents" : -1 =
[
-1: "Empty"
-7: "Volumetric Light"
]
spawnflags(flags) =
[
2 : "Use Angles" : 0
]
_minlight(string) : "Minimum light level"
]

@SolidClass base(Targetname, ZHLTbmodel) = func_ladder : "Ladder"
[
spawnflags(flags) =
[
1: "Start Off" : 0
]
]

@SolidClass base(PortalBase) = func_mirror : "Mirror"
[
]

@SolidClass base(PortalBase) = func_monitor : "Monitor"
[
width(integer) : "Width (Resolution)" : 512
height(integer) : "Height (Resolution)" : 512
]

@SolidClass base(Targetname, ZHLTbmodel) = func_monsterclip : "Monster clip brush"
[
spawnflags(Flags) =
[
1 : "Start Off" : 1
2 : "Directional (Angles)" : 0
]
frags(String) : "Direction Tolerance" : "90"
]

@SolidClass base(Targetname, ZHLTbmodel) = func_mortar_field : "Mortar Field"
[
m_flSpread(integer) : "Spread Radius" : 64
m_iCount(integer) : "Repeat Count" : 1
m_fControl(Choices) : "Targeting" : 0 =
[
0 : "Random"
1 : "Activator"
2 : "Table"
]
m_iszXController(target_destination) : "X Controller"
m_iszYController(target_destination) : "Y Controller"
]

@SolidClass base(Target, ZHLTbmodel) = func_op4mortarcontroller : "Op4 Mortar Controller"
[
mortar_axis(Choices) : "Axis" : 0 =
[
0 : "Vertical"
1 : "Horizontal"
]
]

@SolidClass base(Global, Appearflags, Targetname, RenderFields, Angles, ZHLT) = func_pendulum : "Swings back and forth"
[
speed(integer) : "Speed" : 100
distance(integer) : "Distance (deg)" : 90
damp(integer) : "Damping (0-1000)" : 0
dmg(integer) : "Damage inflicted when blocked" : 0
spawnflags(flags) =
[
1: "Start ON" : 0
8: "Passable" : 0
16: "Auto-return" : 0
64: "X Axis" : 0
128: "Y Axis" : 0
]
_minlight(integer) : "_minlight"
]

@SolidClass base(Targetname, Global, RenderFields, PlatSounds, BasePlat, ZHLT) = func_plat : "Elevator"
[
spawnflags(Flags) =
[
1: "Toggle" : 0
]
height(integer) : "Travel altitude (can be negative)" : 0
speed(integer) : "Speed" : 50
_minlight(string) : "Minimum light level"
]

@SolidClass base(Targetname, Global, RenderFields, PlatSounds, BasePlat, Angles, ZHLT) = func_platrot : "Moving Rotating platform"
[
spawnflags(Flags) =
[
1: "Toggle" : 1
64: "X Axis" : 0
128: "Y Axis" : 0
]
speed(integer) : "Speed of rotation" : 50
height(integer) : "Travel altitude (can be negative)" : 0
rotation(integer) : "Spin amount" : 0
_minlight(string) : "Minimum light level"
]

@SolidClass base(PortalBase) = func_portal : "Portal"
[
spawnflags(flags) =
[
4: "Teleport" : 0
8: "No GL ClipPlanes": 0
32: "Shoot through": 0
]
]

@SolidClass base(Breakable, RenderFields, ZHLT) = func_pushable : "Pushable object"
[
spawnflags(flags) =
[
8: "Repairable" : 0
16: "Monsters Ignore?" : 0
32: "Show HUD Info" : 0
128: "Breakable" : 0
256: "1-Hit Break" : 0
512: "Explosives Only" : 0
1024: "Liftable" : 1
]
minhullsize(string) : "Custom Min Hull Size (X Y Z)" : "0 0 0"
maxhullsize(string) : "Custom Max Hull Size (X Y Z)" : "0 0 0"
friction(integer) : "Friction (0-400)" : 50
buoyancy(integer) : "Buoyancy" : 20
displayname(string) : "HUD Info name"
_minlight(string) : "Minimum light level"
]

@SolidClass base(BaseCharger) = func_recharge: "Battery recharger"
[
]

@SolidClass base(Targetname, Target, Global, InventoryRules, RenderFields, Angles, ZHLT, BaseLockable) = func_rot_button : "RotatingButton"
[
// changetarget will change the button's target's TARGET field to the button's changetarget.
changetarget(target_destination) : "ChangeTarget Name"
master(string) : "Master"
speed(integer) : "Speed" : 50
health(integer) : "Health (shootable if > 0)"
sounds(choices) : "Sounds" : 21 =
[
21: "Squeaky"
22: "Squeaky Pneumatic"
23: "Ratchet Groan"
24: "Clean Ratchet"
25: "Gas Clunk"
]
noise(sound) : "Sound Override"
wait(choices) : "Delay before reset" : 3 =
[
-1: "Stays pressed"
]
delay(string) : "Delay before trigger" : "0"
distance(integer) : "Distance (deg)" : 90
spawnflags(flags) =
[
1 : "Not solid" : 0
2 : "Reverse Dir" : 0
32: "Toggle" : 0
64: "X Axis" : 0
128: "Y Axis" : 0
256: "Touch Activates": 0
]
_minlight(integer) : "_minlight"
use_type(choices) : "Use Type" : 3 =
[
0: "Off"
1: "On"
2: "Set"
3: "Toggle"
]
]

@SolidClass base(Targetname, Global, RenderFields, Angles, ZHLT) = func_rotating : "Rotating Object"
[
speed(integer) : "Rotation Speed" : 0
volume(integer) : "Volume (10 = loudest)" : 10
fanfriction(integer) : "Friction (0 - 100%)" : 20
sounds(choices) : "Fan Sounds" : 0 =
[
0 : "No Sound"
1 : "Fast Whine"
2 : "Slow Rush"
3 : "Medium Rickety"
4 : "Fast Beating"
5 : "Slow Smooth"
]
message(sound) : "WAV Name"
spawnflags(flags) =
[
1 : "Start ON" : 0
2 : "Reverse Direction" : 0
4 : "X Axis" : 0
8 : "Y Axis" : 0
16: "Acc/Dcc" : 0
32: "Fan Pain" : 0
64: "Not Solid" : 0
128: "Small Radius (~384)" : 0
256: "Medium Radius (~768)" : 0
512: "Large Radius (~1536)" : 1
]
m_iObeyTriggerMode(choices) : "Obey Trigger Mode" : 1 =
[
0 : "No"
1 : "Yes"
]
_minlight(integer) : "_minlight"
spawnorigin(string) : "X Y Z - Move here after lighting" : "0 0 0"
dmg(integer) : "Damage inflicted when blocked" : 0
]

@SolidClass base(BaseTank, ZHLT) = func_tank : "Brush Gun Turret"
[
bullet(choices) : "Bullets" : 0 =
[
0: "None"
1: "9mm"
2: "MP5"
3: "12mm"
]
]

@SolidClass base(ZHLTbmodel, InventoryRules) = func_tankcontrols : "Tank controls"
[
target(target_destination) : "Tank entity name"
]

@SolidClass base(BaseTank, ZHLT) = func_tanklaser : "Brush Laser Turret"
[
laserentity(target_source) : "env_laser Entity"
]

@SolidClass base(BaseTank, ZHLT) = func_tankrocket : "Brush Rocket Turret" []

@SolidClass base(BaseTank, ZHLT) = func_tankmortar : "Brush Mortar Turret"
[
iMagnitude(Integer) : "Explosion Magnitude" : 100
]

@SolidClass base(Trackchange, ZHLT) = func_trackautochange : "Automatic track changing platform"
[
_minlight(string) : "Minimum light level"
]

@SolidClass base(Trackchange, ZHLT) = func_trackchange : "Train track changing platform"
[
_minlight(string) : "Minimum light level"
]

//"Forward Only" flag added - prevents the train from moving backwards.
//This is an original half-life feature; it existed in the code base but apparently was left out of the FGD by mistake.
//
//"No YAW (Y-rot)" flag added - Similar to the "No Pitch (X-rot)" flag, enabling this will force the train to skip updates of its facing angle as it moves.
@SolidClass base(Targetname, Angles, Global, RenderFields, AttackObject, ZHLT) = func_tracktrain : "Track Train"
[
spawnflags(flags) =
[
1 : "No Pitch (X-rot)" : 0
2 : "No User Control" : 0
4 : "Forward Only" : 0
8 : "Passable" : 0
16 : "No YAW (Y-rot)" : 0
]
target(target_destination) : "First stop target"
sounds(choices) : "Sound" : 0 =
[
0: "None"
1: "Rail 1"
2: "Rail 2"
3: "Rail 3"
4: "Rail 4"
5: "Rail 6"
6: "Rail 7"
]
noise(sound) : "Move Sound Override"
noise1(sound) : "Brake Sound Override"
noise2(sound) : "Start Sound Override"
wheels(integer) : "Distance between the wheels" : 50
height(integer) : "Height above track" : 4
startspeed(integer) : "Initial speed" : 0
speed(integer) : "Speed (units per second)" : 64
dmg(integer) : "Damage on crush" : 0
volume(integer) : "Volume (10 = loudest)" : 10
bank(string) : "Bank angle on turns" : "0"
_minlight(string) : "Minimum light level"
soundlist(string) : "Sound Replacement File"
]

@SolidClass base(ZHLTbmodel, InventoryRules) = func_traincontrols : "Train Controls"
[
target(target_destination) : "Train Name"
]

@SolidClass base(BaseTrain, AttackObject, ZHLT, StartStopable) = func_train : "Moving platform"
[
avelocity(string) : "Angular Velocity (X Y Z)"
dmg(integer) : "Damage on crush" : 0
skin(integer) : "Contents" : 0
_minlight(string) : "Minimum light level"
spawnflags(flags) =
[
8 : "Not solid" : 0
]
]

@SolidClass base(Targetname, Angles, Appearflags, RenderFields, Global, ZHLT) = func_wall : "Wall"
[
_minlight(string) : "Minimum light level"
style(choices) : "Texlight style" : 0 =
[
0 : "Normal"
-3: "Grouped"
10: "Fluorescent flicker"
2 : "Slow, strong pulse"
11: "Slow pulse, noblack"
5 : "Gentle pulse"
1 : "Flicker A"
6 : "Flicker B"
3 : "Candle A"
7 : "Candle B"
8 : "Candle C"
4 : "Fast strobe"
9 : "Slow strobe"
12: "Underwater"
]
spawnflags(flags) =
[
2 : "Use Angles" : 0
]
]

@SolidClass base(func_wall) = func_wall_toggle : "Toggleable geometry"
[
spawnflags(flags) =
[
1 : "Starts Invisible" : 0
]
]

@SolidClass base(Door, ZHLT) = func_water : "Liquid"
[
spawnflags(flags) =
[
1 : "Starts Open" : 0
256: "USE Only" : 0
]
skin(choices) : "Contents" : -3 =
[
-3: "Water"
-4: "Slime"
-5: "Lava"

-9: "CURRENT_0"
-10: "CURRENT_90"
-11: "CURRENT_180"
-12: "CURRENT_270"
-13: "CURRENT_UP"
-14: "CURRENT_DOWN"
-15: "TRANSLUCENT"

]
WaveHeight(string) : "Wave Height" : "3.2"
]

@PointClass base(Targetname, Targetx) color(238 240 238) = game_counter : "Fires when it hits limit"
[
spawnflags(flags) =
[
1: "Remove On fire" : 0
2: "Reset On fire" : 1
4: "Fire if over limit": 1
]
master(string) : "Master"
frags(integer) : "Initial Value" : 0
health(integer) : "Limit Value" : 10
]

@PointClass base(Targetname, Targetx) color(238 240 200) = game_counter_set : "Sets a game_counter"
[
spawnflags(flags) =
[
1: "Remove On fire" : 0
]
master(string) : "Master"
frags(integer) : "New Value" : 10
]

@PointClass base(Targetname) color(80 80 0) = game_end : "End this multiplayer game"
[
master(string) : "Master"
]

// Counts number of clients on the server and triggers if it matches min or max value
@PointClass color(0 255 96) = game_player_counter : "Game Player Counter"
[
frags(integer) : "Min Value" : 1
health(integer) : "Max Value" : 32
target(target_destination) : "Min Target"
netname(target_destination) : "Max Target"
message(String) : "Filter Player Targetname"
]

@PointClass base(Targetname, Targetx) color(200 100 0) = game_player_equip : "Initial player equipment"
[
spawnflags(flags) =
[
1: "USE Only" : 0
2: "Filter Playername" : 0
4: "Re-Equip on Use" : 0
8: "Append Map CFG" : 0
]
master(string) : "Team Master"

equipmode(choices) : "Equip mode" : 0 =
[
0: "Give items"
1: "Modify inventory"
]

inventorymode(choices) : "Inventory mode" : 0 =
[
0: "Set items"
1: "Add items"
2: "Subtract items"
3: "Remove items"
4: "Restock items"
5: "Limit items"
]
]

@PointClass base(Targetname, Targetx) color(255 2 0) = game_player_hurt : "Hurts player who fires"
[
dmg(string) : "Damage To Apply" : "65535"
spawnflags(flags) =
[
1: "Remove On fire" : 0
]
master(string) : "Master"
]

@PointClass base(Targetname, Targetx) color(255 205 0) = game_score : "Award/Deduct Points"
[
spawnflags(flags) =
[
1: "Allow Negative" : 0
2: "Team Points" : 0
]

points(integer) : "Points to add (+/-)" : 1
master(string) : "Master"
]

// Counts number of slots on the server and triggers if it matches value
@PointClass base(Targetx) color(0 255 148) = game_slot_counter : "Game Slot Counter"
[
frags(integer) : "Value" : 12
]

@PointClass base(Targetname, Targetx) color(192 255 0) = game_text : "HUD Text Message"
[
spawnflags(flags) =
[
1: "All Players" : 0
2: "No console echo" : 0
]

message(string) : "Message Text"
x(string) : "X (0 - 1.0 = left to right) (-1 centers)" : "-1"
y(string) : "Y (0 - 1.0 = top to bottom) (-1 centers)" : "0.67"
effect(Choices) : "Text Effect" : 0 =
[
0 : "Fade In/Out"
1 : "Credits"
2 : "Scan Out"
]
color(color255) : "Color 1 (Add 4th number >0 for opaque)" : "100 100 100"
color2(color255) : "Color 2 (Add 4th number >0 for opaque)" : "240 110 0"
fadein(string) : "Fade in Time (or character scan time)" : "1.5"
fadeout(string) : "Fade Out Time" : "0.5"
holdtime(string) : "Hold Time" : "1.2"
fxtime(string) : "Scan time (scan effect only)" : "0.25"
channel(choices) : "Text Channel" : 1 =
[
1 : "Channel 1"
2 : "Channel 2"
3 : "Channel 3"
4 : "Channel 4"
]
master(string) : "Master"
]

@SolidClass base(Targetname, ZHLTbmodel) = game_zone_player : "Player Zone brush"
[
spawnflags(Flags) =
[
1 : "Ignore Dead Players" : 0
]
intarget(target_destination) : "Target for IN players"
outtarget(target_destination) : "Target for OUT players"
incount(target_destination) : "Counter for IN players"
outcount(target_destination) : "Counter for OUT players"
// master(string) : "Master"
]

@PointClass base(GibShooterBase) color(180 2 0) = gibshooter : "Gib Shooter" []

// Global_light_control
// Alters appearance of switchable lights or sun (light_environment).
// Set "Light Entity Name" field to target a light entity.
// On trigger or map load (if no targetname specified), it updates the
// light's style using the specified "Custom Appearance" pattern.
@PointClass iconsprite("sprites/vhe-iconsprites/global_light_control.spr") base(Targetname, Target) size(-24 -24 -24, 24 24 24) color(96 96 32) = global_light_control : "Global Light Pattern"
[
target_entity(target_destination) : "Light Entity Name"
pattern(string) : "Custom Appearance"
]

@PointClass decal() base(Targetname, Appearflags) = infodecal : "Decal"
[
texture(decal)
]

@PointClass color(255 0 0) = info_angularfade : "Texture name : the speed at which light fade as its direction becomes parallel to the texture (default 1.0)" []

@PointClass base(Targetname) size(-24 -24 0, 24 24 16) color(20 190 60) = info_bigmomma : "Big Mamma Node"
[
spawnflags(Flags) =
[
1 : "Run To Node" : 0
2 : "Wait Indefinitely" : 0
]
target(target_destination) : "Next node"
radius(string) : "Radius" : "0"
reachdelay(string) : "Wait after approach" : "0"
killtarget(target_destination) : "KillTarget"
reachtarget(target_destination) : "Fire on approach"
reachsequence(string) : "Sequence on approach" : ""
health(string) : "Health on approach" : ""
presequence(string) : "Sequence before approach" : ""
]

@PointClass color(255 231 127) = info_compile_parameters : "Map Compile Parameters"
[
spawnflags(Flags) =
[
1 : "Ignore shared settings" : 0
2 : "Ignore CSG settings" : 0
4 : "Ignore BSP settings" : 0
8 : "Ignore VIS settings" : 0
16 : "Ignore RAD settings" : 0
]

// --- Shared options ---
verbose(choices) : "Verbose messages?" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
]
noinfo(choices) : "Don't show tool configuration information?" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
]
nolog(choices) : "Don't generate compile log file?" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
]
dev(choices) : "Developer message level" : 0 =
[
0 : "[ Unset ]"
-1 : "None"
1 : "Error"
2 : "Warning"
3 : "Info"
4 : "Fluff"
5 : "Spam"
6 : "Mega spam"
]
estimate(choices) : "Estimate compile times?" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
0 : "Yes"
]
chart(choices) : "Display statistics charts?" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
]
threads(integer) : "CPU thread count (0 for auto/max)" : 0
priority(choices) : "CPU process priority" : 0 =
[
0 : "[ Unset ]"
1 : "Low"
2 : "Normal"
3 : "High"
]
texdata(integer) : "Texture data memory (KiB)" : 0
lightdata(integer) : "Lighting data memory (KiB)" : 0

// --- CSG options ---
csg(choices) : "--- Perform CSG stage? ---" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
2 : "Yes, entity updates only mode"
]
csg_nowadtextures(choices) : "No WAD textures? (Embed textures into BSP.)" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
]
csg_noclip(choices) : "Disable clipping hull generation?" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
]
csg_clipeconomy(choices) : "Strip redundant clip nodes? (Economy mode.)" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
]
csg_cliptype(choices) : "Clipping hull type" : 0 =
[
0 : "[ Unset ]"
-1 : "Smallest"
1 : "Normalized"
2 : "Simple (most compact)"
3 : "Precise (recommended)"
4 : "Legacy"
]
csg_hullfile(string) : "Custom hull file" : ""
csg_noskyclip(choices) : "Disable sky clipping?" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
]
csg_tiny(string) : "Minimum brush face surface area before it is discarded" : ""
csg_brushunion(string) : "Threshold to warn about overlapping brushes" : ""
csg_nullfile(string) : "NULL texture substitutions file" : ""
csg_wadcfgfile(string) : "WAD configuration file" : ""
csg_wadcfgname(string) : "WAD configuration name" : ""
csg_wadautodetect(choices) : "WAD auto detect?" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
]
csg_nonulltex(choices) : "Don't strip null texture faces?" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
]
csg_nullifytrigger(choices) : "Strip trigger texture faces?" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
]
csg_nolightopt(choices) : "Don't optimize engine light entities?" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
]
csg_notextconvert(choices) : "Don't convert game_text from ANSI to UTF-8 format?" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
]
csg_scale(string) : "Scale the world (USE AT OWN RISK!)" : ""

// --- BSP options ---
bsp(choices) : "--- Perform BSP stage? ---" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
2 : "Yes, leak only mode"
]
bsp_subdivide(integer) : "Face subdivide size (64-528)" : 0
bsp_maxnodesize(integer) : "Maximum portal node size (64-1024)" : 0
bsp_notjunc(choices) : "Don't break edges on t-junctions?" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes (not recommended)"
]
bsp_nobrink(choices) : "Don't smooth brinks?" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes (not recommended)"
]
bsp_noclip(choices) : "Don't process the clipping hull?" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes (not recommended)"
]
bsp_nofill(choices) : "Don't fill outside? (Leaks will be masked.)" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes (not recommended)"
]
bsp_noinsidefill(choices) : "Don't fill empty spaces?" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
]
bsp_noopt(choices) : "Don't optimize planes?" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes (not recommended)"
]
bsp_noclipnodemerge(choices) : "Don't optimize clip nodes?" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes (not recommended)"
]
bsp_nonulltex(choices) : "Don't strip NULL textures?" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes (not recommended)"
]
bsp_nohull2(choices) : "Don't generate hull 2? (Big monsters & pushable fall out map!)" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
]
bsp_viewportal(choices) : "Show portal boundaries in PTS file?" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
]

// --- VIS options ---
vis(choices) : "--- Perform VIS stage? ---" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
2 : "Yes, fast mode"
3 : "Yes, full mode"
]

// --- RAD options ---
rad(choices) : "--- Perform RAD stage? ---" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
2 : "Yes, fast mode"
3 : "Yes, extra mode"
]
rad_waddir(string) : "WAD search directory" : ""
rad_vismatrix(choices) : "Use visibility matrix?" : 0 =
[
0 : "[ Unset ]"
-1 : "Normal (65,536 patch limit)"
1 : "Sparse"
2 : "None (slowest but most accurate lighting)"
]
rad_bounce(integer) : "Bounces" : 0
rad_ambient(string) : "Ambient world light (R G B)" : ""
rad_limiter(string) : "Light clipping threshold (-1 for none)" : ""
rad_circus(choices) : "Circus mode?" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
]
rad_nospread(choices) : "Disable sunlight spread angles?" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
]
rad_nopaque(choices) : "Disable opaque light flags?" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
]
rad_smooth(string) : "Smoothing threshold for blending (In degrees)" : ""
rad_smooth2(string) : "Smoothing threshold between different textures" : ""
rad_chop(string) : "Patch size for normal textures" : ""
rad_texchop(string) : "Patch size for texture light faces" : ""
rad_notexscale(choices) : "Scale patches with texture scale?" : 0 =
[
0 : "[ Unset ]"
1 : "No"
-1 : "Yes"
]
rad_subdivide(choices) : "Patch subdivide?" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
]
rad_coring(string) : "Lighting threshold before blackness" : ""
rad_dlight(string) : "Direct lighting threshold" : ""
rad_dscale(string) : "Direct lighting scale" : ""
rad_nolerp(choices) : "Disable interpolation? (Nearest point instead.)" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
]
rad_fade(string) : "Global fade (Larger values = shorter lights)" : ""
rad_texlightgap(string) : "Global gap distance for texture lights" : ""
rad_scale(string) : "Global light scaling" : ""
rad_colourscale(string) : "Per-colour light scaling (R G B)" : ""
rad_gamma(string) : "Global gamma" : ""
rad_colourgamma(string) : "Per-colour gamma (R G B)" : ""
rad_sky(string) : "Ambient sunlight shade contribution" : ""
rad_lights(string) : "Light textures file" : ""
rad_noskyfix(choices) : "Disable sky light being global?" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
]
rad_incremental(choices) : "Use/create an incremental transfer list file?" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
]
rad_dump(choices) : "Dump light patches to a file for debugging?" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
]
rad_colourjitter(string) : "Adds noise, independent colours, for dithering (R G B)" : ""
rad_jitter(string) : "Adds noise, monochromatic, for dithering (R G B)" : ""
rad_customshadowwithbounce(choices) : "Enables custom shadows with bounce light?" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
]
rad_rgbtransfers(choices) : "Enable RGB transfers? (For custom shadows.)" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
]
rad_minlight(integer) : "Minimum final light (0-255)" : 0
rad_compresstransfers(choices) : "Compress transfers?" : 0 =
[
0 : "[ Unset ]"
-1 : "32-bit"
1 : "16-bit"
2 : "8-bit"
]
rad_compressrgbtransfers(choices) : "Compress RGB transfers?" : 0 =
[
0 : "[ Unset ]"
-1 : "96-bit"
1 : "48-bit"
2 : "32-bit"
3 : "24-bit"
]
rad_softsky(choices) : "Smooth skylight?" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
]
rad_depth(string) : "Thickness of translucent faces" : ""
rad_blockopaque(choices) : "Remove the black areas around opaque entities?" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
]
rad_notextures(choices) : "Don't load textures?" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
]
rad_texreflectgamma(string) : "Reflection gamma" : ""
rad_texreflectscale(string) : "Reflection scale" : ""
rad_blur(string) : "Enlarge light map sample to blur the light map" : ""
rad_noemitterrange(choices) : "Don't fix pointy texture lights?" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
]
rad_nobleedfix(choices) : "Don't fix wall bleeding problem for large blur value?" : 0 =
[
0 : "[ Unset ]"
-1 : "No"
1 : "Yes"
]
]

@SolidClass = info_hullshape : "Hull shape definition"
[
targetname(target_source) : "Name"
defaulthulls(choices) : "Set as default shape" : 0 =
[
0: "No"
2: "Hull 1"
4: "Hull 2"
8: "Hull 3"
]
disabled(choices) : "Disable" : 0 =
[
0: "No"
1: "Yes"
]
]

@BaseClass = NodeBase
[
hinttype(Choices) : "Hint type" : 0 =
[
0 : "None"
4 : "World machinery"
8 : "World blinking light"
10 : "World human blood"
11 : "World alien blood"
]

activity(Choices) : "Hint activity" : 0 =
[
-1 : "None"
0 : "Reset"
1 : "Idle"
2 : "Guard"
3 : "Walk"
4 : "Run"
5 : "Fly"
6 : "Swim"
7 : "Hop"
8 : "Leap"
9 : "Fall"
10 : "Land"
11 : "Strafe left"
12 : "Strafe right"
13 : "Roll left"
14 : "Roll right"
15 : "Turn left"
16 : "Turn Right"
17 : "Crouch"
18 : "Crouch idle"
19 : "Stand up from crouch"
20 : "Use"
21 : "Signal 1"
22 : "Signal 2"
23 : "Signal 3"
24 : "Twitch"
25 : "Cower"
26 : "Small flinch"
27 : "Big flinch"
28 : "Range attack 1"
29 : "Range attack 2"
30 : "Melee attack 1"
31 : "Melee attack 2"
32 : "Reload"
33 : "Arm"
34 : "Disarm"
35 : "Eat"
36 : "Die simple"
37 : "Die backward"
38 : "Die forward"
39 : "Die violent"
40 : "Barnacle hit"
41 : "Barnacle pull"
42 : "Barnacle chomp"
43 : "Barnacle chew"
44 : "Sleep"
45 : "Inspect floor"
46 : "Inspect wall"
47 : "Idle angry"
48 : "Walk hurt"
49 : "Run hurt"
50 : "Hover"
51 : "Glide"
52 : "Fly left"
53 : "Fly right"
54 : "Detect scent"
55 : "Sniff"
56 : "Bite"
57 : "Threat display"
58 : "Fear display"
59 : "Excited"
60 : "Special attack 1"
61 : "Special attack 2"
62 : "Combat idle"
63 : "Walk scared"
64 : "Run scared"
65 : "Victory dance"
66 : "Die head shot"
67 : "Die chest shot"
68 : "Die gut shot"
69 : "Die back shot"
70 : "Flinch head"
71 : "Flinch chest"
72 : "Flinch stomach"
73 : "Flinch left arm"
74 : "Flinch right arm"
75 : "Flinch left leg"
76 : "Flinch right leg"
]
]

@PointClass base(NodeBase) size(-24 -24 -4, 24 24 4) color(225 227 0) = info_node : "ai node" []

@PointClass base(NodeBase) size(-32 -32 0, 32 32 64) color(225 227 0) = info_node_air : "ai air node" []

@PointClass base(Targetname) size(-4 -4 -4, 4 4 4) color(128 255 146) = info_null : "info_null (spotlight target)" []

@PointClass size(-4 -4 -4, 4 4 4) color(255 0 0) = info_overview_point : "Disable VIS here for overview"
[
reverse(choices) : "Reversed" : 0 =
[
0: "No"
1: "Yes"
]
]

@PointClass base(PlayerClass) studio("models/player.mdl") = info_player_coop : "Player co-operative start" []

@PointClass base(PlayerDmClass) studio("models/player.mdl") = info_player_deathmatch : "Player deathmatch start" []

@PointClass base(PlayerDmClass) studio("models/player.mdl") = info_player_dm2 : "Hidden deathmatch start (not visible in map list)" []

@PointClass base(PlayerClass) studio("models/player.mdl") = info_player_start : "Single player start (and multi-player initial viewpoint)" []

@PointClass size(-4 -4 -4, 4 4 4) color(255 0 0) = info_smoothvalue : "Texture name : Threshold of smooth angle" []

@PointClass size(-4 -4 -4, 4 4 4) color(255 255 0) = info_sunlight : "light_environment information that affects model brightness"
[
target(target_destination) : "Target"
angles(string) : "Pitch Yaw Roll (Y Z X)" : "0 0 0"
pitch(integer) : "Pitch" : -90
_light(color255) : "Brightness" : "0 0 0 100"
]

@PointClass base(Targetname) size(-4 -4 -4, 4 4 4) color(200 100 50) = info_target : "Generic target" []

@PointClass size(-16 -16 0, 16 16 72) base(PlayerClass) color(255 128 240) = info_teleport_destination : "Teleport destination"
[
spawnflags(Flags) =
[
32 : "Trigger on arrival" : 0
]
teleport_cooldown(string) : "Teleport Cooldown Delay" : "1"
]

@PointClass size(-4 -4 -4, 4 4 4) color(255 231 127) = info_texlights : "Texture Light Definitions" []

@PointClass size(-4 -4 -4, 4 4 4) color(255 0 0) = info_translucent : "Texture name : translucent amount (0.0-1.0)" []

@PointClass size(-16 -16 0, 16 16 24) base(Targetx, Item) studio("models/w_oxygen.mdl") = item_airtank : "Oxygen tank" [
spawnflags(Flags) =
[
1 : "Do not explode" : 0
2 : "Start empty" : 0
128 : "TOUCH Only" : 0
256 : "USE Only" : 0
512 : "Can Use w/o LoS" : 0
1024 : "" : 0
]

health(integer) : "Strength" : 0
air_time_given(integer) : "Extra Air Time Given (0 = default)" : 0
refill_delay(integer) : "Refill Time (0 = default, -1 = never)" : 0

target_on_consume(string) : "Target: On consume" : ""
target_on_is_empty(string) : "Target: On is empty" : ""
target_on_refill(string) : "Target: On refill" : ""
target_on_destroy(string) : "Target: On destroy" : ""

sound_on_consume(sound) : "Sound: On consume" : ""
sound_on_is_empty(sound) : "Sound: On is empty" : ""
sound_on_refill(sound) : "Sound: On refill" : ""
]

@PointClass size(-4 -4 0, 4 4 16) base(Target, Item) studio("models/w_antidote.mdl") = item_antidote : "Poison antidote" []

@PointClass size(-11 -11 0, 11 11 36) base(Target, Item) studio("models/barney_vest.mdl") = item_armorvest : "Armor vest" []

@PointClass size(-4 -4 0, 4 4 16) base(Target, Item) studio("models/w_battery.mdl") = item_battery : "HEV battery"
[
health(integer) : "Charge Supplied" : 0
healthcap(integer) : "Charge Cap" : 0
]

@PointClass base(ItemWithDefaultModel, Target) studio() = item_generic : "Generic scenery item" []

@PointClass size(-12 -12 0, 12 12 8) base(Target, Item) studio("models/w_medkit.mdl") = item_healthkit : "Health kit"
[
health(integer) : "Health Supplied" : 0
healthcap(integer) : "Health Cap" : 0
]

@PointClass size(-8 -8 0, 8 8 20) base(Target, Item) studio("models/barney_helmet.mdl") = item_helmet : "Helmet" []

@PointClass base(ItemWithDefaultModel, Target, CustomRespawnDelay) studio() = item_inventory : "Inventory item"
[
item_name(string) : "Item name" : ""
item_group(string) : "Item group name" : ""
display_name(string) : "Display name (HUD)" : ""
description(string) : "Description (HUD)" : ""
item_icon(string) : "Item icon (HUD)" : ""
activate_limit(integer) : "Self-activation limit (0 = infinite)" : 0
collect_limit(integer) : "Collection limit (0 = infinite)" : 0
weight(string) : "Item weight (0-100)" : "1.0"

filter_targetnames(string) : "Collect: Entity target names" : ""
filter_classnames(string) : "Collect: Entity class names" : ""
filter_teams(string) : "Collect: Teams" : ""
filter_npc_classifications(choices) : "Collect: NPC classifications" : 0 =
[
0 : "No filter"
-1 : "None"
1 : "Machine"
2 : "Player"
3 : "Human Passive"
4 : "Human Military"
5 : "Alien Military"
6 : "Alien Passive"
7 : "Alien Monster"
8 : "Alien Prey"
9 : "Alien Predator"
10 : "Insect"
11 : "Player Ally"
12 : "Player Hornet/Snark"
13 : "Alien Hornet/Snark"
14 : "X-Race"
15 : "X-Race: Shocktrooper/Voltigore"
16 : "Team 1"
17 : "Team 2"
18 : "Team 3"
19 : "Team 4"
]
item_name_required(string) : "Collect: Need item(s)" : ""
item_group_required(string) : "Collect: Need item(s) from group(s)" : ""
item_group_required_num(integer) : "Collect: Item count in group need have (0 = all)" : 0
item_name_moved(string) : "Collect: Item(s) moved" : ""
item_name_canthave(string) : "Collect: CAN'T have item" : ""
item_group_canthave(string) : "Collect: CAN'T have item from group" : ""
item_group_canthave_num(integer) : "Collect: Item count in group CAN'T have (0 = all)" : 0
item_name_not_moved(string) : "Collect: Item(s) NOT moved" : ""

carried_hidden(choices) : "Carried: Hide item (3rd person)" : 1 =
[
0 : "No"
1 : "Yes"
]
carried_skin(integer) : "Carried: Skin" : 0
carried_body(integer) : "Carried: Body" : 0
carried_sequencename(string) : "Carried: Sequence Name" : "carried"
carried_sequence(integer) : "Carried: Sequence Number (overrides name)" : 1

return_timelimit(string) : "Return: Wait (-1 = never)" : "60.0"
return_delay_respawn(choices) : "Return: Delay respawn (materialisation)" : 0 =
[
0 : "No"
1 : "Yes"
]

holder_timelimit(string) : "Holder: Hold time limit (0 = never)" : "0"
holder_time_activate_wait(string) : "Holder: Delay between self-activations (0 = none)" : "0"
holder_time_wearout(string) : "Holder: Wearing out trigger time (0 = none)" : "0"
holder_can_activate(choices) : "Holder: Allowed to self-activate" : 0 =
[
0 : "No"
1 : "Yes"
]
holder_timelimit_wait_until_activated(choices) : "Holder: Hold time limit doesn't start until item activated" : 1 =
[
0 : "No"
1 : "Yes"
]
holder_can_drop(choices) : "Holder: Allowed to drop" : 1 =
[
0 : "No"
1 : "Yes"
]
holder_keep_on_death(choices) : "Holder: Keep item on death" : 0 =
[
0 : "No"
1 : "Yes"
]
holder_keep_on_respawn(choices) : "Holder: Keep item on respawn" : 0 =
[
0 : "No"
1 : "Yes"
]

target_on_collect(string) : "Target: On collect (self)" : ""
target_on_collect_team(string) : "Target: On collect (team)" : ""
target_on_collect_other(string) : "Target: On collect (others)" : ""
target_cant_collect(string) : "Target: On can't collect (self)" : ""
target_cant_collect_team(string) : "Target: On can't collect (team)" : ""
target_cant_collect_other(string) : "Target: On can't collect (others)" : ""
target_on_drop(string) : "Target: On drop (self)" : ""
target_on_drop_team(string) : "Target: On drop (team)" : ""
target_on_drop_other(string) : "Target: On drop (others)" : ""
target_cant_drop(string) : "Target: On can't drop (self)" : ""
target_cant_drop_team(string) : "Target: On can't drop (team)" : ""
target_cant_drop_other(string) : "Target: On can't drop (others)" : ""
target_on_activate(string) : "Target: On self-activate (self)" : ""
target_on_activate_team(string) : "Target: On self-activate (team)" : ""
target_on_activate_other(string) : "Target: On self-activate (others)" : ""
target_cant_activate(string) : "Target: On can't self-activate (self)" : ""
target_cant_activate_team(string) : "Target: On can't self-activate (team)" : ""
target_cant_activate_other(string) : "Target: On can't self-activate (others)" : ""
target_on_use(string) : "Target: On use by trigger (self)" : ""
target_on_use_team(string) : "Target: On use by trigger (team)" : ""
target_on_use_other(string) : "Target: On use by trigger (others)" : ""
target_on_wearing_out(string) : "Target: On wearing out (self)" : ""
target_on_wearing_out_team(string) : "Target: On wearing out (team)" : ""
target_on_wearing_out_other(string) : "Target: On wearing out (others)" : ""
target_on_return(string) : "Target: On return (self)" : ""
target_on_return_team(string) : "Target: On return (team)" : ""
target_on_return_other(string) : "Target: On return (other)" : ""
target_on_materialise(string) : "Target: On materialise after return" : ""
target_on_destroy(string) : "Target: On destroy" : ""

effects_wait_until_activated(choices) : "Effects: Wait until item is self-activated?" : 0 =
[
0 : "No"
1 : "Yes"
]
effects_permanent(choices) : "Effects: Permanent? (Until respawn)" : 0 =
[
0 : "No"
1 : "Yes"
]
effect_glow(color255) : "Effects: Glow shell color (R G B)" : "0 0 0"
effect_block_weapons(choices) : "Effects: Block weapons" : 0 =
[
0 : "No"
1 : "Yes"
]
effect_invulnerable(choices) : "Effects: Invulnerable" : 0 =
[
0 : "No"
1 : "Yes"
]
effect_invisible(choices) : "Effects: Invisible" : 0 =
[
0 : "No"
1 : "Yes"
]
effect_nonsolid(choices) : "Effects: Non-solid" : 0 =
[
0 : "No"
1 : "Yes"
]
effect_respiration(string) : "Effects: Time before drown (seconds)" : "0.0"
effect_friction(string) : "Effects: Friction modifier (%)" : "100.0"
effect_gravity(string) : "Effects: Gravity modifier (%)" : "100.0"
effect_speed(string) : "Effects: Speed modifier (%)" : "100.0"
effect_damage(string) : "Effects: Damage modifier (%)" : "100.0"
]

@PointClass size(-14 -14 0, 14 14 36) base(Target, Item) studio("models/w_longjump.mdl") = item_longjump : "Longjump module" []

@PointClass size(-12 -12 0, 12 12 1) base(Target, Item) studio("models/w_security.mdl") = item_security : "Security card" []

@PointClass size(-15 -15 0, 15 15 64) base(Target, Item) studio("models/w_suit.mdl") = item_suit : "HEV Suit"
[
spawnflags(Flags) =
[
1 : "Short Logon" : 0
]
]

@PointClass iconsprite("sprites/vhe-iconsprites/light.spr") base(Target, Targetname, Light, ZHLTpoint) = light : "Invisible lightsource"
[
spawnflags(Flags) =
[
1 : "Initially dark" : 0
2 : "Remove Entity" : 0
]
]

@PointClass size(-4 -4 -4, 4 4 4) color(255 255 0) = light_bounce : "Bounce light control"
[
target(target_destination) : "Target solid entity"
targetname(target_source) : "Name"
style(choices) : "Appearance (no name allowed)" : 0 =
[
0 : "Normal"
10: "Fluorescent flicker"
2 : "Slow, strong pulse"
11: "Slow pulse, no black"
5 : "Gentle pulse"
1 : "Flicker A"
6 : "Flicker B"
3 : "Candle A"
7 : "Candle B"
8 : "Candle C"
4 : "Fast strobe"
9 : "Slow strobe"
12 : "Underwater mutation"
]
pattern(string) : "Custom Appearance"
convertto(choices) : "Classname in game" : "light" =
[
"light" : "light"
"light_spot" : "light_spot"
]
spawnflags(flags) =
[
1 : "Initially dark" : 0
2048 : "Not in Deathmatch" : 0
]
]

@PointClass base(Targetname, Angles, ZHLTpoint) iconsprite("sprites/vhe-iconsprites/light_environment.spr") = light_environment : "Environment"
[
pitch(integer) : "Pitch" : 0
_light(color255) : "Brightness" : "255 255 128 200"
_diffuse_light(color255) : "Ambient Color" : ""
_spread(string) : "Sun Spread" : ""
]

@PointClass color(255 255 0) = light_shadow : "Dynamic shadow control"
[
target(target_destination) : "Target solid entity"
targetname(target_source) : "Name"
style(choices) : "Appearance (no name allowed)" : 0 =
[
0 : "Normal"
10: "Fluorescent flicker"
2 : "Slow, strong pulse"
11: "Slow pulse, no black"
5 : "Gentle pulse"
1 : "Flicker A"
6 : "Flicker B"
3 : "Candle A"
7 : "Candle B"
8 : "Candle C"
4 : "Fast strobe"
9 : "Slow strobe"
12 : "Underwater mutation"
]
pattern(string) : "Custom Appearance"
convertto(choices) : "Classname in game" : "light" =
[
"light" : "light"
"light_spot" : "light_spot"
]
spawnflags(flags) =
[
1 : "Initially dark" : 0
2048 : "Not in Deathmatch" : 0
]
]

@PointClass iconsprite("sprites/vhe-iconsprites/light_spot.spr") base(Targetname, Target, Angles, ZHLTpoint) = light_spot : "Spotlight"
[
_cone(integer) : "Inner (bright) angle" : 30
_cone2(integer) : "Outer (fading) angle" : 45
pitch(integer) : "Pitch" : -90
_light(color255) : "Brightness" : "255 255 128 200"
_sky(Choices) : "Is Sky" : 0 =
[
0 : "No"
1 : "Yes"
]
spawnflags(Flags) = [ 1 : "Initially dark" : 0 ]
style(Choices) : "Appearance" : 0 =
[
0 : "Normal"
10: "Fluorescent flicker"
2 : "Slow, strong pulse"
11: "Slow pulse, noblack"
5 : "Gentle pulse"
1 : "Flicker A"
6 : "Flicker B"
3 : "Candle A"
7 : "Candle B"
8 : "Candle C"
4 : "Fast strobe"
9 : "Slow strobe"
]
pattern(string) : "Custom Appearance"
]

@PointClass size(-4 -4 -4, 4 4 4) color(255 255 0) = light_surface : "Advanced texture light"
[
_tex(string) : "Texture name" : ""
_frange(string) : "Filter max distance" : ""
_fdist(string) : "Filter max dist to plane" : ""
_fclass(string) : "Filter entity classname" : ""
_fname(string) : "Filter entity name" : ""
_light(color255) : "Texture brightness" : "255 255 255 80"
_texcolor(color255) : "Color(replace texture color)" : ""
_cone(string) : "Inner(bright) angle(90default)" : ""
_cone2(string) : "Outer(fading) angle(90default)" : ""
_scale(string) : "Adjust emit scale(1.0default)" : ""
_chop(string) : "Grid size of sampling" : ""
_texlightgap(choices) : "Dark gap in front of texlight" : "" =
[
"": "Default (no gap)"
"0.0": "0.0 - no gap"
"3.0": "3.0 - small gap"
"12.0": "12.0 - large gap"
]
_fast(choices) : "Fast" : "" =
[
"": "Auto"
1: "Yes"
2: "No"
]
convertto(choices) : "Classname in game" : "light" =
[
"light" : "light"
"light_spot" : "light_spot"
]
targetname(target_source) : "Name" : ""
style(choices) : "Appearance (no name allowed)" : "" =
[
"" : "Normal"
10: "Fluorescent flicker"
2 : "Slow, strong pulse"
11: "Slow pulse, no black"
5 : "Gentle pulse"
1 : "Flicker A"
6 : "Flicker B"
3 : "Candle A"
7 : "Candle B"
8 : "Candle C"
4 : "Fast strobe"
9 : "Slow strobe"
12 : "Underwater mutation"
]
pattern(string) : "Custom Appearance" : ""
spawnflags(flags) =
[
1 : "Initially dark" : 0
2048 : "Not in Deathmatch" : 0
]
]

@SolidClass base(Door, ZHLT) = momentary_door : "Momentary/Continuous door"
[
spawnflags(flags) =
[
1 : "Starts Open" : 0
]
]

@SolidClass base(Targetname, Target, Angles, RenderFields, ZHLT) = momentary_rot_button : "Direct wheel control"
[
speed(integer) : "Speed" : 50
master(string) : "Master"
sounds(choices) : "Sounds" : 0 =
[
0: "None"
1: "Big zap & Warmup"
2: "Access Denied"
3: "Access Granted"
4: "Quick Combolock"
5: "Power Deadbolt 1"
6: "Power Deadbolt 2"
7: "Plunger"
8: "Small zap"
9: "Keycard Sound"
21: "Squeaky"
22: "Squeaky Pneumatic"
23: "Ratchet Groan"
24: "Clean Ratchet"
25: "Gas Clunk"
]
noise(sound) : "Sound Override"
distance(integer) : "Distance (deg)" : 90
returnspeed(integer) : "Auto-return speed" : 0
spawnflags(flags) =
[
1: "Door Hack" : 0
2: "Not useable" : 0
16: "Auto Return" : 0
64: "X Axis" : 0
128: "Y Axis" : 0
]
_minlight(integer) : "_minlight"
use_type(choices) : "Use Type" : 2 =
[
0: "Off"
1: "On"
2: "Set"
3: "Toggle"
]
]

@PointClass base(Monster) size(-40 -40 0, 40 40 64) studio("models/baby_voltigore.mdl") = monster_alien_babyvoltigore : "Baby Voltigore"
[
netname(string) : "Squad Name"
spawnflags(Flags) =
[
32 : "SquadLeader" : 0
]
]

@PointClass base(Monster) size(-16 -16 0, 16 16 72) studio("models/controller.mdl") = monster_alien_controller : "Controller" []

@PointClass base(Monster) size(-32 -32 0, 32 32 64) studio("models/agrunt.mdl") = monster_alien_grunt : "Alien Grunt"
[
weapons(Choices) : "Weapons" : 0 =
[
1 : "Hivehand Only"
3 : "Hivehand + Snarks"
8 : "Melee-Only"
10 : "Melee-Only + Snarks"
]

netname(string) : "Squad Name"

spawnflags(Flags) =
[
32 : "SquadLeader" : 0
]
]

@PointClass base(Monster) size(-16 -16 0, 16 16 72) studio("models/islave.mdl") = monster_alien_slave : "Vortigaunt"
[
netname(string) : "Squad Name"
spawnflags(Flags) =
[
32 : "SquadLeader" : 0
64 : "IgnorePlayer" : 0
]
]

@PointClass base(Monster) size(-32 -32 0, 32 32 64) studio("models/Tor.mdl") = monster_alien_tor : "Alien Tor"
[
netname(string) : "Squad Name"
spawnflags(Flags) =
[
32 : "SquadLeader" : 0
]
]

@PointClass base(Monster) size(-80 -80 0, 80 80 90) studio("models/voltigore.mdl") = monster_alien_voltigore : "Voltigore"
[
netname(string) : "Squad Name"
spawnflags(Flags) =
[
32 : "SquadLeader" : 0
]
]

@PointClass base(Monster) size(-360 -360 -172, 360 360 8) studio("models/apache.mdl") = monster_apache : "Apache"
[
spawnflags(Flags) =
[
8 : "NoWreckage" : 0
64 : "Start Inactive" : 0
]
]

@PointClass base(Monster) size(-16 -16 0, 16 16 72) studio("models/massn.mdl") = monster_assassin_repel : "Male Assassin (Repel)"
[
netname(string) : "Squad Name"
spawnflags(Flags) =
[
32 : "SquadLeader" : 0
]
weapons(Choices) : "Weapons" : 3 =
[
1 : "MP5"
3 : "MP5 + HG"
5 : "M16 + GL"
8 : "Sniper Rifle"
10 : "Sniper Rifle + HG"
32 : "No Weapons"
256 : "Sniper - No drop"
]
sequence(Choices) : "Animation Sequence (editor)" : 47 =
[
47 : "repel_repel"
]

]

@PointClass base(Monster) size(-16 -16 0, 16 16 36) studio("models/baby_headcrab.mdl") = monster_babycrab : "Baby Headcrab" []

@PointClass base(Monster) size(-32 -32 0, 32 32 128) studio("models/babygarg.mdl") = monster_babygarg : "Baby Gargantua" []

@PointClass base(Monster) size(-16 -16 -36, 16 16 0) studio("models/barnacle.mdl") = monster_barnacle : "Barnacle Monster" []

@PointClass base(Monster, TalkMonster) size(-16 -16 0, 16 16 72) studio("models/barney.mdl") = monster_barney : "Barney"
[
sequence(Choices) : "Animation Sequence (editor)" : 0 =
[
0 : "idle1"
19 : "locked_door"
21 : "barn_Wave"
22 : "beat_grunt"
23 : "beat_gruntidle"
24 : "flashlight"
38 : "stuffed_in_vent"
40 : "cprbarney"
41 : "cprbarneyrevive"
42 : "barney_dragvent"
43 : "dying_barney"
44 : "dying_barneyidle"
45 : "dying_friend"
46 : "dying_friendidle"
47 : "c1a3_bidle"
48 : "c1a3_ventb"
49 : "c1a3_emergeidle"
50 : "c1a3_emerge"
51 : "haulbarney"
52 : "intropush"
53 : "fence"
54 : "sit1"
55 : "almostidle"
56 : "almost"
57 : "laseridle"
58 : "laser_top"
59 : "laser_bottom"
60 : "barneyfallidle"
61 : "barneyfall"
62 : "c3a2_draw"
63 : "unlatch"
64 : "retina"
65 : "relaxstand"
66 : "assassinated"
67 : "trackswitch"
68 : "pepsiswing"
69 : "pepsipush"
70 : "buttonpush"
]
]

@PointClass base(RenderFields, Appearflags, Angles) size(-16 -16 0, 16 16 72) studio("models/barney.mdl") = monster_barney_dead : "Dead Barney"
[
pose(Choices) : "Pose" : 0 =
[
0 : "On back"
1 : "On side"
2 : "On stomach"
]
sequence(Choices) : "Animation Sequence (editor)" : 35 =
[
35 : "lying_on_back"
36 : "lying_on_side"
37 : "lying_on_stomach"
]
model(studio) : "Custom Model"
]

@PointClass base(Monster) size(-95 -95 0, 95 95 190) studio("models/big_mom.mdl") = monster_bigmomma : "Big Mamma"
[
netname(string) : "First node" : ""

spawnflags(Flags) =
[
1024: "No Babycrabs" : 0
]
]

@PointClass base(Monster) size(-480 -480 -112, 480 480 24) studio("models/blkop_osprey.mdl") = monster_blkop_osprey : "Black Ops Osprey"
[
spawnflags(Flags) =
[
64 : "Start Inactive" : 0
]
]

@PointClass base(Monster) size(-360 -360 -172, 360 360 8) studio("models/blkop_apache.mdl") = monster_blkop_apache : "Black Ops Apache"
[
spawnflags(Flags) =
[
8 : "NoWreckage" : 0
64 : "Start Inactive" : 0
]
]

@PointClass base(Monster) size(-16 -16 0, 16 16 72) studio("models/floater.mdl") = monster_bloater : "Bloater" []

@PointClass base(Monster) size(-16 -16 0, 16 16 72) studio("models/bgman.mdl") = monster_bodyguard : "Body Guard"
[
weapons(Choices) : "Weapons" : 0 =
[
0 : "Random"
1 : "Pistol"
2 : "Desert Eagle"
3 : "Shotgun"
4 : "Akimbo Uzis"
5 : "MP5"
6 : "Sniper Rifle"
7 : "Minigun"
]
]

@PointClass base(Monster) size(-32 -32 0, 32 32 64) studio("models/bullsquid.mdl") = monster_bullchicken : "BullChicken" []

@PointClass base(Monster) size(-16 -16 0, 16 16 36) studio("models/chubby.mdl") = monster_chumtoad : "Chumtoad" []

@PointClass base(Monster, TalkMonster) size(-16 -16 0, 16 16 72) studio("models/cleansuit_scientist.mdl") = monster_cleansuit_scientist : "Cleansuit Scientist"
[
body(Choices) : "Body" : -1 =
[
-1 : "Random"
0 : "Glasses"
1 : "Einstein"
2 : "Luther"
3 : "Slick"
]
sequence(Choices) : "Animation Sequence (editor)" : 13 =
[
13 : "idle1"
27 : "eye_wipe"
28 : "pull_needle"
29 : "return_needle"
30 : "give_shot"
41 : "germandeath"
48 : "console"
49 : "dryhands"
50 : "tieshoe"
51 : "whiteboard"
52 : "studycart"
53 : "lean"
54 : "pondering"
55 : "pondering2"
56 : "pondering3"
57 : "buysoda"
61 : "push_button"
62 : "converse1"
63 : "converse2"
64 : "retina"
65 : "talkleft"
66 : "talkright"
67 : "deskidle"
68 : "coffee"
69 : "franticbutton"
71 : "scientist_throwna"
72 : "scientist_thrownb"
73 : "scientist_beatwindow"
75 : "scientist_zombiefear"
77 : "teleport_fidget"
79 : "sitlookleft"
80 : "sitlookright"
81 : "sitscared"
82 : "sitting2"
83 : "sitting3"
84 : "cprscientist"
85 : "cprscientistrevive"
86 : "cowering_in_corner"
87 : "sstruggleidle"
88 : "sstruggle"
89 : "headcrabbed"
90 : "c1a0_catwalkidle"
91 : "c1a0_catwalk"
92 : "ceiling_dangle"
93 : "ventpull1"
94 : "ventpull2"
95 : "ventpullidle1"
96 : "ventpullidle2"
97 : "sitidle"
98 : "sitstand"
99 : "keypad"
101 : "lookwindow"
102 : "wave"
103 : "pulldoor"
104 : "beatdoor"
105 : "fallingloop"
106 : "crawlwindow"
107 : "divewindow"
108 : "locked_door"
109 : "push_button2"
110 : "unlock_door"
112 : "handrailidle"
113 : "handrail"
114 : "hanging_idle"
115 : "fall"
116 : "scientist_get_pulled"
117 : "hanging_idle2"
118 : "fall_elevator"
119 : "scientist_idlewall"
120 : "ickyjump_sci"
121 : "haulscientist"
122 : "c1a4_wounded_idle"
123 : "c1a4_dying_speech"
124 : "tentacle_grab"
125 : "helicack"
126 : "windive"
127 : "scicrashidle"
128 : "scicrash"
129 : "onguard"
130 : "seeya"
131 : "rocketcrawl"
132 : "portal"
133 : "gluonshow"
135 : "kneel"
]
]

@PointClass base(Appearflags, RenderFields, Angles) size(-16 -16 0, 16 16 72) studio("models/cleansuit_scientist.mdl") = monster_cleansuit_scientist_dead : "Dead Cleansuit Scientist"
[
body(Choices) : "Body" : -1 =
[
-1 : "Random"
0 : "Glasses"
1 : "Einstein"
2 : "Luther"
3 : "Slick"
]
pose(Choices) : "Pose" : 0 =
[
0 : "On back"
1 : "On Stomach"
2 : "Sitting"
3 : "Hanging"
4 : "Table1"
5 : "Table2"
6 : "Table3"
]
sequence(Choices) : "Animation Sequence (editor)" : 37 =
[
37 : "lying_on_back"
38 : "lying_on_stomach"
39 : "dead_sitting"
40 : "dead_table1"
41 : "dead_table2"
42 : "dead_table3"
]
model(studio) : "Custom Model"
]

@PointClass base(Monster) size(-3 -3 0, 3 3 3) studio("models/roach.mdl") = monster_cockroach : "Cockroach" []

@PointClass base(Monster) size(-16 -16 0, 16 16 72) studio() = monster_furniture : "Monster Furniture" [
sequence(string) : "Animation Sequence (Number)" : "0"
]

@PointClass base(Monster) size(-32 -32 0, 32 32 128) studio("models/garg.mdl") = monster_gargantua : "Gargantua" []

@PointClass base(Monster, RenderFields) size(-16 -16 -36, 16 16 36) studio() = monster_generic : "Generic Script Monster"
[
sequence(string) : "Animation Sequence (Number)" : "0"
spawnflags(Flags) =
[
4 : "Not solid" : 0
8 : "Head Controller" : 0
]

disableai(choices) : "Disable AI" : 0 =
[
0 : "No"
1 : "Yes"
]
]

@PointClass base(Monster) size(-16 -16 0, 16 16 72) studio("models/gman.mdl") = monster_gman : "G-Man" []

@PointClass base(Monster) size(-16 -16 0, 16 16 72) studio("models/gonome.mdl") = monster_gonome : "Gonome" []

@PointClass base(RenderFields, Appearflags, Angles) size(-16 -16 0, 16 16 72) studio("models/gonome.mdl") = monster_gonome_dead : "Dead Gonome"
[
pose(Choices) : "Pose" : 0 =
[
0 : "On stomach"
1 : "On back"
2 : "On side"
3 : "On stomach"
]
sequence(Choices) : "Animation Sequence (editor)" : 19 =
[
19 : "dead_on_stomach1_1"
20 : "dead_on_back"
21 : "dead_on_stomach1_2"
22 : "dead_on_side"
]
model(studio) : "Custom Model"
]

@PointClass base(Monster) size(-16 -16 0, 16 16 72) studio("models/hgrunt_opfor.mdl") = monster_grunt_ally_repel : "Human Grunt Ally (Repel)"
[
netname(string) : "Squad Name"
spawnflags(Flags) =
[
32 : "SquadLeader" : 0
]
weapons(Choices) : "Weapons" : 3 =
[
1 : "MP5"
3 : "MP5 + HG"
5 : "M16 + GL"
8 : "Shotgun"
10 : "Shotgun + HG"
16 : "Saw"
]
head(Choices) : "Heads" : -1 =
[
-1 : "Default"
0 : "Gas Mask"
1 : "Beret"
2 : "Ops Mask"
3 : "Bandana White"
4 : "Bandana Black"
]
sequence(Choices) : "Animation Sequence (editor)" : 51 =
[
51 : "repel_repel"
]
]

@PointClass base(Monster) size(-16 -16 0, 16 16 72) studio("models/hgrunt.mdl") = monster_grunt_repel : "Human Grunt (Repel)"
[
netname(string) : "Squad Name"
spawnflags(Flags) =
[
32 : "SquadLeader" : 0
]

weapons(Choices) : "Weapons" : 1 =
[
1 : "MP5"
3 : "MP5 + HG"
5 : "M16 + GL"
8 : "Shotgun"
10 : "Shotgun + HG"
64 : "Rocket Launcher"
66 : "Rocket Launcher + HG"
128 : "Sniper Rifle"
130 : "Sniper Rifle + HG"
]

sequence(Choices) : "Animation Sequence (editor)" : 50 =
[
50 : "repel_repel"
]
]

@PointClass base(RenderFields, Appearflags, Angles) = monster_handgrenade : "Live Handgrenade"
[
health(integer) : "Delay before explosion" : 0
new_model(studio) : "Custom Model" : ""
]

@PointClass base(Monster) size(-16 -16 0, 16 16 36) studio("models/headcrab.mdl") = monster_headcrab : "Head Crab" []

@PointClass base(Appearflags, RenderFields, Angles) size(-16 -16 0, 16 16 72) studio("models/player.mdl") = monster_hevsuit_dead : "Dead HEV Suit"
[
pose(Choices) : "Pose" : 0 =
[
0 : "On back"
1 : "Seated"
2 : "On stomach"
3 : "On Table"
]
sequence(Choices) : "Animation Sequence (editor)" : 177 =
[
177 : "deadback"
178 : "deadsitting"
179 : "deadstomach"
180 : "deadtable"
]
model(studio) : "Custom Model"
]

@PointClass base(Appearflags, RenderFields, Angles) size(-16 -16 0, 16 16 72) studio("models/hgrunt.mdl") = monster_hgrunt_dead : "Dead Human Grunt"
[
pose(Choices) : "Pose" : 0 =
[
0 : "On stomach"
1 : "On side"
2 : "Seated"
]
sequence(Choices) : "Animation Sequence (editor)" : 46 =
[
46 : "On stomach"
47 : "On side"
48 : "Seated"
]
body(Choices) : "Body" : 0 =
[
0 : "Grunt with Gun"
1 : "Commander with Gun"
2 : "Grunt no Gun"
3 : "Commander no Gun"
]
model(studio) : "Custom Model"
]

@PointClass base(Monster) size(-16 -16 0, 16 16 36) studio("models/houndeye.mdl") = monster_houndeye : "Houndeye"
[
netname(string) : "Squad Name"
spawnflags(Flags) =
[
32 : "SquadLeader" : 0
]
]

@PointClass base(Monster) size(-16 -16 0, 16 16 72) studio("models/hassassin.mdl") = monster_human_assassin : "Human Assassin" []

@PointClass base(Monster) size(-16 -16 0, 16 16 72) studio("models/hgrunt.mdl") = monster_human_grunt : "Human Grunt (camo)"
[
spawnflags(Flags) =
[
32 : "SquadLeader" : 0
]
netname(string) : "Squad Name"
weapons(Choices) : "Weapons" : 1 =
[
1 : "MP5"
3 : "MP5 + HG"
5 : "M16 + GL"
8 : "Shotgun"
10 : "Shotgun + HG"
64 : "Rocket Launcher"
66 : "Rocket Launcher + HG"
128 : "Sniper Rifle"
130 : "Sniper Rifle + HG"
]
]

@PointClass base(Monster, TalkMonster) size(-16 -16 0, 16 16 72) studio("models/hgruntf.mdl") = monster_human_grunt_ally : "Human Grunt Ally (camo)"
[
netname(string) : "Squad Name"
spawnflags(Flags) =
[
32 : "SquadLeader" : 0
]
weapons(Choices) : "Weapons" : 3 =
[
0 : "Default"
1 : "MP5"
3 : "MP5 + HG"
5 : "M16 + GL"
8 : "Shotgun"
10 : "Shotgun + HG"
16 : "Saw"
32 : "None"
]
head(Choices) : "Heads" : -1 =
[
-1 : "Default"
0 : "Gas Mask"
1 : "Beret"
2 : "Ops Mask"
3 : "Bandana White"
4 : "Bandana Black"
5 : "MP"
6 : "Major"
7 : "Beret (Black)"
]
]

@PointClass base(Targetname, Appearflags, RenderFields, Angles) size(-16 -16 0, 16 16 72) studio("models/hgruntf.mdl") = monster_human_grunt_ally_dead : "Dead Human Grunt Ally"
[
pose(Choices) : "Pose" : 0 =
[
0 : "On stomach"
1 : "On side"
2 : "Seated"
3 : "Dead On Back"
4 : "Dead On Stomach"
5 : "Head Crabbed"
]
sequence(Choices) : "Animation Sequence (editor)" : 44 =
[
44 : "On stomach"
45 : "On side"
46 : "Seated"
]
weapons(Choices) : "Weapons" : 1 =
[
0 : "None"
1 : "M16"
8 : "Shotgun"
16 : "Saw"
]
head(Choices) : "Heads" : 0 =
[
0 : "Gas Mask"
1 : "Beret"
2 : "Ops Mask"
3 : "Bandana White"
4 : "Bandana Black"
5 : "MP"
]
model(studio) : "Custom Model"
]

@PointClass base(Monster, TalkMonster) size(-16 -16 0, 16 16 72) studio("models/hgrunt_medicf.mdl") = monster_human_medic_ally : "Medic"
[
netname(string) : "Squad Name"
spawnflags(Flags) =
[
32 : "SquadLeader" : 0
]
head(Choices) : "Heads" : -1 =
[
-1 : "Random"
0 : "White"
1 : "Black"
]
weapons(Choices) : "Weapons" : 2 =
[
0 : "None"
1 : "Desert Eagle"
2 : "9mm Handgun"
4 : "Hypodermic Needle"
]
]

@PointClass base(Targetname, Appearflags, RenderFields, Angles) size(-16 -16 0, 16 16 72) studio("models/hgrunt_medicf.mdl") = monster_human_medic_ally_dead : "Dead Medic"
[
pose(Choices) : "Pose" : 0 =
[
0 : "On stomach"
1 : "On side"
2 : "Seated"
3 : "Dead On Back"
4 : "Dead On Stomach"
5 : "Head Crabbed"
]
sequence(Choices) : "Animation Sequence (editor)" : 44 =
[
44 : "On stomach"
45 : "On side"
46 : "Seated"
]
weapons(Choices) : "Weapons" : 2 =
[
0 : "None"
1 : "Desert Eagle"
2 : "9mm Handgun"
4 : "Hypodermic Needle"
]
head(Choices) : "Heads" : -1 =
[
-1 : "Random"
0 : "White"
1 : "Black"
]
model(studio) : "Custom Model"
]

@PointClass base(Monster, TalkMonster) size(-16 -16 0, 16 16 72) studio("models/hgrunt_torchf.mdl") = monster_human_torch_ally : "Torch"
[
netname(string) : "Squad Name"
spawnflags(Flags) =
[
32 : "SquadLeader" : 0
]
weapons(Choices) : "Weapons" : 1 =
[
1 : "Desert Eagle"
2 : "Blow Torch"
]
]

@PointClass base(Monster) size(-16 -16 0, 16 16 72) studio("models/hwgrunt.mdl") = monster_hwgrunt : "Heavy Weapons Grunt"
[
netname(string) : "Squad Name"
spawnflags(Flags) =
[
32 : "SquadLeader" : 0
]

weapons(Choices) : "Secondary Weapon" : 1 =
[
0 : "Random Pistol"
1 : "Glock"
2 : "Desert Eagle"
3 : "357 Python"
]

disable_minigun_drop(Choices) : "Disable Minigun Drop" : 1 =
[
0 : "No (default)"
1 : "Yes"
]

]

@PointClass base(Monster) size(-16 -16 0, 16 16 72) studio("models/hwgrunt.mdl") = monster_hwgrunt_repel : "Heavy Weapons Grunt (Repel)"
[
netname(string) : "Squad Name"
spawnflags(Flags) =
[
32 : "SquadLeader" : 0
]
sequence(Choices) : "Animation Sequence (editor)" : 14 =
[
14 : "repel_repel"
]
weapons(Choices) : "Drop Minigun" : 0 =
[
0 : "Yes (on death)"
256 : "No"
]
]

@PointClass base(Monster) size(-32 -32 0, 32 32 64) studio("models/icky.mdl") = monster_ichthyosaur : "Ichthyosaur" []

@PointClass base(Monster) size(-24 -24 0, 24 24 112) studio("models/kingpin.mdl") = monster_kingpin : "Kingpin" []

@PointClass base(Monster) size(-6 -6 0, 6 6 6) studio("models/leech.mdl") = monster_leech : "Leech" []

@PointClass base(Monster) size(-16 -16 0, 16 16 72) studio("models/massn.mdl") = monster_male_assassin : "Male Assassin"
[
netname(string) : "Squad Name"
spawnflags(Flags) =
[
32 : "SquadLeader" : 0
]
head(Choices) : "Heads" : 0 =
[
-1 : "Random"
0 : "Ski Mask White"
1 : "Ski Mask Black"
2 : "Night Goggles"
]
weapons(Choices) : "Weapons" : 3 =
[
1 : "MP5"
3 : "MP5 + HG"
5 : "M16 + GL"
8 : "Sniper Rifle"
10 : "Sniper Rifle + HG"
32 : "No Weapons"
256 : "Sniper - No drop"
]
]

@PointClass base(Monster) size(-16 -16 0, 16 16 72) studio("models/hgrunt_medicf.mdl") = monster_medic_ally_repel : "Human Medic Ally (Repel)"
[
netname(string) : "Squad Name"
spawnflags(Flags) =
[
32 : "SquadLeader" : 0
]
head(Choices) : "Heads" : -1 =
[
-1 : "Random"
0 : "White"
1 : "Black"
]
weapons(Choices) : "Weapons" : 2 =
[
0 : "None"
1 : "Desert Eagle"
2 : "9mm Handgun"
4 : "Hypodermic Needle"
]
sequence(Choices) : "Animation Sequence (editor)" : 41 =
[
41 : "repel_repel"
]
]

@PointClass base(Monster) size(-16 -16 -32, 16 16 32) studio("models/miniturret.mdl") = monster_miniturret : "Mini Auto Turret"
[
orientation(Choices) : "Orientation" : 0 =
[
0 : "Floor Mount"
1 : "Ceiling Mount"
]
spawnflags(Flags) =
[
32 : "Autostart" : 0
64 : "Start Inactive" : 0
]
maxsleep(string) : "Search Time (before deactivate)" : "15"
turnrate(integer) : "Turn Rate" : 30
attackrange(integer) : "Max Attack Range" : 1200
]

@PointClass base(Monster) size(-192 -192 0, 192 192 384) studio("models/nihilanth.mdl") = monster_nihilanth : "Nihilanth" []

@PointClass base(Monster) size(-480 -480 -112, 480 480 24) studio("models/osprey.mdl") = monster_osprey : "Osprey"
[
spawnflags(Flags) =
[
64 : "Start Inactive" : 0
]

// If Random grunttype is set, osprey will look for NORMAL grunts.
// Mapper can override number of grunts if desired, instead.

grunttype(Choices) : "Grunt Type" : 0 =
[
0 : "Human Grunts (default)"
1 : "Opposing Force Grunts"

// Human Grunts and Opposing Force grunts will drop
2 : "Random"

// HWGrunt will have a small chance of appearing if set
3 : "Random + HWGrunt"

// HWGrunt and Sniper will have a small chance of appearing if set
4 : "Random + HWGrunt/Sniper"
]

num(integer) : "(Override) Number of Grunts" : 0
]

@PointClass base(Monster, TalkMonster) size(-16 -16 0, 16 16 72) studio("models/otis.mdl") = monster_otis : "Otis"
[
bodystate(Choices) : "bodystate" : -1 =
[
-1 : "Random"
0 : "Gun Holstered"
1 : "Gun Drawn"
3 : "Donut"
]
head(Choices) : "head" : -1 =
[
-1 : "Random"
0 : "Bald Head"
1 : "Head with hair"
]
sequence(Choices) : "Animation Sequence (editor)" : 0 =
[
0 : "idle1"
19 : "locked_door"
21 : "barn_Wave"
22 : "beat_grunt"
23 : "beat_gruntidle"
24 : "flashlight"
41 : "cprbarney"
42 : "cprbarneyrevive"
43 : "barney_dragvent"
44 : "dying_barney"
45 : "dying_barneyidle"
46 : "dying_friend"
47 : "dying_friendidle"
48 : "c1a3_bidle"
49 : "intropush"
50 : "fence"
51 : "wave"
52 : "unlatch"
53 : "retina"
54 : "relaxstand"
55 : "trackswitch"
56 : "pepsiswing"
57 : "pepsipush"
58 : "buttonpush"
59 : "cowering"
60 : "candygrab"
]
]

@PointClass base(RenderFields, Appearflags, Angles) size(-16 -16 0, 16 16 72) studio("models/otis.mdl") = monster_otis_dead : "Dead Otis"
[
pose(Choices) : "Pose" : 0 =
[
0 : "On back"
1 : "On side"
2 : "On stomach"
3 : "Stuffed in Vent"
4 : "Dead Sitting"
]
sequence(Choices) : "Animation Sequence (editor)" : 35 =
[
35 : "lying_on_back"
36 : "lying_on_side"
37 : "lying_on_stomach"
38 : "stuffed_in_vent"
39 : "dead_sitting"
]
model(studio) : "Custom Model"
]

@PointClass base(Monster) size(-24 -24 0, 24 24 32) studio("models/pit_drone.mdl") = monster_pitdrone : "Pit Drone"
[
spawnflags(Flags) =
[
32 : "SquadLeader" : 0
]
netname(string) : "Squad Name"
initammo(string) : "Initial Ammo" : "6"
]

@PointClass base(Monster) size(-6 -6 0, 6 6 6) studio("models/bigrat.mdl") = monster_rat : "Rat" []

@PointClass base(Monster) size(-16 -16 0, 16 16 72) studio("models/rgrunt.mdl") = monster_robogrunt : "Robot Grunt"
[
spawnflags(Flags) =
[
32 : "SquadLeader" : 0
]
netname(string) : "Squad Name"
weapons(Choices) : "Weapons" : 1 =
[
1 : "MP5"
3 : "MP5 + HG"
5 : "M16 + GL"
8 : "Shotgun"
10 : "Shotgun + HG"
]
]

@PointClass base(Monster) size(-16 -16 0, 16 16 72) studio("models/rgrunt.mdl") = monster_robogrunt_repel : "Robot Grunt"
[
weapons(Choices) : "Weapons" : 1 =
[
1 : "MP5"
3 : "MP5 + HG"
5 : "M16 + GL"
8 : "Shotgun"
10 : "Shotgun + HG"
]
sequence(Choices) : "Animation Sequence (editor)" : 48 =
[
48 : "repel_repel"
]
]

@PointClass base(Weapon, Targetx, RenderFields) studio("models/w_satchel.mdl") = monster_satchel : "Live Satchel Charge" []

@PointClass base(Monster, TalkMonster) size(-16 -16 0, 16 16 72) studio("models/scientist.mdl") = monster_scientist : "Scared Scientist"
[
body(Choices) : "Body" : -1 =
[
-1 : "Random"
0 : "Glasses"
1 : "Einstein"
2 : "Luther"
3 : "Slick"
]
sequence(Choices) : "Animation Sequence (editor)" : 13 =
[
13 : "idle1"
27 : "eye_wipe"
28 : "pull_needle"
29 : "return_needle"
30 : "give_shot"
37 : "lying_on_back"
38 : "lying_on_stomach"
39 : "dead_sitting"
40 : "dead_table1"
41 : "dead_table2"
42 : "dead_table3"
47 : "console"
48 : "checktie"
49 : "dryhands"
50 : "tieshoe"
51 : "whiteboard"
52 : "studycart"
53 : "lean"
54 : "pondering"
55 : "pondering2"
56 : "pondering3"
57 : "buysoda"
61 : "push_button"
62 : "converse1"
63 : "converse2"
64 : "retina"
65 : "talkleft"
66 : "talkright"
67 : "deskidle"
68 : "coffee"
69 : "franticbutton"
71 : "sitlookleft"
72 : "sitlookright"
73 : "sitscared"
74 : "sitting2"
75 : "sitting3"
76 : "cprscientist"
77 : "cprscientistrevive"
78 : "cowering_in_corner"
79 : "sstruggleidle"
80 : "sstruggle"
81 : "headcrabbed"
82 : "c1a0_catwalkidle"
83 : "c1a0_catwalk"
84 : "ceiling_dangle"
85 : "ventpull1"
86 : "ventpull2"
87 : "ventpullidle1"
88 : "ventpullidle2"
89 : "sitidle"
90 : "sitstand"
91 : "keypad"
93 : "lookwindow"
94 : "wave"
95 : "pulldoor"
96 : "beatdoor"
97 : "fallingloop"
98 : "crawlwindow"
99 : "divewindow"
100 : "locked_door"
101 : "push_button2"
102 : "unlock_door"
104 : "handrailidle"
105 : "handrail"
106 : "hanging_idle"
107 : "fall"
108 : "scientist_get_pulled"
109 : "hanging_idle2"
110 : "fall_elevator"
111 : "scientist_idlewall"
112 : "ickyjump_sci"
113 : "haulscientist"
114 : "c1a4_wounded_idle"
115 : "c1a4_dying_speech"
116 : "tentacle_grab"
117 : "helicack"
118 : "windive"
119 : "scicrashidle"
120 : "scicrash"
121 : "onguard"
122 : "seeya"
123 : "rocketcrawl"
124 : "portal"
125 : "gluonshow"
127 : "kneel"
]
]

@PointClass base(Appearflags, RenderFields, Angles) size(-16 -16 0, 16 16 72) studio("models/scientist.mdl") = monster_scientist_dead : "Dead Scientist"
[
body(Choices) : "Body" : -1 =
[
-1 : "Random"
0 : "Glasses"
1 : "Einstein"
2 : "Luther"
3 : "Slick"
]
pose(Choices) : "Pose" : 0 =
[
0 : "On back"
1 : "On Stomach"
2 : "Sitting"
3 : "Hanging"
4 : "Table1"
5 : "Table2"
6 : "Table3"
]
sequence(Choices) : "Animation Sequence (editor)" : 37 =
[
37 : "lying_on_back"
38 : "lying_on_stomach"
39 : "dead_sitting"
40 : "dead_table1"
41 : "dead_table2"
42 : "dead_table3"
]
model(studio) : "Custom Model"
]

@PointClass base(Monster) size(-16 -16 0, 16 16 72) studio("models/sentry.mdl") = monster_sentry : "Sentry Turret Gun"
[
spawnflags(Flags) =
[
32 : "Autostart" : 0
64 : "Start Inactive" : 0
]
attackrange(integer) : "Max Attack Range" : 1200
]

@PointClass base(Monster) size(-16 -16 0, 16 16 36) studio("models/w_shock.mdl") = monster_shockroach : "Shock Roach" []

@PointClass base(Monster) size(-24 -24 0, 24 24 32) studio("models/strooper.mdl") = monster_shocktrooper : "Shock Trooper"
[
netname(string) : "Squad Name"
spawnflags(Flags) =
[
32 : "SquadLeader" : 0
1024: "No Shockroach" : 0
]
]

@PointClass base(Monster, TalkMonster) size(-14 -14 22, 14 14 72) studio("models/scientist.mdl") = monster_sitting_scientist : "Sitting Scientist"
[
body(Choices) : "Body" : -1 =
[
-1 : "Random"
0 : "Glasses"
1 : "Einstein"
2 : "Luther"
3 : "Slick"
]
sequence(Choices) : "Animation Sequence (editor)" : 73 =
[
71 : "sitlookleft"
72 : "sitlookright"
73 : "sitscared"
74 : "sitting2"
75 : "sitting3"
]
]

@PointClass base(Monster) size(-16 -16 0, 16 16 36) studio("models/w_squeak.mdl") = monster_snark : "Armed Snark" []

@PointClass base(Monster) size(-16 -16 0, 16 16 36) studio("models/w_sqknest.mdl") = monster_sqknest : "Snark Nest" []

@PointClass base(Monster) size(-24 -24 0, 24 24 24) studio("models/stukabat.mdl") = monster_stukabat : "Stukabat" []

@PointClass base(Monster) size(-32 -32 0, 32 32 64) studio("models/tentacle2.mdl") = monster_tentacle : "Tentacle Arm"
[
sweeparc(integer) : "Sweep Arc" : 130
sound(Choices) : "Tap Sound" : -1 =
[
-1 : "None"
0 : "Silo"
1 : "Dirt"
2 : "Water"
]
]

@PointClass base(Monster) size(-16 -16 0, 16 16 72) studio("models/hgrunt_torchf.mdl") = monster_torch_ally_repel : "Human Torch Ally (Repel)"
[
netname(string) : "Squad Name"
spawnflags(Flags) =
[
32 : "SquadLeader" : 0
]
weapons(Choices) : "Weapons" : 1 =
[
1 : "Desert Eagle"
2 : "Blow Torch"
]
sequence(Choices) : "Animation Sequence (editor)" : 39 =
[
39 : "repel_repel"
]
]

@PointClass base(Monster) studio("models/vhe-models/w_tripmine_hammer.mdl") = monster_tripmine : "Active Tripmine"
[
spawnflags(Flags) =
[
1 : "Instant On" : 1
]
]

@PointClass base(Monster) size(-32 -32 -32, 32 32 32) studio("models/turret.mdl") = monster_turret : "Auto Turret"
[
orientation(Choices) : "Orientation" : 0 =
[
0 : "Floor Mount"
1 : "Ceiling Mount"
]
spawnflags(Flags) =
[
32 : "Autostart" : 0
64 : "Start Inactive" : 0
]
maxsleep(string) : "Search Time (before deactivate)" : "15"
turnrate(integer) : "Turn Rate" : 30
attackrange(integer) : "Max Attack Range" : 1200
]

@PointClass base(Monster) size(-16 -16 0, 16 16 72) studio("models/zombie.mdl") = monster_zombie : "Scientist Zombie"
[
sequence(Choices) : "Animation Sequence (editor)" : 0 =
[
0 : "idle1"
19 : "getup"
20 : "pause"
21 : "busting_through_wall"
22 : "kick_punch_wall"
23 : "bust_window"
24 : "soda"
25 : "slideidle"
26 : "slidewall"
27 : "ventclimbidle"
28 : "ventclimb"
29 : "deadidle"
30 : "deadwall"
31 : "freakdie"
32 : "freak"
33 : "eatbodytable"
34 : "eatbody"
35 : "eatbodystand"
36 : "ripdoor"
37 : "zombie_pull_scientist"
38 : "zombie_eating"
39 : "eat_to_stand"
40 : "vent_zidle"
41 : "vent_c1a3"
42 : "haulzombie"
43 : "c2a3_snack_getup"
44 : "zombie_fight"
45 : "crush"
48 : "crushed"
46 : "spazhard"
47 : "spaz"
49 : "compthrow_idle"
50 : "compthrow"
51 : "iceslip"
52 : "get_run_over"
]
]

@PointClass base(Monster) size(-16 -16 0, 16 16 72) studio("models/zombie_barney.mdl") = monster_zombie_barney : "Barney Zombie" []

@PointClass base(Monster) size(-16 -16 0, 16 16 72) studio("models/zombie_soldier.mdl") = monster_zombie_soldier : "Soldier Zombie" []

@PointClass base(Targetname, Angles) size(-16 -16 0, 16 16 72) color(245 128 96) = monstermaker : "Monster Maker"
[
target(string) : "Target On Release"
monstertype(string) : "Monster Type"
netname(string) : "Childrens' Name"
spawnflags(Flags) =
[
1 : "Start ON" : 0
//2 : "PVS On/Off" : 0
4 : "Cyclic" : 0
8 : "MonsterClip" : 0
1024 : "No Respawn (Collectible)" : 0
]

// How many monsters the monstermaker can create (-1 = unlimited)
monstercount(integer) : "Monster count " : -1

respawn_as_playerally(choices) : "Make Player Allys" : 0 =
[
0 : "Default (0)"
1 : "Opposite (1)"
]

// If delay is -1, new monster will be made when last monster dies,
// else, delay is the delay in seconds between spawns.
delay(string) : "Frequency" : "5"

// Maximum number of live children allowed at one time. (New ones will not be made until one dies) -1 means no limit.
m_imaxlivechildren(integer) : "Max live children" : 5

health(integer) : "Custom Health" : 0
path_name(string) : "Path Name" //The name of the path_waypoint, path_condition, or path_condition_controller this monster will look to.

]

@PointClass base(Targetname) color(255 128 0) = multi_manager : "MultiTarget Manager"
[
spawnflags(Flags) =
[
1 : "multithreaded" : 0
]
]

@PointClass base(Targetname, Target) color(168 255 168) = multisource : "Multisource"
[
globalstate(string) : "Global State Master"
]

@PointClass base(Targetname, AttackObject) studio("models/mortar.mdl") = op4mortar : "Op4 Mortar"
[
spawnflags(Flags) =
[
1 : "Active" : 0
16 : "Line of Sight" : 1
32 : "Can Control" : 1
]

mortar_velocity(integer) : "Velocity" : 800
h_min(integer) : "Horiz MIN" : -90
h_max(integer) : "Horiz MAX" : 90
mindist(integer) : "Min Target Dist" : 256
maxdist(integer) : "Max Target Dist" : 2048
firedelay(integer) : "Delay between shots (seconds)" : 5

is_player_ally(Choices) : "Is Player Ally" : 0 =
[
0 : "No (Default)"
1 : "Yes"
]
]

@PointClass base(Targetname, Angles) size(16 16 16) color(247 181 82) = path_corner : "Moving platform stop"
[
spawnflags(Flags) =
[
1: "Wait for retrigger" : 0
2: "Teleport to this" : 0
4: "Fire once" : 0
8: "Random targets" : 0
]
target(target_destination) : "Next stop target"
message(target_destination) : "Fire On Arrive"
wait(integer) : "Wait here (secs)" : 0
speed(integer) : "New Train Speed" : 0
yaw_speed(integer) : "New Train rot. Speed" : 0
]

//Processes and selects a path_condition for the NPC. Allows for multiple path_conditions to be used for a single NPC.
@PointClass base(Targetname) color(145 255 145) = path_condition_controller : "NPC Path Condition Controller"
[
spawnflags(Flags) =
[
1 : "Start Off" : 0 // If checked, this controller starts in-active and can not be used until triggered.
]

pathcondition_list(string) : "Path_condition List" //Comma separated list of path_condition names (Required).

selecttype(Choices) : "Selection Mode" : 0 =
[
0 : "First Found (Default)" // The first path_condition found (highest priority and active) will be picked.
1 : "Random" // Any path_condition entities that [share the same priority level] and are [active] will be evaluated together and randomly chosen.
2 : "Nearest to NPC" // The nearest path_condition found (to the NPC) will be picked. Distance based on path_waypoint to the NPC.
]
]

//Processes and selects a path_waypoint for the NPC or path_condition_controller.
@PointClass base(Targetname) color(225 148 32) = path_condition : "NPC Path Condition"
[
spawnflags(Flags) =
[
1 : "Start Off" : 0 // If checked, this path_condition starts in-active and can not be used until triggered with USE_ON or USE_TOGGLE.
]

delay_interval(string) : "Delay Interval" : "0.1" //Default time between checks. Minimum is 0.1.

conditions_reference(string) : "Conditions (Definition Name)"

mindistance(integer) : "Min Distance" : 0 // 0 = infinite. If not within specified range, path_condition isn't evaluated.
maxdistance(integer) : "Max Distance" : 0 // 0 = infinite. If not within specified range, path_condition isn't evaluated.

starttrigger(string) : "Trigger on Stop Condition" //Thing to trigger upon start

priority(integer) : "Priority Level" : 0 // 0 would be the default priority, followed by 1, 2, 3, etc. Higher numbers take precedence over lower numbers.
selecttype(Choices) : "Priority Override" : 0 =
[
0 : "None (Default)"
1 : "Ignore Following"
2 : "Ignore Following and Guarding"
3 : "Ignore Following, Guarding, and Scripts"
]

pre_location(Choices) : "Pre-Waypoint Destination" : 0 =
[
0 : "None (Default)" // Don't use a pre-waypoint destination, go to the first path_waypoint.
1 : "Use This Origin" // Use path_condition's origin.
2 : "Enemy"
3 : "Dead Enemy"
4 : "Sound"
5 : "Scent"
6 : "Near Hiding Spot" //Compute a nearby hiding spot, run to it.
7 : "Far Hiding Spot" //Compute a distant hiding spot, run to it.
8 : "Named Entity" // Origin of a specific entity
9 : "Entity by Key:Value"
]

pre_location_values(string) : "Pre-Waypoint Parameters"
// 1 : "Use This Origin" No options.
// 2 : "Enemy" No options.
// 3 : "Dead Enemy" No options.
// 4 : "Sound" Type sound-filter. E.g. (SOUND_DANGER)
// 5 : "Scent" Type scent-filter. E.g. (SCENT_FOOD OR SCENT_CARCASS)
// 6 : "Near Hiding Spot" Type minimum distance.
// 7 : "Far Hiding Spot" Type maximum distance.
// 8 : "Named Entity" Type entity name.
// 9 : "Entity by Key:Value" Type in format: "keyname:keyvalue", optional: Use ( parentheses ), ==, >, >=, <, <=, AND, OR operators.

//When this path_condition is picked, a waypoint must be picked to start the NPC off on. Select how the waypoint is picked.
selecttype(Choices) : "Waypoint Selection" : 0 =
[
0 : "Start Waypoint" // NOTE: The nearest waypoint will be selected if a starting waypoint is not specified when this option is selected.
1 : "Nearest Waypoint to NPC" //The nearest group found (to the NPC) will be picked.
2 : "Random Waypoint"
]

path_start(string) : "Start Waypoint" //Leave blank for none.
waypoint_list(string) : "Path_Waypoint List" //Required if not using Starting Waypoint for selection.
key_filter(string) : "NPC Keyvalue Filter" //Type in format: "$keyname > 1 AND $keyname == 1", optional: Use ( parentheses ), ==, >, >=, <, <=, AND, OR operators.
npc_trigger_target(string) : "NPC Trigger Target" //NPC will trigger this entity when on this path
npc_trigger_interval(integer) : "NPC Trigger Interval" //NPC will trigger every N seconds
m_szASConditionsName(string) : "Angelscript condition name" //Name of the Angelscript condition that was registered by a map script
]

@PointClass base(Targetname) color(125 255 255) = path_waypoint : "NPC Path Waypoint"
[
target(target_destination) : "Next Path_waypoint"
alternate_target(target_destination) : "Alternate Next Path_waypoint" //Alternate Waypoint to use if we're toggled to use our alternate.

movementtype(Choices) : "Move to Position" : 0 = // How the monster will move to this waypoint.
[
0 : "Walk"
1 : "Run"
2 : "Teleport"
3 : "Turn to Face"
4 : "Don't Move"
]

radius(integer) : "Move within Radius" : 0 // When in radius, the NPC has finished moving to the waypoint. Only works for Walk / Run.

useangles(choices) : "Face Waypoint Direction" : 0 = //Yes = Upon arrival, the NPC's YAW will change gradually to match the path_waypoint's YAW
[
0 : "No (default)"
1 : "Yes"
]

trigger_on_arrival(target_destination) : "Trigger on Arrival" // Target to fire before starting the arrival animation.
arrival_animation(string) : "Arrival Animation" // Animation to play on arrival.
trigger_after_arrival(target_destination) : "Trigger after Arrival Animation" // Target to fire upon completing the arrival animation. If no arrival animation, fired after Trigger on Reach is fired.

wait_activity(Choices) : "Wait Activity" : 0 =
[
0 : "Play Wait Animation (default)"
1 : "Look around"
2 : "Investigate Area"
3 : "Use AI" //Let the NPC's AI take over while waiting.
]

wait_animation(string) : "Wait Animation" // Animation to play when waiting at this waypoint. (Looped) If animation is blank, the monster will stand in place. If wait time is zero, this is not used.
wait_time(integer) : "Wait Time" : 0 // After the position is reached, the monster must wait this long before moving to the next waypoint, and before any targets are fired.
wait_master(string) : "Wait Master" // Master entity to analyze - the multisource which, when activated, lets the path_waypoint know it can let the NPC continue.

waituntilfull(choices) : "Wait Here Until Full" : 0 = // Force NPC to wait until this waypoint is full before proceeding to the next waypoint. If Maximum Occupants is 0, a level error message will occur.
[
0 : "No (default)"
1 : "Yes"
]

departure_animation(string) : "Departure Animation" // Animation to play before leaving waypoint. Target On Pass is fired after animation completes if animation is present.
trigger_on_departure(target_destination) : "Trigger on Departure" // Target to fire when the NPC finishes the Departure Animation. If no Departure Animation, fired immediately after waiting.

//--------------------------------------------------------------------------------------------------
// START OVERFLOW
//--------------------------------------------------------------------------------------------------
occupant_radius_check(integer) : "Occupant Radius" : 0 // If an NPC is within the radius of this path_waypoint, it takes up an occupant slot.
occupant_limit(integer) : "Maximum # Occupants" : 0 // This point only accepts X number of NPCs at a time.
// If this waypoint is full, monsters will go to the following waypoint specified instead.
// If the provided overflow point is removed or not available, the NPC will remain at the previous waypoint or position until room is available.
overflow_waypoint(string) : "Overflow Waypoint"
//--------------------------------------------------------------------------------------------------
// END OVERFLOW
//--------------------------------------------------------------------------------------------------

// Forces the NPC to finish this particular path_waypoint even if a higher priority path is found, provided that the stop conditions are not met.
// NOTE: This disables path_condition / path_condition_controller evaluation during the extent of the trip and departure.
force_complete(Choices) : "Force Waypoint Completion" : 0 =
[
0 : "No (default)"
1 : "Yes"
]

//If this path_waypoint releases the NPC because of a stop condition, (e.g. a new enemy appears) something can be triggered.
stop_trigger(string) : "Trigger on Stop Condition"
restart_delay(integer) : "Delay before Return" : 0 //If the NPC has stopped moving because of a stop condition (E.g. hearing a gunshot), the NPC will wait this long before continuing back to this path_waypoint.
]

@PointClass base(Targetname, Angles) size(16 16 16) color(255 148 0) = path_track : "Train Track Path"
[
spawnflags(Flags) =
[
1: "Disabled" : 0
2: "Fire once" : 0
4: "Branch Reverse" : 0
8: "Disable train" : 0
]
target(target_destination) : "Next stop target"
message(target_destination) : "Fire On Pass"
altpath(target_destination) : "Branch Path"
netname(target_destination) : "Fire on dead end"
newspeed(integer) : "New Train Speed" : -1
maxspeed(integer) : "New Maximum Speed" : -1
speed(integer) : "New Train Speed (Legacy)" : 0
]

@PointClass base(Targetname) size(-16 -16 -16, 16 16 16) = player_loadsaved : "Load Auto-Saved game"
[
duration(string) : "Fade Duration (seconds)" : "2"
holdtime(string) : "Hold Fade (seconds)" : "0"
renderamt(integer) : "Fade Alpha" : 255
rendercolor(color255) : "Fade Color (R G B)" : "0 0 0"
messagetime(string) : "Show Message delay" : "0"
message(string) : "Message To Display" : ""
loadtime(string) : "Reload delay" : "0"
]

@PointClass base(Targetname) size(-16 -16 -16, 16 16 16) color(96 32 128) = player_weaponstrip : "Strips player's weapons"
[
spawnflags(Flags) =
[
1 : "Strip Suit" : 0
2 : "Strip Long Jump" : 0
]
m_iAffected(choices) : "Players to strip from" : 0 =
[
0 : "Activator only (default)"
1 : "All players"
2 : "All players except activator"
]
weapons_list(string) : "Weapons list to strip (none = all)" : ""
weapons_list_mode(choices) : "Weapons list mode" : 0 =
[
0 : "Inclusive (strip listed)"
1 : "Exclusive (strip NOT listed)"
]
]

@SolidClass base(Targetname, ZHLTbmodel) = player_respawn_zone : "Player Zone Respawn brush"
[
zonetype(choices) : "Zone Type" : 0 =
[
0: "Respawn all outside"
1: "Respawn all inside"
]
]

@PointClass base(Targetname, Targetx) size(-16 -16 0, 16 16 72) color(255 0 200) = scripted_sentence : "Scripted Sentence"
[
spawnflags(Flags) =
[
1 : "Fire Once" : 1
2 : "Followers Only" : 0
4 : "Interrupt Speech" : 1
8 : "Concurrent" : 0
]
sentence(string) : "Sentence Name" : ""
entity(string) : "Speaker Type"
duration(string) : "Sentence Time" : "3"
radius(integer) : "Search Radius" : 512
refire(string) : "Delay Before Refire" : "3"
listener(string) : "Listener Type"
volume(string) : "Volume 0-10" : "10"
attenuation(Choices) : "Sound Radius" : 0 =
[
0 : "Small Radius (~384)"
1 : "Medium Radius (~768)"
2 : "Large Radius (~1536)"
3 : "Play Everywhere"
]
]

@PointClass base(Targetname, Targetx, Angles) size(-16 -16 0, 16 16 72) color(164 128 255) = scripted_sequence : "Scripted Sequence"
[
m_iszEntity(string) : "Target Monster"
m_iszPlay(string) : "Action Animation" : ""
m_iszIdle(string) : "Idle Animation" : ""
m_flRadius(integer) : "Search Radius" : 512
m_flRepeat(integer) : "Repeat Rate ms" : 0
m_fMoveTo(choices) : "Move to Position" : 0 =
[
0 : "No"
1 : "Walk"
2 : "Run"
4 : "Instantaneous"
5 : "No - Turn to Face"
]
moveto_radius(integer) : "Move to Radius" : 0
spawnflags(Flags) =
[
4 : "Repeatable" : 0
8 : "Leave Corpse" : 0
32: "No Interruptions" : 0
64: "Override AI" : 0
128: "No Script Movement" : 0
256: "No Reset Entity" : 0
]
]

@PointClass iconsprite("sprites/vhe-iconsprites/speaker.spr") base(Targetname) color(225 200 210) = speaker : "Announcement Speaker"
[
preset(choices) : "Announcement Presets" : 0 =
[
0: "None"
1: "C1A0 Announcer"
2: "C1A1 Announcer"
3: "C1A2 Announcer"
4: "C1A3 Announcer"
5: "C1A4 Announcer"
6: "C2A1 Announcer"
7: "C2A2 Announcer"
//8: "C2A3 Announcer"
9: "C2A4 Announcer"
//10: "C2A5 Announcer"
11: "C3A1 Announcer"
12: "C3A2 Announcer"
]
message(string) : "Sentence Group Name"
health(integer) : "Volume (10 = loudest)" : 5
spawnflags(flags) =
[
1: "Start Silent" : 0
]
]

@PointClass base(Targetname, Angles, RenderFields, AttackObject, NotRevivable) size(-16 -16 0, 16 16 72) color(245 128 96) = squadmaker : "Squad Maker"
[
spawnflags(Flags) =
[
1 : "Start ON" : 0
//2 : "PVS On/Off" : 0
4 : "Cyclic" : 0
8 : "MonsterClip" : 0
16 : "Prisoner" : 0
32 : "Auto Size BBox" : 0
64 : "Cyclic Backlog" : 0
128 : "WaitForScript" : 0
1024 : "No Respawn (Collectible)" : 0
]

target(string) : "Target On Release"
monstertype(string) : "Monster Type"
netname(string) : "Childrens' Name"

// How many monsters the monstermaker can create (-1 = unlimited)
monstercount(integer) : "Monster count " : -1

// If delay is -1, new monster will be made when last monster dies.
// Else, delay is how often (seconds) a new monster will be spawned.
delay(string) : "Delay between spawns" : "5"

// Maximum number of live children allowed at one time. (New ones will not be made until one dies)
// -1 no limit
m_imaxlivechildren(integer) : "Max live children" : 5

spawn_mode(Choices) : "Blocked Spawn Handling" : 0 =
[
0 : "Legacy, no special handling"
1 : "Block, spawn as soon as clear"
2 : "Force spawn, never block"
]

dmg(integer) : "Amount of Telefrag Damage" : 0

trigger_target(String) : "TriggerTarget"
trigger_condition(Choices) : "Trigger Condition" : 0 =
[
0 : "No Trigger"
1 : "See Player, Mad at Player"
2 : "Take Damage"
3 : "50% Health Remaining"
4 : "Death"
7 : "Hear World"
8 : "Hear Player"
9 : "Hear Combat"
10: "See Player Unconditional"
11: "See Player, Not In Combat"
]
new_body(integer) : "Body (-1 off)" : -1
new_skin(integer) : "Skin (-1 off)" : -1

new_solid(Choices) : "Solid State" : -1 =
[
-1 : "Don't Modify"
0 : "Not Solid - SOLID_NOT"
1 : "Trigger - SOLID_TRIGGER"
2 : "Bounding Box - SOLID_BBOX"
3 : "Slide Box - SOLID_SLIDEBOX"
4 : "BSP Model - SOLID_BSP"
]

respawn_as_playerally(choices) : "Is Player Ally" : 0 =
[
0 : "Default (0)"
1 : "Opposite (1)"
]

change_rendermode(Choices) : "Override Render Mode" : 0 =
[
0 : "No"
1 : "Yes"
]

xenmaker(String) : "Xenmaker Template Name"

gag(Choices) : "Gag" : -1 =
[
-1 : "Default"
0 : "No"
1 : "Yes"
]

weapons(Choices) : "Weapons (Grunt/Massn/etc)" : 0 =
[
0 : "Default / No setting"
1 : "MP5"
3 : "MP5 + HG"
5 : "M16 + GL"
8 : "Shotgun / Sniper Rifle"
10 : "Shotgun / Sniper Rifle + HG"
16 : "SAW (human_grunt_ally only!)"
32 : "No Weapons (male_assassin only!)"
64 : "Rocket Launcher"
66 : "Rocket Launcher + HG"
128 : "Sniper Rifle (human_grunt only!)"
130 : "Sniper Rifle + HG (human_grunt only!)"
256 : "Don't drop weapon (HWG etc)"
]

squadname(String) : "Squad Name" : ""
is_squad_leader(Choices) : "Squad Leader" : 0 =
[
0 : "No"
1 : "Yes"
]

displayname(string) : "In-game Name" : ""
bloodcolor(choices) : "Blood Color" : 0 =
[
0 : "Monster Default"
-1 : "No Blood"
1 : "Red"
2 : "Yellow"
]
health(integer) : "Custom Health" : 0
new_model(studio) : "Custom Model" : ""
minhullsize(string) : "Custom Min Hull Size (X Y Z)" : "0 0 0"
maxhullsize(string) : "Custom Max Hull Size (X Y Z)" : "0 0 0"

soundlist(string) : "Sound Replacement File"
freeroam(Choices) : "Monster Roaming (nodes)" : 0 =
[
0 : "Map Default"
1 : "Never"
2 : "Always"
]

path_name(string) : "Path Name" // The name of the path_waypoint, path_condition, or path_condition_controller this monster will look to.

// This will make the monster follow/protect whoever is specified
guard_ent(string): "Entity to Guard" : ""

wpn_v_model(String) : "V_model (Weapons Only)" : ""
wpn_w_model(String) : "W_model (Weapons Only)" : ""
wpn_p_model(String) : "P_model (Weapons Only)" : ""

function_name(string) : "Angelscript function name" //Angelscript function to call on creation of a monster. Format: void FunctionName(MonsterEntity@ pSquadmaker, Entity@ pMonster)
]

@PointClass base(Targetname) color(255 240 128) = target_cdaudio : "CD Audio Target"
[
health(choices) : "Track #" : -1 =
[
-1 : "Stop"
1 : "Track 1"
2 : "Track 2"
3 : "Track 3"
4 : "Track 4"
5 : "Track 5"
6 : "Track 6"
7 : "Track 7"
8 : "Track 8"
9 : "Track 9"
10 : "Track 10"
11 : "Track 11"
12 : "Track 12"
13 : "Track 13"
14 : "Track 14"
15 : "Track 15"
16 : "Track 16"
17 : "Track 17"
18 : "Track 18"
19 : "Track 19"
20 : "Track 20"
21 : "Track 21"
22 : "Track 22"
23 : "Track 23"
24 : "Track 24"
25 : "Track 25"
26 : "Track 26"
27 : "Track 27"
28 : "Track 28"
29 : "Track 29"
30 : "Track 30"
]
// radius(string) : "Player Radius"
]

@PointClass base(Targetx) color(250 10 165) = trigger_auto : "AutoTrigger"
[
spawnflags(Flags) =
[
1 : "Remove On fire" : 1
]
globalstate(string) : "Global State to Read"
triggerstate(choices) : "Trigger State" : 2 =
[
0 : "Off"
1 : "On"
2 : "Toggle"
]
]

@PointClass base(Targetx, Targetname, Angles) studio("models/vhe-models/trigger_camera.mdl") color(200 255 255) = trigger_camera : "Trigger Camera"
[
wait(integer) : "Hold time" : 10
moveto(string) : "Path Corner"
spawnflags(flags) =
[
1: "Start At Player" : 1
2: "Follow Player" : 1
4: "Freeze Player" : 0
8: "All Players" : 0
16: "Force View" : 0
32: "No Instant Turn" : 0
64: "Instant Move" : 0
128: "Mouse Cursor" : 0
256: "Player Invulnerable" : 0
512: "Ignore Hold Time" : 0
]
speed(string) : "Initial Speed" : "0"
acceleration(string) : "Acceleration units/sec^2" : "500"
deceleration(string) : "Stop Deceleration units/sec^2" : "500"
turnspeed(string) : "Camera Rotation Speed" : "40"

mouse_action_0_0(choices) : "Left Click Action" : 0 =
[
0 : "No Action"
1 : "Trigger Off"
2 : "Trigger On"
3 : "Trigger Toggle"
4 : "Remove"
5 : "Hurt"
6 : "Heal"
7 : "Spawn"
8 : "Teleport"
9 : "Teleport Away"
10 : "Create Explosion"
11 : "Drag"
255 : "Exit Camera (Non-forced only)"
]
mouse_param_0_0(string) : "Left Click Param"
mouse_block_drag_0_0(choices) : "Left Click Block Drag Repeating Action" : 0 =
[
0 : "No"
1 : "Yes"
]

mouse_action_1_0(choices) : "Right Click Action" : 0 =
[
0 : "No Action"
1 : "Trigger Off"
2 : "Trigger On"
3 : "Trigger Toggle"
4 : "Remove"
5 : "Hurt"
6 : "Heal"
7 : "Spawn"
8 : "Teleport"
9 : "Teleport Away"
10 : "Create Explosion"
11 : "Drag"
255 : "Exit Camera (Non-forced only)"
]
mouse_param_1_0(string) : "Right Click Param"
mouse_block_drag_1_0(choices) : "Right Click Block Drag Repeating Action" : 0 =
[
0 : "No"
1 : "Yes"
]

mouse_action_2_0(choices) : "Third Click Action" : 0 =
[
0 : "No Action"
1 : "Trigger Off"
2 : "Trigger On"
3 : "Trigger Toggle"
4 : "Remove"
5 : "Hurt"
6 : "Heal"
7 : "Spawn"
8 : "Teleport"
9 : "Teleport Away"
10 : "Create Explosion"
11 : "Drag"
255 : "Exit Camera (Non-forced only)"
]
mouse_param_2_0(string) : "Third Click Param"
mouse_block_drag_2_0(choices) : "Third Click Block Drag Repeating Action" : 0 =
[
0 : "No"
1 : "Yes"
]

mouse_action_0_1(choices) : "Left Double Click Action" : 0 =
[
0 : "No Action"
1 : "Trigger Off"
2 : "Trigger On"
3 : "Trigger Toggle"
4 : "Remove"
5 : "Hurt"
6 : "Heal"
7 : "Spawn"
8 : "Teleport"
9 : "Teleport Away"
10 : "Create Explosion"
11 : "Drag"
255 : "Exit Camera (Non-forced only)"
]
mouse_param_0_1(string) : "Left Double Click Param"
mouse_block_drag_0_1(choices) : "Left Double Click Block Drag Repeating Action" : 0 =
[
0 : "No"
1 : "Yes"
]

mouse_action_1_1(choices) : "Right Double Click Action" : 0 =
[
0 : "No Action"
1 : "Trigger Off"
2 : "Trigger On"
3 : "Trigger Toggle"
4 : "Remove"
5 : "Hurt"
6 : "Heal"
7 : "Spawn"
8 : "Teleport"
9 : "Teleport Away"
10 : "Create Explosion"
11 : "Drag"
255 : "Exit Camera (Non-forced only)"
]
mouse_param_1_1(string) : "Right Double Click Param"
mouse_block_drag_1_1(choices) : "Right Double Click Block Drag Repeating Action" : 0 =
[
0 : "No"
1 : "Yes"
]

mouse_action_2_1(choices) : "Third Double Click Action" : 0 =
[
0 : "No Action"
1 : "Trigger Off"
2 : "Trigger On"
3 : "Trigger Toggle"
4 : "Remove"
5 : "Hurt"
6 : "Heal"
7 : "Spawn"
8 : "Teleport"
9 : "Teleport Away"
10 : "Create Explosion"
11 : "Drag"
255 : "Exit Camera (Non-forced only)"
]
mouse_param_2_1(string) : "Third Double Click Param"
mouse_block_drag_2_1(choices) : "Third Double Click Block Drag Repeating Action" : 0 =
[
0 : "No"
1 : "Yes"
]

mouse_digital_action_reset(string) : "Mouse Digital Action Reset Time" : "0"

// Signature for AS callback method is: bool YourMouseEventCallbackName(CBaseEntity@ pCamera, CBaseEntity@ pPlayer, CBaseEntity@ pEntity, int mouseEvent, int mouseEventParam, float screenX, float screenY, Vector mousePosition, Vector clickDirection, Vector clickPlaneNormal, float scale)
// pCamera - the camera entity calling this method
// pPlayer - the player who created the mouse event
// pEntity - the entity "hit" by the cursor (if any)
// mouseEvent - one of:
// MOUSE_RELEASED = 0;
// MOUSE_PRESSED = 1;
// MOUSE_DOUBLE_PRESSED = 2;
// MOUSE_DRAGGED = 3;
// MOUSE_POS_CHANGED = 4;
// MOUSE_WHEEL_SCROLLED = 5;
// mouseEventParam - depends on the event:
// if event is MOUSE_WHEEL_SCROLLED, mouseEventParam is the scrollDelta (usually: 1, 2, 3 or -1, -2, -3)
// if event is any other, mouseEventParam is one of:
// MOUSE_BUTTON_LEFT = 0;
// MOUSE_BUTTON_RIGHT = 1;
// MOUSE_BUTTON_MIDDLE = 2;
// screenX - x coordinate of the mouse cursor on screen (from -1 to 1)
// screenY - y coordinate of the mouse cursor on screen (from -1 to 1)
// mousePosition - the position of the mouse cursor in world coordinates
// clickDirection - the direction from the camera origin to the cursor "hit" point, basically: (camera->origin - mousePosition).Normalize()
// clickPlaneNormal - the normal vector of the surface that was hit by the mouse cursor
// scale - if clicked through a portal with scale, this is the final scale (useful for scaling explosions or other visual/physical effects caused by the mouse event), usually this will be 1.0
m_iszASMouseEventCallbackName(string) : "AS Mouse Event Callback Name"

// Signature for AS callback method is: void YourKeyInputCallbackName(CBaseEntity@ pCamera, CBasePlayer@ pPlayer, bool down, KeyCode keycode)
// pCamera - the camera entity calling this method
// pPlayer - the player who created the key input
// down - true if key is pressed, false if key is released
// keycode - identifier of a keyboard key (see https://github.com/ValveSoftware/halflife/blob/master/utils/vgui/include/VGUI_KeyCode.h)
m_iszASKeyInputCallbackName(string) : "AS Key Input Callback Name"

// Sets a player's target name when they use the camera, unsets it, when they stop using it
m_iszOverridePlayerTargetname(string) : "Set Player Targetname"

// Targets to trigger when a player starts or stops using a camera
m_iszTargetWhenPlayerStartsUsing(string) : "Target when player starts using"
m_iszTargetWhenPlayerStopsUsing(string) : "Target when player stops using"

// Target to fire when the camera is turned off (either through trigger or because time ran out)
m_iszTurnedOffTarget(string) : "Target when turned off"

max_player_count(integer) : "Max Players" : 1
max_player_target(string) : "Target: Player tried to use, but Max Players reached"

hud_health(choices) : "HUD: Health and Battery" : 0 =
[
0 : "Show Health and Battery"
1 : "Hide Health and Battery"
]
hud_flashlight(choices) : "HUD: Flashlight" : 0 =
[
0 : "Show Flashlight"
1 : "Hide Flashlight"
]
hud_weapons(choices) : "HUD: Weapons" : 0 =
[
0 : "Show Weapons"
1 : "Hide Weapons"
]
cursor_sprite(sprite) : "Custom Cursor (Sprite)"
]

@SolidClass base(Targetname, ZHLTbmodel) = trigger_cameratarget : "Camera Target"
[
spawnflags(flags) =
[
1: "Invisible" : 0
2: "Start Off" : 0
]

mouse_action_0_0(choices) : "Left Click Action" : 0 =
[
0 : "No Action"
1 : "Trigger Off"
2 : "Trigger On"
3 : "Trigger Toggle"
4 : "Remove"
5 : "Hurt"
6 : "Heal"
]
mouse_param_0_0(string) : "Left Click Param"
mouse_block_drag_0_0(choices) : "Left Click Block Drag Repeating Action" : 0 =
[
0 : "No"
1 : "Yes"
]
mouse_target_0_0(string) : "Left Click Target"

mouse_action_1_0(choices) : "Right Click Action" : 0 =
[
0 : "No Action"
1 : "Trigger Off"
2 : "Trigger On"
3 : "Trigger Toggle"
4 : "Remove"
5 : "Hurt"
6 : "Heal"
]
mouse_param_1_0(string) : "Right Click Param"
mouse_block_drag_1_0(choices) : "Right Click Block Drag Repeating Action" : 0 =
[
0 : "No"
1 : "Yes"
]
mouse_target_1_0(string) : "Right Click Target"

mouse_action_2_0(choices) : "Third Click Action" : 0 =
[
0 : "No Action"
1 : "Trigger Off"
2 : "Trigger On"
3 : "Trigger Toggle"
4 : "Remove"
5 : "Hurt"
6 : "Heal"
]
mouse_param_2_0(string) : "Third Click Param"
mouse_block_drag_2_0(choices) : "Third Click Block Drag Repeating Action" : 0 =
[
0 : "No"
1 : "Yes"
]
mouse_target_2_0(string) : "Third Click Target"

mouse_action_0_1(choices) : "Left Double Click Action" : 0 =
[
0 : "No Action"
1 : "Trigger Off"
2 : "Trigger On"
3 : "Trigger Toggle"
4 : "Remove"
5 : "Hurt"
6 : "Heal"
]
mouse_param_0_1(string) : "Left Double Click Param"
mouse_block_drag_0_1(choices) : "Left Double Click Block Drag Repeating Action" : 0 =
[
0 : "No"
1 : "Yes"
]
mouse_target_0_1(string) : "Left Double Click Target"

mouse_action_1_1(choices) : "Right Double Click Action" : 0 =
[
0 : "No Action"
1 : "Trigger Off"
2 : "Trigger On"
3 : "Trigger Toggle"
4 : "Remove"
5 : "Hurt"
6 : "Heal"
]
mouse_param_1_1(string) : "Right Double Click Param"
mouse_block_drag_1_1(choices) : "Right Double Click Block Drag Repeating Action" : 0 =
[
0 : "No"
1 : "Yes"
]
mouse_target_1_1(string) : "Right Double Click Target"

mouse_action_2_1(choices) : "Third Double Click Action" : 0 =
[
0 : "No Action"
1 : "Trigger Off"
2 : "Trigger On"
3 : "Trigger Toggle"
4 : "Remove"
5 : "Hurt"
6 : "Heal"
]
mouse_param_2_1(string) : "Third Double Click Param"
mouse_block_drag_2_1(choices) : "Third Double Click Block Drag Repeating Action" : 0 =
[
0 : "No"
1 : "Yes"
]
mouse_target_2_1(string) : "Third Double Click Target"

mouse_digital_action_reset(string) : "Mouse Digital Action Reset Time" : "0"
]

@SolidClass base(Targetname, ZHLTbmodel) = trigger_cdaudio : "Trigger CD Audio"
[
health(choices) : "Track #" : -1 =
[
-1 : "Stop"
1 : "Track 1"
2 : "Track 2"
3 : "Track 3"
4 : "Track 4"
5 : "Track 5"
6 : "Track 6"
7 : "Track 7"
8 : "Track 8"
9 : "Track 9"
10 : "Track 10"
11 : "Track 11"
12 : "Track 12"
13 : "Track 13"
14 : "Track 14"
15 : "Track 15"
16 : "Track 16"
17 : "Track 17"
18 : "Track 18"
19 : "Track 19"
20 : "Track 20"
21 : "Track 21"
22 : "Track 22"
23 : "Track 23"
24 : "Track 24"
25 : "Track 25"
26 : "Track 26"
27 : "Track 27"
28 : "Track 28"
29 : "Track 29"
30 : "Track 30"
]
]

@PointClass base(Targetname, Target, AttackObject) color(128 96 2) = trigger_change_class : "Trigger Change Class" []

@SolidClass base(Targetname, InventoryRules, ZHLTbmodel) = trigger_changelevel : "Trigger Change level"
[
spawnflags(flags) =
[
2: "USE Only" : 0
4: "No CVAR override" : 0
]
map(string) : "New map name"
master(string) : "Master"
keep_inventory(choices) : "Players take inventory to new map" : 1 =
[
0 : "No"
1 : "Yes"
]
percent_of_players(string) : "Percentage of players needed" : "0"
]

@PointClass base(Targetname) color(100 100 200) = trigger_changemaxammo : "Trigger Change Max Ammo"
[
target(target_destination) : "Trigger after fire"
spawnflags(flags) =
[
1 : "All players" : 0
2 : "Remove excess ammo" : 0
4 : "Set ammo to new max" : 0
]

message(choices) : "Ammo name" : "9mm" =
[
"9mm" : "9mm Rounds"
"bolts" : "Crossbow Bolts"
"357" : ".357 Rounds"
"uranium" : "Uranium Ammo"
"Hand Grenade" : "Hand Grenades"
"Hornets" : "Hornets"
"556" : "5.56 Rounds"
"ARgrenades" : "AR Grenades"
"health" : "Health (Medkit Ammo)"
"rockets" : "Rockets"
"Satchel Charge" : "Satchel Charges"
"shock charges" : "Shock Rifle Ammo"
"buckshot" : "Shotgun Ammo"
"m40a1" : "Sniper Rifle Ammo"
"sporeclip" : "Spore Launcher Ammo"
"Snarks" : "Snarks"
"Trip Mine" : "Trip Mines"
]

m_iMaxAmmo(integer) : "Value to use" : 100
m_Mode(choices) : "Change Max Ammo Mode" : 0 =
[
0 : "Set"
1 : "Reset"
2 : "Add"
3 : "Subtract"
]
]

@PointClass base(Targetname, Target) color(140 0 130) = trigger_changemodel : "Trigger Change Model"
[
model(studio) : "New Model Name" : ""
skin(integer) : "Skin" : 0
bodygroup(integer) : "Body Group" : 0
]

@PointClass base(Targetname, Target) color(60 155 30) = trigger_changetarget : "Trigger Change Target"
[
m_iszNewTarget(string) : "New Target"
]

@PointClass base(Targetname) color(160 192 255) = trigger_changesky : "Trigger Change Sky"
[
skyname(string) : "Sky Name"
color(color255) : "Color"
spawnflags(flags) =
[
1 : "All players" : 0
2 : "No clients" : 0
4 : "Update server" : 0
]
]

// Change any entity keyvalue during runtime, allows set, basic arithmetic operations and bitwise logical operations (useful for flags)
@PointClass base(Targetname) color(90 215 60) = trigger_changevalue : "Trigger Change Value"
[
spawnflags(Flags) =
[

// For Vectors:
1 : "Don't use X" : 0
2 : "Don't use Y" : 0
4 : "Don't use Z" : 0

32 : "Invert target value" : 0
64 : "Invert source value" : 0

]
target(target_destination) : "Destination entity"
m_iszValueName(string) : "Destination key"
m_iszNewValue(string) : "Source value"
m_iszValueType(choices) : "Action" : 0 =
[
0 : "Replace (= source)"
1 : "Add (= old + source)"
2 : "Mul (= old * source)"
3 : "Sub (= old - source)"
4 : "Div (= old / source)"
16 : "Pow (= old ^ source)"
12 : "Mod (= old % source)"
5 : "AND (= old & source)"
6 : "OR (= old | source)"
13 : "XOR (= old ^ source)"
7 : "NAND (= !(old & source))"
8 : "NOR (= !(old | source))"
14 : "NXOR (= !(old ^ source))"
11 : "Append (String concatenation)"
17 : "Sin (= sin(source))"
18 : "Cos (= cos(source))"
19 : "Tan (= tan(source))"
23 : "Cot (= cot(source))"
20 : "Arcsin (= arcsin(source))"
21 : "Arccos (= arccos(source))"
22 : "Arctan (= arctan(source))"
24 : "Arccot (= arccot(source))"
]
m_trigonometricBehaviour(choices) : "Trigonometric funcs. I/O" : 0 =
[
0 : "Degrees in (out for arc.)"
1 : "Radian measure in (out for arc.)"
]
m_iAppendSpaces(integer) : "Append spaces (for strings)" : 0
message(target_destination) : "Trigger after action"
]

// Copy value of one entity to another value of another entity
@PointClass base(Targetname) color(60 90 215) = trigger_copyvalue : "Trigger Copy Value"
[
spawnflags(Flags) =
[
// For vectors
1 : "Don't use X" : 0
2 : "Don't use Y" : 0
4 : "Don't use Z" : 0

8 : "Constant" : 0

// Only when "Constant" is on
16 : "Start On" : 0

32 : "Invert target value" : 0
64 : "Invert source value" : 0
128 : "Multiple destinations" : 0
]
netname(target_destination) : "Source entity"
m_iszSrcValueName(string) : "Source key"
target(target_destination) : "Destination entity"
m_iszDstValueName(string) : "Destination key"
m_iszValueType(choices) : "Action" : 0 =
[
0 : "Replace (= source)"
1 : "Add (= old + source)"
2 : "Mul (= old * source)"
3 : "Sub (= old - source)"
4 : "Div (= old / source)"
16 : "Pow (= old ^ source)"
12 : "Mod (= old % source)"
5 : "AND (= old & source)"
6 : "OR (= old | source)"
13 : "XOR (= old ^ source)"
7 : "NAND (= !(old & source))"
8 : "NOR (= !(old | source))"
14 : "NXOR (= !(old ^ source))"
9 : "Direction to Angles"
10 : "Angles to Direction"
11 : "Append (String concatenation)"
17 : "Sin (= sin(source))"
18 : "Cos (= cos(source))"
19 : "Tan (= tan(source))"
23 : "Cot (= cot(source))"
20 : "Arcsin (= arcsin(source))"
21 : "Arccos (= arccos(source))"
22 : "Arctan (= arctan(source))"
24 : "Arccot (= arccot(source))"
]
m_iFloatConversion(choices) : "Float-to-string/-int conversion" : 0 =
[
0 : "6 decimal places (Default)"
1 : "5 d. p., rounded to 5 d. p."
4 : "4 d. p., rounded to 4 d. p."
7 : "3 d. p., rounded to 3 d. p."
10 : "2 d. p., rounded to 2 d. p."
13 : "1 d. p., rounded to 1 d. p."
16 : "Integer, rounded"
17 : "Integer, rounded up"
18 : "Integer, rounded down"
]
m_trigonometricBehaviour(choices) : "Trigonometric funcs. I/O" : 0 =
[
0 : "Degrees in (out for arc.)"
1 : "Radian measure in (out for arc.)"
]
m_iAppendSpaces(integer) : "Append spaces (for strings)" : 0
message(target_destination) : "Trigger after action"
dmg(string) : "Copy-interval (seconds)" : "0.0"
]

// Checks values of entities and triggers if true or false
@PointClass base(Targetname) color(120 180 10) = trigger_condition : "Trigger Condition"
[
spawnflags(Flags) =
[
1 : "Start Off" : 0

// For vectors
2 : "Don't use X (R)" : 0
4 : "Don't use Y (G)" : 0
8 : "Don't use Z (B)" : 0
16 : "Don't use W (A)" : 0

// Check once when fired - do not toggle
32 : "Cyclic; no toggle" : 0

// Forward original activator instead of overwriting it with the trigger_condition's entity id.
// Not done by default, as time that passes till condition is true and trigger_condition fires,
// activator may no longer exist and unwanted behaviour may be exhibited if it is used anyway.
// Hence, you have to explicitly set the forwarding of the activator with this flag in order to
// use it in entities targeted by trigger_condition. Caller is always forwarded.
64 : "Keep '!activator'" : 0

128 : "Ignore initial result" : 0
]
target(target_destination) : "Monitored entity"
m_iszValueName(string) : "Monitored key"
m_iszSourceName(target_destination) : "Compare-entity"
m_iszSourceKey(string) : "Compare-key"
m_iszCheckValue(string) : "Compare-value (alternative)"
m_iCheckType(choices) : "Comparator; mon. val. -> comp.-val." : 0 =
[
// Ent keyvalue equals mappers value
0 : "== (Equal)"

// Ent keyvalue does not equal mappers value
1 : "!= (Not equal)"

// Ent keyvalue is smaller than mappers value
2 : "< (Less)"

// Ent keyvalue is greater than mappers value
3 : "> (Greater)"

// Ent keyvalue is less than or equal to mappers value
4 : "<= (Less or equal)"

// Ent keyvalue is greater than or equal to mappers value
5 : ">= (Greater or equal)"

// (Ent keyvalue & mappers value) does not equal 0 (Flag check)
6 : "& (Logical AND)"
]

netname(string) : "Target for 'true'-case"
message(string) : "Target for 'false'-case"

m_iCheckBehaviour(choices) : "Constant mode trigger behaviour" : 0 =
[
0 : "Fire true/false alternatingly"
1 : "Only wait after false"
2 : "Only wait after true"
3 : "Always fire for both"
]

// 0.0 means to check every frame
m_fCheckInterval(string) : "Check-interval (seconds)" : "0.1"
]

@SolidClass base(Trigger, Targetname, ZHLTbmodel) color(238 240 238) = trigger_counter : "Trigger Counter"
[
spawnflags(flags) =
[
1 : "No Message" : 0
]
master(string) : "Master"
count(integer) : "Count before activation" : 2
]

@PointClass base(Targetname, Targetx) color(255 2 0) = trigger_createentity : "Create Entity"
[
m_iszCrtEntChildClass(string) : "Child Classname"
m_iszCrtEntChildName(string) : "Child Targetname"
]

@PointClass base(Targetname, Target) size(-8 -8 -8, 8 8 8) color(100 100 128) = trigger_cyclicobserver : "Controls observer cyclic mode"
[
m_Mode(choices) : "Mode to use" : 0 =
[
0: "Off"
1: "On"
2: "Toggle"
]
]

@PointClass base(Targetname, Target) color(60 90 215) = trigger_effect : "Trigger Effect"
[
spawnflags(flags) =
[
1 : "Start on" : 0
]

effect_glow_mode(choices) : "Glow shell mode" : 0 =
[
0 : "No change"
1 : "Add"
2 : "Subtract"
]
effect_glow(color255) : "Glow shell color (R G B)" : "0 0 0"

effect_block_weapons_mode(choices) : "Block weapons" : 0 =
[
0 : "No change"
1 : "Add"
2 : "Subtract"
]

effect_invulnerable_mode(choices) : "Invulnerable" : 0 =
[
0 : "No change"
1 : "Add"
2 : "Subtract"
]

effect_invisible_mode(choices) : "Invisible" : 0 =
[
0 : "No change"
1 : "Add"
2 : "Subtract"
]

effect_nonsolid_mode(choices) : "Non-solid" : 0 =
[
0 : "No change"
1 : "Add"
2 : "Subtract"
]

effect_respiration_mode(choices) : "Time before drown mode" : 0 =
[
0 : "No change"
1 : "Add"
2 : "Subtract"
]
effect_respiration(string) : "Time before drown (seconds)" : "0.0"

effect_friction_mode(choices) : "Friction modifier mode" : 0 =
[
0 : "No change"
1 : "Add"
2 : "Subtract"
]
effect_friction(string) : "Friction modifier (%)" : "0.0"

effect_gravity_mode(choices) : "Gravity modifier mode" : 0 =
[
0 : "No change"
1 : "Add"
2 : "Subtract"
]
effect_gravity(string) : "Gravity modifier (%)" : "0.0"

effect_speed_mode(choices) : "Speed modifier mode" : 0 =
[
0 : "No change"
1 : "Add"
2 : "Subtract"
]
effect_speed(string) : "Speed modifier (%)" : "0.0"

effect_damage_mode(choices) : "Damage modifier mode" : 0 =
[
0 : "No change"
1 : "Add"
2 : "Subtract"
]
effect_damage(string) : "Damage modifier (%)" : "0.0"
]

@PointClass base(Targetname) size(-12 -12 -12, 12 12 12) color(255 255 0) = trigger_entity_iterator : "Entity Iterator"
[
name_filter(target_destination) : "Filter Entities by Name"
classname_filter(string) : "Filter Entities by Classname"
status_filter(choices) : "Filter Entities by Status" : 0 =
[
0 : "No Filter (default)"
1 : "Only Living Entities"
2 : "Only Dead Entities"
]
delay_between_triggers(string) : "Delay between Entities (secs)" : "0.0"
target(target_destination) : "Entity's Trigger Target"
triggerstate(choices) : "Entity's Trigger State" : 2 =
[
0 : "Off"
1 : "On"
2 : "Toggle"
]
run_mode(choices) : "Run Mode" : 0 =
[
0 : "Run Once"
1 : "Run Once; Multi-threaded"
2 : "Toggle On/Off"
]
trigger_after_run(target_destination) : "Trigger at end of each Run"
maximum_runs(integer) : "Maximum Runs (0 for unlimited)" : 0
delay_between_runs(string) : "Delay before Restarting (secs)" : "0.5"
]

@SolidClass base(Trigger) = trigger_gravity : "Trigger Gravity"
[
gravity(integer) : "Gravity (0-1)" : 1
]

@SolidClass base(Targetname, Target, InventoryRules, ZHLTbmodel) = trigger_hurt : "Trigger Hurt"
[
spawnflags(flags) =
[
1: "Target Once" : 0
2: "Start Off" : 0
8: "No clients" : 0
16: "FireClientOnly" : 0
32: "TouchClientOnly" : 0
64: "Affect non-moving NPC's": 0
]
master(string) : "Master"
dmg(integer) : "Damage" : 10
delay(string) : "Delay before trigger" : "0"
damagetype(choices) : "Damage Type" : 0 =
[
0 : "GENERIC"
1 : "CRUSH"
2 : "BULLET"
4 : "SLASH"
8 : "BURN"
16 : "FREEZE"
32 : "FALL"
64 : "BLAST"
128 : "CLUB"
256 : "SHOCK"
512 : "SONIC"
1024 : "ENERGYBEAM"
16384 : "DROWN"
32768 : "PARALYSE"
65536 : "NERVEGAS"
131072 : "POISON"
262144 : "RADIATION"
524288 : "DROWNRECOVER"
1048576 : "CHEMICAL"
2097152 : "SLOWBURN"
4194304 : "SLOWFREEZE"
]
]

@PointClass base(Targetname, Target) = trigger_hurt_remote : "Trigger Hurt (non-touch)"
[
spawnflags(Flags) =
[
1 : "Instant Kill" : 0
2 : "Constant" : 0
4 : "Start On" : 0
8 : "Do Armor" : 0
]
targetclass(string) : "Target Class" : ""
dmg(integer) : "Damage" : 10
armordmg(integer) : "Armor Damage" : 0
delay(string) : "Delay (Only when Constant)" : "1"
damagetype(choices) : "Damage Type" : 0 =
[
0 : "GENERIC"
1 : "CRUSH"
2 : "BULLET"
4 : "SLASH"
8 : "BURN"
16 : "FREEZE"
32 : "FALL"
64 : "BLAST"
128 : "CLUB"
256 : "SHOCK"
512 : "SONIC"
1024 : "ENERGYBEAM"
16384 : "DROWN"
32768 : "PARALYSE"
65536 : "NERVEGAS"
131072 : "POISON"
262144 : "RADIATION"
524288 : "DROWNRECOVER"
1048576 : "CHEMICAL"
2097152 : "SLOWBURN"
4194304 : "SLOWFREEZE"
]
]

@PointClass base(Targetname) = trigger_load : "Custom Load Data"
[
m_iszLevelName(string) : "Alternate Level Save File"
netname(string) : "Label to read from"
target(string) : "Destination Entity"
message(string) : "Destination Keyvalue"
m_iszTrigger(String) : "Trigger after loading"
]

@PointClass base(Targetname, Angles) = trigger_lookat : "Forces one Ent to look at another Ent"
[
spawnflags(Flags) =
[
1 : "Start On" : 0
2 : "Set Once" : 0
]
target(string) : "Target"
message(string) : "Entity to look at"
]

@SolidClass base(Angles, ZHLTbmodel) = trigger_monsterjump : "Trigger monster jump"
[
master(string) : "Master"
speed(integer) : "Jump Speed" : 40
height(integer) : "Jump Height" : 128
]

@SolidClass base(Trigger) = trigger_multiple : "Trigger: Activate multiple"
[
wait(integer) : "Delay before reset" : 10
]

@PointClass base(Targetname) size(-16 -16 -16, 16 16 16) color(0 0 200) = trigger_numericdisplay : "Numeric Display"
[
spawnflags(flags) =
[
1 : "Start On" : 0
2 : "Cyclic" : 0
4 : "Ignore leading zeroes" : 0
8 : "Zero as leading" : 0
]

target(target_destination) : "Entity to track"
netname(string) : "Key to read"
message(string) : "Base digit name" //Digit names are base_digit_name%u, where %u is 1-10
frags(string) : "Update delay" : "0.1" //Delay, in seconds, between digit updates
]

@SolidClass base(Trigger) = trigger_once : "Trigger: Activate once" []

@SolidClass base(Trigger, Angles) = trigger_push : "Trigger push"
[
spawnflags(flags) =
[
1: "Once Only" : 0
2: "Start Off" : 0
8: "No Clients" : 0
16: "No Monsters" : 0
64: "Force push (deprecated, see 'Mode of push')" : 0
]
speed(integer) : "Speed of push" : 40
pushmode(choices) : "Mode of push" : 0 =
[
0 : "Regular (base velocity)"
1 : "Forced (minimum velocity)"
2 : "Forced (exact velocity)"
]
]

@BaseClass base(Targetname) = BaseRandom
[
target_count(integer) : "Target Count" : 4
target1(target_destination) : "Target 1"
target2(target_destination) : "Target 2"
target3(target_destination) : "Target 3"
target4(target_destination) : "Target 4"
target5(target_destination) : "Target 5"
target6(target_destination) : "Target 6"
target7(target_destination) : "Target 7"
target8(target_destination) : "Target 8"
target9(target_destination) : "Target 9"
target10(target_destination) : "Target 10"
target11(target_destination) : "Target 11"
target12(target_destination) : "Target 12"
target13(target_destination) : "Target 13"
target14(target_destination) : "Target 14"
target15(target_destination) : "Target 15"
target16(target_destination) : "Target 16"
]

@PointClass base(BaseRandom) color(255 230 150) = trigger_random : "Trigger Random"
[
spawnflags(Flags) =
[
1 : "Start On (Timed only)" : 0
2 : "Trigger Once (Timed only)" : 0
4 : "Reusable (Unique only)" : 0
8 : "Timed" : 0
16 : "Unique" : 0
]

min_delay(string) : "Minimum Delay (0 = off)" : "3.0"
max_delay(string) : "Maximum Delay (0 = off)" : "7.0"
]

//Obsolete: use trigger_random with Timed flag
@PointClass base(trigger_random) color(135 205 255) = trigger_random_time : "Trigger Random Time"
[
]

//Obsolete: use trigger_ranom with Random flag
// Unique Trigger Random. Randomly selects an unused trigger.
@PointClass base(BaseRandom) color(225 170 70) = trigger_random_unique : "Trigger Random Unique"
[
spawnflags(Flags) =
[
1 : "Re-usable" : 0
]
]

@PointClass base(Targetname, Targetx) color(165 30 165) = trigger_relay : "Trigger Relay"
[
spawnflags(flags) =
[
1: "Remove On fire" : 0

// Forward original activator instead of overwriting it with the trigger_relay's entity id.
// Not done by default, as time that passes till relay is true and trigger_relay fires,
// activator may no longer exist and unwanted behaviour may be exhibited if it is used anyway.
// Hence, you have to explicitly set the forwarding of the activator with this flag in order to
// use it in entities targeted by trigger_relay.
64 : "Keep '!activator'" : 0
]
triggerstate(choices) : "Trigger State" : 2 =
[
0: "Off"
1: "On"
// Set and Toggle are actually the wrong way around numerically, keeping as is for BC
3: "Set"
2: "Toggle"
4: "Kill"
]
triggervalue(string) : "Trigger Value (a number for Set state)" : ""

m_flDelayBeforeReset(string) : "Delay Before Reset" : "0"
]

// Giving mappers the ability to set the triggering player's targetname
@PointClass base(Targetname) color(192 255 128) = trigger_renameplayer : "Trigger Player Target"
[
spawnflags(Flags) =
[
// If set, trigger_playertarget won't remove itself after being used.
1 : "Reusable" : 0
]
netname(String) : "New Player Targetname"
]

// Respawn all players without affecting the current player status, like health and weapons
@PointClass base(Targetname, Target) size(-16 -16 -16, 16 16 16) color(255 64 2) = trigger_respawn : "Trigger Respawn"
[
spawnflags(Flags) =
[
// Respawn target entity instead of all players.
1 : "Respawn Target" : 0
2 : "Respawn dead players" : 0
4 : "Don't move living players" : 0
]
]

@PointClass base(Targetname) = trigger_save : "Custom Save Data"
[
netname(string) : "Label to store in"
target(string) : "Source Entity"
message(string) : "Source Keyvalue"
m_iszTrigger(String) : "Trigger after saving"
]

@PointClass base(Targetname, Targetx) = trigger_script : "Loads a script and executes a script function on trigger"
[
m_iszScriptFile(string) : "Script to load"
m_iszScriptFunctionName(string) : "Function to execute on trigger"
m_flThinkDelta(string) : "Time between thinks"
m_iMode(choices) : "Mode" : 1 =
[
1 : "Trigger"
2 : "Think"
]

spawnflags(flags) =
[
1 : "Start on" : 0
2 : "Self '!activator' (trigger mode)" : 0
4 : "Self '!caller' (trigger mode)" : 0
64 : "Keep '!activator' (think mode)" : 0
]
]

@PointClass base(Targetname) color(40 200 150) = trigger_setcvar : "Sets a CVAR"
[
//spawnflags(Flags) =
//[
// 1 : "Set silently" : 0 // Unimplemented!
//]
m_iszCVarToChange(choices) : "CVAR (only these are allowed)" : "mp_allowmonsterinfo" =
[
"mp_allowmonsterinfo": "mp_allowmonsterinfo"
"mp_allowplayerinfo": "mp_allowplayerinfo"
"mp_ammo_droprules": "mp_ammo_droprules"
"mp_ammo_respawndelay": "mp_ammo_respawndelay"
"mp_banana": "mp_banana"
"mp_barnacle_paralyze": "mp_barnacle_paralyze"
"mp_disable_autoclimb": "mp_disable_autoclimb"
"mp_disable_medkit_points": "mp_disable_medkit_points"
"mp_disable_pcbalancing": "mp_disable_pcbalancing"
"mp_disable_player_rappel": "mp_disable_player_rappel"
"mp_disablegaussjump": "mp_disablegaussjump"
"mp_dropweapons": "mp_dropweapons"
"mp_falldamage": "mp_falldamage"
"mp_flashlight": "mp_flashlight"
"mp_footsteps": "mp_footsteps"
"mp_forcerespawn": "mp_forcerespawn"
"mp_fraglimit": "mp_fraglimit"
"mp_grapple_mode": "mp_grapple_mode"
"mp_hevsuit_voice": "mp_hevsuit_voice"
"mp_item_respawndelay": "mp_item_respawndelay"
"mp_monsterpoints": "mp_monsterpoints"
"mp_multiplespawn": "mp_multiplespawn"
"mp_no_akimbo_uzis": "mp_no_akimbo_uzis"
"mp_noblastgibs": "mp_noblastgibs"
"mp_nomedkit": "mp_nomedkit"
"mp_npckill": "mp_npckill"
"mp_observer_cyclic": "mp_observer_cyclic"
"mp_observer_mode": "mp_observer_mode"
"mp_pcbalancing_factorlist": "mp_pcbalancing_factorlist"
"mp_respawndelay": "mp_respawndelay"
"mp_suitpower": "mp_suitpower"
"mp_survival_nextmap": "mp_survival_nextmap"
"mp_survival_startdelay": "mp_survival_startdelay"
"mp_survival_starton": "mp_survival_starton"
"mp_survival_supported": "mp_survival_supported"
"mp_survival_voteallow": "mp_survival_voteallow"
"mp_telefrag": "mp_telefrag"
"mp_timelimit": "mp_timelimit"
"mp_weapon_droprules": "mp_weapon_droprules"
"mp_weapon_respawndelay": "mp_weapon_respawndelay"
"mp_weaponstay": "mp_weaponstay"
"npc_dropweapons": "npc_dropweapons"
"skill": "skill"
"sk_": "sk_* (see skill.cfg)"
"sv_accelerate": "sv_accelerate"
"sv_ai_enemy_detection_mode": "sv_ai_enemy_detection_mode"
"sv_airaccelerate": "sv_airaccelerate"
"sv_friction": "sv_friction"
"sv_gravity": "sv_gravity"
"sv_maxspeed": "sv_maxspeed"
"sv_maxvelocity": "sv_maxvelocity"
"sv_wateraccelerate": "sv_wateraccelerate"
"sv_waterfriction": "sv_waterfriction"
]
message(string) : "New Value"
netname(target_destination) : "Trigger after set"
SetType(choices) : "Which CVARs to set" : 0 =
[
0 : "All"
1 : "Engine"
2 : "Angelscript"
]
]

// Set the origin of an entity dynamically
@PointClass base(Targetname, Target) color(64 255 96) size(-8 -8 -8, 8 8 8) = trigger_setorigin : "Trigger Set Origin"
[
spawnflags(flags) =
[
// Will constantly update position if set.
1: "Constant" : 0

// Trigger_setorigin entity will be removed after firing.
4: "Set Once" : 0

// Save the offset between the Target entity and the Copy pointer, apply offset when updating the Target entity's position
// Requires "Constant" flag
8: "Lock Offsets" : 0

16: "Copy X Angle" : 0
32: "Copy Y Angle" : 0
64: "Copy Z Angle" : 0

128: "Copy X Axis" : 1
256: "Copy Y Axis" : 1
512: "Copy Z Axis" : 1

// If you're using the Constant flag, check this box to NOT move the origin of the entity or set the angles initially.
// If you're not using the Constant flag, make sure this isn't enabled or trigger_setorigin won't do anything.
//
// This allows the "Constant" + "offset difference" combination to work as intended from the entity's original location.
//
// You would leave this off if you needed to move the entity to an initial position before having it follow another entity.
// (If this isn't set, trigger_setorigin will move the entity to it's copypointer's origin before doing the offset difference calculation)
1024: "Skip Initial Set" : 0
]

//The entity we wish to copy coordinates/angles from
copypointer(string) : "Copy Pointer"

//Manual Offset to copied coordinates
offset(string) : "Position Offset (X Y Z)" : "0 0 0"

//Applied once on first use
//After first use - Applied if "constant" flag is checked, and for each "Copy [x, y, z] Angle" checked.
angleoffset(string) : "Angle Offset (X Y Z)" : "0 0 0"

invert_x(choices) : "Invert X Angle" : 0 =
[
0 : "No"
1 : "Yes"
]
invert_y(choices) : "Invert Y Angle" : 0 =
[
0 : "No"
1 : "Yes"
]
invert_z(choices) : "Invert Z Angle" : 0 =
[
0 : "No"
1 : "Yes"
]
]

@SolidClass base(Trigger) = trigger_teleport : "Trigger Teleport"
[
spawnflags(flags) =
[
64: "Random Destination" : 0
128: "Relative Teleport" : 0
256: "Keep Angles" : 0
512: "Keep velocity" : 0
1024: "Rotate (Dest Angles)" : 0

// Hammer will not save a spawn flag beyond 2048... (and 2048 is engine reserved)
// 4096: "Start Inactive" : 0
// 8192: "Ignore Delays" : 0
// Their respective properties below will add the flag when the entity is created instead
]
teleport_cooldown(string) : "Teleport Cooldown Delay" : "1"
teleport_ignore_delay(choices) : "Ignore Delays" : 0 =
[
0 : "No"
1 : "Yes"
]
teleport_start_inactive(choices) : "Start Inactive" : 0 =
[
0 : "No"
1 : "Yes"
]

teleport_if_blocked(choices) : "Teleport If Blocked" : 0 =
[
0 : "No"
1 : "Yes"
]
]

@PointClass base(Targetname, Target) color(255 220 28) = trigger_track_goal : "Trigger Track Goal"
[
spawnflags(Flags) =
[
// Only functions if train is not moving.
1 : "Stopped Only" : 0
2 : "Don't move if no path available" : 0
]

// Where the train wants to stop at.
path_name(string) : "Path Name"
m_iszSoundNoPath(sound) : "Sound to play if no path is available"
]

// Gives mapper ability to start custom votes
@PointClass base(Targetname) color(32 138 255) = trigger_vote : "Trigger Vote"
[
message(String) : "Vote Message"
frags(integer) : "Time To Vote (Seconds)" : 90
health(integer) : "Percentage needed" : 50
target(String) : "Yes Target"
netname(String) : "No Target"
noise(String) : "No Vote Target"
m_iszYesString(string) : "Yes string (optional)"
m_iszNoString(string) : "No string (optional)"
]

@PointClass base(Weapon, Targetx, ExclusiveHold) studio("models/w_357.mdl") = weapon_357 : "357 Handgun" []

@PointClass base(Weapon, Targetx, ExclusiveHold) studio("models/w_9mmAR.mdl") = weapon_9mmAR : "9mm Assault Rifle" []

@PointClass base(Weapon, Targetx, ExclusiveHold) studio("models/w_9mmhandgun.mdl") = weapon_9mmhandgun : "9mm Handgun" []

@PointClass base(Weapon, Targetx, ExclusiveHold) studio("models/w_crossbow.mdl") = weapon_crossbow : "Crossbow"
[
sequence(choices) : "Placement" : 0 =
[
0 : "Normal (flat)"
1 : "Realistic (tilted)"
]
]

@PointClass base(Weapon, Targetx, ExclusiveHold) studio("models/w_crowbar.mdl") = weapon_crowbar : "Crowbar" []

@PointClass base(Weapon, Targetx, ExclusiveHold) studio("models/w_displacer.mdl") = weapon_displacer : "Displacer"
[
spawnflags(flags) =
[
64: "Random Destination" : 0
128: "Rotate (Dest Angles)" : 0
256: "Keep Angles" : 0
512: "Keep velocity" : 0
4096 : "Ignore delay" : 0
]

m_TertiaryMode(choices) : "Tertiary fire mode" : 0 =
[
0 : "Default (weaponmode_displacer)"
1 : "Disable"
2 : "Enable"
]

m_flPortalSpeed(string) : "Portal Speed"
m_flPortalRadius(string) : "Portal Radius"
m_iszTeleportDestination(target_destination) : "Teleport destination"

m_flPrimaryAmmoNeeded(string) : "Ammo needed/used to fire primary"
m_flSecondaryAmmoNeeded(string) : "Ammo needed/used to fire secondary"
m_flTertiaryAmmoNeeded(string) : "Ammo needed/used to fire tertiary"
]

@PointClass base(Weapon, Targetx, ExclusiveHold) studio("models/w_desert_eagle.mdl") = weapon_eagle : "Desert Eagle" []

@PointClass base(Weapon, Targetx, ExclusiveHold) studio("models/w_egon.mdl") = weapon_egon : "Egon Gun" []

@PointClass base(Weapon, Targetx, ExclusiveHold) studio("models/w_gauss.mdl") = weapon_gauss : "Gauss Gun" []

@PointClass base(Weapon, Targetx, ExclusiveHold) studio("models/w_bgrap.mdl") = weapon_grapple : "Barnacle Grapple" []

@PointClass base(Weapon, Targetx, ExclusiveHold) studio("models/w_grenade.mdl") = weapon_handgrenade : "Hand Grenade" []

@PointClass base(Weapon, Targetx, ExclusiveHold) studio("models/w_hgun.mdl") = weapon_hornetgun : "Hornet Gun" []

@PointClass base(Weapon, Targetx, ExclusiveHold) studio("models/w_m16.mdl") = weapon_m16 : "M16" []

@PointClass base(Weapon, Targetx, ExclusiveHold) studio("models/w_saw.mdl") = weapon_m249 : "M249 SAW" []

@PointClass base(Weapon, Targetx, ExclusiveHold) studio("models/w_pmedkit.mdl") = weapon_medkit : "Medkit" []

@PointClass base(Weapon, Targetx) studio("models/w_minigun.mdl") = weapon_minigun : "Minigun" []

@PointClass base(Weapon, Targetx, ExclusiveHold) studio("models/w_pipe_wrench.mdl") = weapon_pipewrench : "Wrench" []

@PointClass base(Weapon, Targetx, ExclusiveHold) studio("models/w_rpg.mdl") = weapon_rpg : "RPG" []

@PointClass base(Weapon, Targetx, ExclusiveHold) studio("models/w_satchel.mdl") = weapon_satchel : "Satchel Charge" []

@PointClass base(Weapon, Targetx) studio("models/w_shock_rifle.mdl") = weapon_shockrifle : "Shock Rifle" []

@PointClass base(Weapon, Targetx, ExclusiveHold) studio("models/w_shotgun.mdl") = weapon_shotgun : "Shotgun" []

@PointClass base(Weapon, Targetx, ExclusiveHold) studio("models/w_sqknest.mdl") = weapon_snark : "Squeak Grenade" []

@PointClass base(Weapon, Targetx, ExclusiveHold) studio("models/w_m40a1.mdl") = weapon_sniperrifle : "Sniper Rifle" []

@PointClass base(Weapon, Targetx, ExclusiveHold) studio("models/w_spore_launcher.mdl") = weapon_sporelauncher : "Spore Launcher" []

@PointClass base(Weapon, Targetx, ExclusiveHold) studio("models/vhe-models/w_tripmine_hammer.mdl") = weapon_tripmine : "Tripmine" []

@PointClass base(Weapon, Targetx, ExclusiveHold) studio("models/w_uzi.mdl") = weapon_uzi : "Single UZI (2 UZIs for Akimbo)" []

@PointClass base(Weapon, Targetx, ExclusiveHold) studio("models/w_2uzis.mdl") = weapon_uziakimbo : "Akimbo UZIs" []

@PointClass base(Item, CustomRespawnDelay) studio("models/w_weaponbox.mdl") = weaponbox : "Weapon/Ammo Container"
[
bullet9mm(integer) : "Packed 9mm rounds"
bullet357(integer) : "Packed 357 rounds"
buckshot(integer) : "Packed shotgun shells"
bolts(integer) : "Packed crossbow bolts"
bullet556(integer) : "Packed 5.56mm rounds"
ARgrenades(integer) : "Packed assault rifle grenades"
rockets(integer) : "Packed rockets"
uranium(integer) : "Packed gauss charges"
handgrenade(integer) : "Packed hand grenades"
satchelcharge(integer) : "Packed satchels"
tripmine(integer) : "Packed trip mines"
Snarks(integer) : "Packed snarks"
m40a1(integer) : "Packed 7.62mm rounds"
sporeclip(integer) : "Packed spores"
]

@PointClass base(Targetname, RenderFields, Angles) size(-8 -8 0, 8 8 32 ) studio("models/hair.mdl") = xen_hair : "Xen Hair"
[
spawnflags(Flags) =
[
1 : "Sync Movement" : 0
2 : "Drop To Ground" : 0
4 : "Face Randomly" : 0
]
]

@PointClass base(Targetname, Target, RenderFields, Angles, AttackObject) size(-48 -48 0, 48 48 32 ) studio("models/light.mdl") = xen_plantlight : "Xen Plant Light"
[
spawnflags(Flags) =
[
2 : "Drop To Ground" : 0
4 : "Face Randomly" : 0
]
]

@PointClass base(Targetname, RenderFields, Angles) size(-90 -90 0, 90 90 220 ) studio("models/fungus(large).mdl") = xen_spore_large : "Xen Spore (large)"
[
spawnflags(Flags) =
[
2 : "Drop To Ground" : 0
4 : "Face Randomly" : 0
8 : "Non Solid" : 0
]
]

@PointClass base(Targetname, RenderFields, Angles) size(-40 -40 0, 40 40 120 ) studio("models/fungus.mdl") = xen_spore_medium : "Xen Spore (medium)"
[
spawnflags(Flags) =
[
2 : "Drop To Ground" : 0
4 : "Face Randomly" : 0
8 : "Non Solid" : 0
]
]

@PointClass base(Targetname, RenderFields, Angles) size(-16 -16 0, 16 16 64 ) studio("models/fungus(small).mdl") = xen_spore_small : "Xen Spore (small)"
[
spawnflags(Flags) =
[
2 : "Drop To Ground" : 0
4 : "Face Randomly" : 0
8 : "Non Solid" : 0
]
]

@PointClass base(Targetname, RenderFields, Angles) size(-24 -24 0, 24 24 188 ) studio("models/tree.mdl") = xen_tree : "Xen Tree"
[
spawnflags(Flags) =
[
2 : "Drop To Ground" : 0
4 : "Face Randomly" : 0
8 : "Non Solid" : 0
]
]
</pre>
[[Category:Mapping]]

Mapping/Sven Co-op FGD

2025-07-07T13:00:32Z

Outerbeast: SC 5.26 FGD

Tracing

2025-06-11T12:45:39Z

Outerbeast: /* Trace methods */

Traces are used to perform hit detection, which is handled by the engine. It is one of the primary means of handling navigation and hit detection in the game.

== TraceResult ==
The <code>TraceResult</code> class stores trace results that are performed by trace methods. Passing in a TraceResult object into a given trace method will modify the object, and so the results from the trace method can be accessed. Not all trace operations require the use of a <code>TraceResult</code> object.

{| class="wikitable" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
! Variable
! Description
|-
| <code>int fAllSolid
| Flag telling whether the trace started and ended in a solid area. If true, the plane is not valid.
|-
| <code>int fStartSolid
| Flag telling whether the trace started in a solid area.
|-
| <code>int fInOpen
| Flag telling whether the trace ended in empty space.
|-
| <code>int fInWater
| Flag telling whether the trace ended in water.
|-
| <code>float flFraction
| How much of the trace's total distance was covered. 1.0 means it didn't hit anything.
|-
| <code>Vector vecEndPos
| End position. If flFraction is 1.0, this is invalid.
|-
| <code>float flPlaneDist
| Brush plane distance. This appears to be the dot product between the first plane point and the normal. Its purpose is unknown, and there are no known uses. If flFraction is 1.0, this is invalid. If the hit object is not a brush, this is invalid.
|-
| <code>Vector vecPlaneNormal
| Brush plane normal. If flFraction is 1.0, this is invalid. If the hit object is not a brush, this is invalid.
|-
| <code>edict_t@ pHit
| Hit entity. If flFraction is 1.0, this is null.
|-
| <code>int iHitgroup
| Studio model hit group. if flFraction is 1.0, this is invalid. If the hit object is not a studio model, this is invalid.
|}

== Trace methods ==
Supported trace operations are listed below and are accessible via the [[CUtility#Tracing_methods|CUtility]] class.
A global instance exists:
<code>CUtility g_Utility;</code>

Note: The method <code>TankTrace</code> belongs to the CBaseTank class.

There are a number of traces that can be performed:

{| class="wikitable" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
! Method
! Description
! Bounds
|-
| <code>void TraceLine(const Vector& in vecStart, const Vector& in vecEnd, IGNORE_MONSTERS igmon, edict_t@ pEntIgnore, TraceResult& out ptr)</code>
| Calculates a trace along the given line, storing the results in ptr. If <code>igmon</code> is ignore_monsters, entities with a solid setting other than SOLID_BSP and a movetype other than MOVETYPE_PUSHSTEP (pushables) are ignored. If <code>pEntIgnore</code> is set, the entity will not be considered in traceline calculations.
| Uses point based bounds (zeroed out mins and maxs)
|-
| <code>void TraceLine(const Vector& in vecStart, const Vector& in vecEnd, IGNORE_MONSTERS igmon, IGNORE_GLASS ignoreGlass, edict_t@ pEntIgnore, TraceResult& out ptr)</code>
| Same as the above function, but also allows you to specify whether or not to ignore glass. If ignore_glass is specified, brush entities with a render mode other than normal and that don't have the <code>FL_WORLDBRUSH</code> flag set are ignored.
| Uses point based bounds (zeroed out mins and maxs)
|-
| <code>void TraceHull(const Vector& in vecStart, const Vector& in vecEnd, IGNORE_MONSTERS igmon, HULL_NUMBER hullNumber, edict_t@ pEntIgnore, TraceResult& out ptr)</code>
| Similar to TraceLine, but will use the specified hull's bounds instead of point based bounds.
| Uses the specified hull's bounds. Maps can specify these bounds in newer compilers, so avoid assuming a particular value is in use.
|-
| <code>void TraceToss(edict_t@ pEntity, edict_t@ pEntityToIgnore, TraceResult& out traceResult)</code>
| Traces a toss. This simulates tossing the entity using its current origin, velocity, angular velocity, angles and gravity. Note that this does not use the same code as MOVETYPE_TOSS, and may return different results.
| Uses the given entity's bounds.
|-
| <code>bool TraceMonsterHull(edict_t@ pEntity, const Vector& in vecStart, const Vector& in vecEnd, IGNORE_MONSTERS igmon, edict_t@ pEntityToIgnore, TraceResult& out ptr)</code>
| Performs a trace using the given entity's mins and maxs. This can be any entity, not just monsters. Returns true if the trace was entirely in a solid object, or if it hit something.
| Uses the given entity's bounds.
|-
| <code>void TraceModel(const Vector& in vecStart, const Vector& in vecEnd, int iHullNumber, edict_t@ pEntityToIgnore, TraceResult& out ptr)</code>
| Similar to TraceHull, but will instead perform a trace in the given world hull using the given entity's model's hulls. For studio models this will use the model's hitboxes.
| If the given entity's model is a studio model, uses its hitboxes. If it's a brush model, the brush model's hull for the given hull number is used (this may differ if custom brush hull sizes are in use). Otherwise, the entity bounds are converted into a hull.
|-
| <code>string TraceTexture(edict_t@ pEntity, const Vector& in vecStart, const Vector& in vecEnd)</code>
| Used to get the name of a texture. The given entity must have a brush model set. If the traceline intersects the model, the name of the texture of the surface it intersected is returned. Otherwise, returns an empty string.
| Uses point based bounds (zeroed out mins and maxs). CUtility::GetGlobalTrace() can be used to obtain this trace.
|-
| <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)</code>
| style="vertical-align:middle;" | Finds the hull intersection from a traceline in a given set of bounds. The given entity is the entity performing the traceline.
| The bounds are relative to the input traceline's endpoint.
|-
| <code>void TankTrace(const Vector& in vecStart, const Vector& in vecForward, const Vector& in vecSpread, TraceResult& out tr)</code>
| style="vertical-align:middle;" | Performs a traceline using a random spread based on the given spread amount. This is a CBaseTank method.
| Uses point based bounds (zeroed out mins and maxs)
|-
|}

== Enums ==
===== IGNORE_MONSTERS =====
{| class="wikitable" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
! Constant
! Purpose
|-
| dont_ignore_monsters
| Don't ignore monsters.
|-
| ignore_monsters
| Ignore monsters.
|-
| missile
| The trace bounds are set to mins -15, -15, -15 and maxs 15, 15, 15. Otherwise, the bounds are specified by the traceline operation.
|}

===== IGNORE_GLASS =====
{| class="wikitable" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
! Constant
! Purpose
|-
| dont_ignore_glass
| Don't ignore glass.
|-
| ignore_glass
| Ignore glass.
|}

===== HULL_NUMBER =====
{| class="wikitable" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
! Constant
! Hull #
! Default Mins
! Default Maxs
! Default Size
|-
| point_hull
| 0
| 0, 0, 0
| 0, 0, 0
| 0x0x0
|-
| human_hull
| 1
| -16, -16, -36
| 16, 16, 36
| 32x32x72
|-
| large_hull
| 2
| -32, -32, -32
| 32, 32, 32
| 64x64x64
|-
| head_hull
| 3
| -16, -16, -18
| 16, 16, 18
| 32x32x36
|}

[[Category:Scripting]]

Tracing

2025-06-11T12:42:09Z

Outerbeast: /* Trace methods */

Traces are used to perform hit detection, which is handled by the engine. It is one of the primary means of handling navigation and hit detection in the game.

== TraceResult ==
The <code>TraceResult</code> class stores trace results that are performed by trace methods. Passing in a TraceResult object into a given trace method will modify the object, and so the results from the trace method can be accessed. Not all trace operations require the use of a <code>TraceResult</code> object.

{| class="wikitable" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
! Variable
! Description
|-
| <code>int fAllSolid
| Flag telling whether the trace started and ended in a solid area. If true, the plane is not valid.
|-
| <code>int fStartSolid
| Flag telling whether the trace started in a solid area.
|-
| <code>int fInOpen
| Flag telling whether the trace ended in empty space.
|-
| <code>int fInWater
| Flag telling whether the trace ended in water.
|-
| <code>float flFraction
| How much of the trace's total distance was covered. 1.0 means it didn't hit anything.
|-
| <code>Vector vecEndPos
| End position. If flFraction is 1.0, this is invalid.
|-
| <code>float flPlaneDist
| Brush plane distance. This appears to be the dot product between the first plane point and the normal. Its purpose is unknown, and there are no known uses. If flFraction is 1.0, this is invalid. If the hit object is not a brush, this is invalid.
|-
| <code>Vector vecPlaneNormal
| Brush plane normal. If flFraction is 1.0, this is invalid. If the hit object is not a brush, this is invalid.
|-
| <code>edict_t@ pHit
| Hit entity. If flFraction is 1.0, this is null.
|-
| <code>int iHitgroup
| Studio model hit group. if flFraction is 1.0, this is invalid. If the hit object is not a studio model, this is invalid.
|}

== Trace methods ==
Supported trace operations are listed below and are accessible via the [[CUtility#Tracing_methods|CUtility]] class.
A global instance exists:
<code>CUtility g_Utility;</code>

Note: The method <code>TankTrace</code> belongs to the CBaseTank class.

There are a number of traces that can be performed:

{| class="wikitable" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
! Method
! Description
! Bounds
|-
| <code>void TraceLine(const Vector& in vecStart, const Vector& in vecEnd, IGNORE_MONSTERS igmon, edict_t@ pEntIgnore, TraceResult& out ptr)</code>
| Calculates a trace along the given line, storing the results in ptr. If <code>igmon</code> is ignore_monsters, entities with a solid setting other than SOLID_BSP and a movetype other than MOVETYPE_PUSHSTEP (pushables) are ignored. If <code>pEntIgnore</code> is set, the entity will not be considered in traceline calculations.
| Uses point based bounds (zeroed out mins and maxs)
|-
| <code>void TraceLine(const Vector& in vecStart, const Vector& in vecEnd, IGNORE_MONSTERS igmon, IGNORE_GLASS ignoreGlass, edict_t@ pEntIgnore, TraceResult& out ptr)</code>
| Same as the above function, but also allows you to specify whether or not to ignore glass. If ignore_glass is specified, brush entities with a render mode other than normal and that don't have the <code>FL_WORLDBRUSH</code> flag set are ignored.
| Uses point based bounds (zeroed out mins and maxs)
|-
| <code>void TraceHull(const Vector& in vecStart, const Vector& in vecEnd, IGNORE_MONSTERS igmon, HULL_NUMBER hullNumber, edict_t@ pEntIgnore, TraceResult& out ptr)</code>
| Similar to TraceLine, but will use the specified hull's bounds instead of point based bounds.
| Uses the specified hull's bounds. Maps can specify these bounds in newer compilers, so avoid assuming a particular value is in use.
|-
| <code>void TraceToss(edict_t@ pEntity, edict_t@ pEntityToIgnore, TraceResult& out traceResult)</code>
| Traces a toss. This simulates tossing the entity using its current origin, velocity, angular velocity, angles and gravity. Note that this does not use the same code as MOVETYPE_TOSS, and may return different results.
| Uses the given entity's bounds.
|-
| <code>bool TraceMonsterHull(edict_t@ pEntity, const Vector& in vecStart, const Vector& in vecEnd, IGNORE_MONSTERS igmon, edict_t@ pEntityToIgnore, TraceResult& out ptr)</code>
| Performs a trace using the given entity's mins and maxs. This can be any entity, not just monsters. Returns true if the trace was entirely in a solid object, or if it hit something.
| Uses the given entity's bounds.
|-
| <code>void TraceModel(const Vector& in vecStart, const Vector& in vecEnd, int iHullNumber, edict_t@ pEntityToIgnore, TraceResult& out ptr)</code>
| Similar to TraceHull, but will instead perform a trace in the given world hull using the given entity's model's hulls. For studio models this will use the model's hitboxes.
| If the given entity's model is a studio model, uses its hitboxes. If it's a brush model, the brush model's hull for the given hull number is used (this may differ if custom brush hull sizes are in use). Otherwise, the entity bounds are converted into a hull.
|-
| <code>string TraceTexture(edict_t@ pEntity, const Vector& in vecStart, const Vector& in vecEnd)</code>
| Used to get the name of a texture. The given entity must have a brush model set. If the traceline intersects the model, the name of the texture of the surface it intersected is returned. Otherwise, returns an empty string.
| Uses point based bounds (zeroed out mins and maxs). CUtility::GetGlobalTrace() can be used to obtain this trace.
|-
| <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)</code>
| style="vertical-align:middle;" | Finds the hull intersection from a traceline in a given set of bounds. The given entity is the entity performing the traceline.
| The bounds are relative to the input traceline's endpoint.
|-
| <code>void TankTrace(const Vector& in vecStart, const Vector& in vecForward, const Vector& in vecSpread, TraceResult& out tr)</code>
| style="vertical-align:middle;" | Performs a traceline using a random spread based on the given spread amount. This is a CBaseTank method.
| The bounds are relative to the input traceline's endpoint.
|-
|}

== Enums ==
===== IGNORE_MONSTERS =====
{| class="wikitable" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
! Constant
! Purpose
|-
| dont_ignore_monsters
| Don't ignore monsters.
|-
| ignore_monsters
| Ignore monsters.
|-
| missile
| The trace bounds are set to mins -15, -15, -15 and maxs 15, 15, 15. Otherwise, the bounds are specified by the traceline operation.
|}

===== IGNORE_GLASS =====
{| class="wikitable" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
! Constant
! Purpose
|-
| dont_ignore_glass
| Don't ignore glass.
|-
| ignore_glass
| Ignore glass.
|}

===== HULL_NUMBER =====
{| class="wikitable" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
! Constant
! Hull #
! Default Mins
! Default Maxs
! Default Size
|-
| point_hull
| 0
| 0, 0, 0
| 0, 0, 0
| 0x0x0
|-
| human_hull
| 1
| -16, -16, -36
| 16, 16, 36
| 32x32x72
|-
| large_hull
| 2
| -32, -32, -32
| 32, 32, 32
| 64x64x64
|-
| head_hull
| 3
| -16, -16, -18
| 16, 16, 18
| 32x32x36
|}

[[Category:Scripting]]

Tracing

2025-06-11T12:41:48Z

Outerbeast: /* Trace methods */

Traces are used to perform hit detection, which is handled by the engine. It is one of the primary means of handling navigation and hit detection in the game.

== TraceResult ==
The <code>TraceResult</code> class stores trace results that are performed by trace methods. Passing in a TraceResult object into a given trace method will modify the object, and so the results from the trace method can be accessed. Not all trace operations require the use of a <code>TraceResult</code> object.

{| class="wikitable" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
! Variable
! Description
|-
| <code>int fAllSolid
| Flag telling whether the trace started and ended in a solid area. If true, the plane is not valid.
|-
| <code>int fStartSolid
| Flag telling whether the trace started in a solid area.
|-
| <code>int fInOpen
| Flag telling whether the trace ended in empty space.
|-
| <code>int fInWater
| Flag telling whether the trace ended in water.
|-
| <code>float flFraction
| How much of the trace's total distance was covered. 1.0 means it didn't hit anything.
|-
| <code>Vector vecEndPos
| End position. If flFraction is 1.0, this is invalid.
|-
| <code>float flPlaneDist
| Brush plane distance. This appears to be the dot product between the first plane point and the normal. Its purpose is unknown, and there are no known uses. If flFraction is 1.0, this is invalid. If the hit object is not a brush, this is invalid.
|-
| <code>Vector vecPlaneNormal
| Brush plane normal. If flFraction is 1.0, this is invalid. If the hit object is not a brush, this is invalid.
|-
| <code>edict_t@ pHit
| Hit entity. If flFraction is 1.0, this is null.
|-
| <code>int iHitgroup
| Studio model hit group. if flFraction is 1.0, this is invalid. If the hit object is not a studio model, this is invalid.
|}

== Trace methods ==
Supported trace operations are listed below and are accessible via the [[CUtility#Tracing_methods|CUtility]] class.
A global instance exists:
<code>CUtility g_Utility;</code>

Note: The method <code>TraceTank</code> belongs to the CBaseTank class.

There are a number of traces that can be performed:

{| class="wikitable" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
! Method
! Description
! Bounds
|-
| <code>void TraceLine(const Vector& in vecStart, const Vector& in vecEnd, IGNORE_MONSTERS igmon, edict_t@ pEntIgnore, TraceResult& out ptr)</code>
| Calculates a trace along the given line, storing the results in ptr. If <code>igmon</code> is ignore_monsters, entities with a solid setting other than SOLID_BSP and a movetype other than MOVETYPE_PUSHSTEP (pushables) are ignored. If <code>pEntIgnore</code> is set, the entity will not be considered in traceline calculations.
| Uses point based bounds (zeroed out mins and maxs)
|-
| <code>void TraceLine(const Vector& in vecStart, const Vector& in vecEnd, IGNORE_MONSTERS igmon, IGNORE_GLASS ignoreGlass, edict_t@ pEntIgnore, TraceResult& out ptr)</code>
| Same as the above function, but also allows you to specify whether or not to ignore glass. If ignore_glass is specified, brush entities with a render mode other than normal and that don't have the <code>FL_WORLDBRUSH</code> flag set are ignored.
| Uses point based bounds (zeroed out mins and maxs)
|-
| <code>void TraceHull(const Vector& in vecStart, const Vector& in vecEnd, IGNORE_MONSTERS igmon, HULL_NUMBER hullNumber, edict_t@ pEntIgnore, TraceResult& out ptr)</code>
| Similar to TraceLine, but will use the specified hull's bounds instead of point based bounds.
| Uses the specified hull's bounds. Maps can specify these bounds in newer compilers, so avoid assuming a particular value is in use.
|-
| <code>void TraceToss(edict_t@ pEntity, edict_t@ pEntityToIgnore, TraceResult& out traceResult)</code>
| Traces a toss. This simulates tossing the entity using its current origin, velocity, angular velocity, angles and gravity. Note that this does not use the same code as MOVETYPE_TOSS, and may return different results.
| Uses the given entity's bounds.
|-
| <code>bool TraceMonsterHull(edict_t@ pEntity, const Vector& in vecStart, const Vector& in vecEnd, IGNORE_MONSTERS igmon, edict_t@ pEntityToIgnore, TraceResult& out ptr)</code>
| Performs a trace using the given entity's mins and maxs. This can be any entity, not just monsters. Returns true if the trace was entirely in a solid object, or if it hit something.
| Uses the given entity's bounds.
|-
| <code>void TraceModel(const Vector& in vecStart, const Vector& in vecEnd, int iHullNumber, edict_t@ pEntityToIgnore, TraceResult& out ptr)</code>
| Similar to TraceHull, but will instead perform a trace in the given world hull using the given entity's model's hulls. For studio models this will use the model's hitboxes.
| If the given entity's model is a studio model, uses its hitboxes. If it's a brush model, the brush model's hull for the given hull number is used (this may differ if custom brush hull sizes are in use). Otherwise, the entity bounds are converted into a hull.
|-
| <code>string TraceTexture(edict_t@ pEntity, const Vector& in vecStart, const Vector& in vecEnd)</code>
| Used to get the name of a texture. The given entity must have a brush model set. If the traceline intersects the model, the name of the texture of the surface it intersected is returned. Otherwise, returns an empty string.
| Uses point based bounds (zeroed out mins and maxs). CUtility::GetGlobalTrace() can be used to obtain this trace.
|-
| <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)</code>
| style="vertical-align:middle;" | Finds the hull intersection from a traceline in a given set of bounds. The given entity is the entity performing the traceline.
| The bounds are relative to the input traceline's endpoint.
|-
| <code>void TankTrace(const Vector& in vecStart, const Vector& in vecForward, const Vector& in vecSpread, TraceResult& out tr)</code>
| style="vertical-align:middle;" | Performs a traceline using a random spread based on the given spread amount. This is a CBaseTank method.
| The bounds are relative to the input traceline's endpoint.
|-
|}

== Enums ==
===== IGNORE_MONSTERS =====
{| class="wikitable" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
! Constant
! Purpose
|-
| dont_ignore_monsters
| Don't ignore monsters.
|-
| ignore_monsters
| Ignore monsters.
|-
| missile
| The trace bounds are set to mins -15, -15, -15 and maxs 15, 15, 15. Otherwise, the bounds are specified by the traceline operation.
|}

===== IGNORE_GLASS =====
{| class="wikitable" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
! Constant
! Purpose
|-
| dont_ignore_glass
| Don't ignore glass.
|-
| ignore_glass
| Ignore glass.
|}

===== HULL_NUMBER =====
{| class="wikitable" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
! Constant
! Hull #
! Default Mins
! Default Maxs
! Default Size
|-
| point_hull
| 0
| 0, 0, 0
| 0, 0, 0
| 0x0x0
|-
| human_hull
| 1
| -16, -16, -36
| 16, 16, 36
| 32x32x72
|-
| large_hull
| 2
| -32, -32, -32
| 32, 32, 32
| 64x64x64
|-
| head_hull
| 3
| -16, -16, -18
| 16, 16, 18
| 32x32x36
|}

[[Category:Scripting]]

Tracing

2025-06-11T12:41:36Z

Outerbeast:

Traces are used to perform hit detection, which is handled by the engine. It is one of the primary means of handling navigation and hit detection in the game.

== TraceResult ==
The <code>TraceResult</code> class stores trace results that are performed by trace methods. Passing in a TraceResult object into a given trace method will modify the object, and so the results from the trace method can be accessed. Not all trace operations require the use of a <code>TraceResult</code> object.

{| class="wikitable" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
! Variable
! Description
|-
| <code>int fAllSolid
| Flag telling whether the trace started and ended in a solid area. If true, the plane is not valid.
|-
| <code>int fStartSolid
| Flag telling whether the trace started in a solid area.
|-
| <code>int fInOpen
| Flag telling whether the trace ended in empty space.
|-
| <code>int fInWater
| Flag telling whether the trace ended in water.
|-
| <code>float flFraction
| How much of the trace's total distance was covered. 1.0 means it didn't hit anything.
|-
| <code>Vector vecEndPos
| End position. If flFraction is 1.0, this is invalid.
|-
| <code>float flPlaneDist
| Brush plane distance. This appears to be the dot product between the first plane point and the normal. Its purpose is unknown, and there are no known uses. If flFraction is 1.0, this is invalid. If the hit object is not a brush, this is invalid.
|-
| <code>Vector vecPlaneNormal
| Brush plane normal. If flFraction is 1.0, this is invalid. If the hit object is not a brush, this is invalid.
|-
| <code>edict_t@ pHit
| Hit entity. If flFraction is 1.0, this is null.
|-
| <code>int iHitgroup
| Studio model hit group. if flFraction is 1.0, this is invalid. If the hit object is not a studio model, this is invalid.
|}

== Trace methods ==
Supported trace operations are listed below and are accessible via the [[CUtility#Tracing_methods|CUtility]] class.
A global instance exists:
<code>CUtility g_Utility;</code>

Note: The method <code>TraceTank<code> belongs to the CBaseTank class.

There are a number of traces that can be performed:

{| class="wikitable" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
! Method
! Description
! Bounds
|-
| <code>void TraceLine(const Vector& in vecStart, const Vector& in vecEnd, IGNORE_MONSTERS igmon, edict_t@ pEntIgnore, TraceResult& out ptr)</code>
| Calculates a trace along the given line, storing the results in ptr. If <code>igmon</code> is ignore_monsters, entities with a solid setting other than SOLID_BSP and a movetype other than MOVETYPE_PUSHSTEP (pushables) are ignored. If <code>pEntIgnore</code> is set, the entity will not be considered in traceline calculations.
| Uses point based bounds (zeroed out mins and maxs)
|-
| <code>void TraceLine(const Vector& in vecStart, const Vector& in vecEnd, IGNORE_MONSTERS igmon, IGNORE_GLASS ignoreGlass, edict_t@ pEntIgnore, TraceResult& out ptr)</code>
| Same as the above function, but also allows you to specify whether or not to ignore glass. If ignore_glass is specified, brush entities with a render mode other than normal and that don't have the <code>FL_WORLDBRUSH</code> flag set are ignored.
| Uses point based bounds (zeroed out mins and maxs)
|-
| <code>void TraceHull(const Vector& in vecStart, const Vector& in vecEnd, IGNORE_MONSTERS igmon, HULL_NUMBER hullNumber, edict_t@ pEntIgnore, TraceResult& out ptr)</code>
| Similar to TraceLine, but will use the specified hull's bounds instead of point based bounds.
| Uses the specified hull's bounds. Maps can specify these bounds in newer compilers, so avoid assuming a particular value is in use.
|-
| <code>void TraceToss(edict_t@ pEntity, edict_t@ pEntityToIgnore, TraceResult& out traceResult)</code>
| Traces a toss. This simulates tossing the entity using its current origin, velocity, angular velocity, angles and gravity. Note that this does not use the same code as MOVETYPE_TOSS, and may return different results.
| Uses the given entity's bounds.
|-
| <code>bool TraceMonsterHull(edict_t@ pEntity, const Vector& in vecStart, const Vector& in vecEnd, IGNORE_MONSTERS igmon, edict_t@ pEntityToIgnore, TraceResult& out ptr)</code>
| Performs a trace using the given entity's mins and maxs. This can be any entity, not just monsters. Returns true if the trace was entirely in a solid object, or if it hit something.
| Uses the given entity's bounds.
|-
| <code>void TraceModel(const Vector& in vecStart, const Vector& in vecEnd, int iHullNumber, edict_t@ pEntityToIgnore, TraceResult& out ptr)</code>
| Similar to TraceHull, but will instead perform a trace in the given world hull using the given entity's model's hulls. For studio models this will use the model's hitboxes.
| If the given entity's model is a studio model, uses its hitboxes. If it's a brush model, the brush model's hull for the given hull number is used (this may differ if custom brush hull sizes are in use). Otherwise, the entity bounds are converted into a hull.
|-
| <code>string TraceTexture(edict_t@ pEntity, const Vector& in vecStart, const Vector& in vecEnd)</code>
| Used to get the name of a texture. The given entity must have a brush model set. If the traceline intersects the model, the name of the texture of the surface it intersected is returned. Otherwise, returns an empty string.
| Uses point based bounds (zeroed out mins and maxs). CUtility::GetGlobalTrace() can be used to obtain this trace.
|-
| <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)</code>
| style="vertical-align:middle;" | Finds the hull intersection from a traceline in a given set of bounds. The given entity is the entity performing the traceline.
| The bounds are relative to the input traceline's endpoint.
|-
| <code>void TankTrace(const Vector& in vecStart, const Vector& in vecForward, const Vector& in vecSpread, TraceResult& out tr)</code>
| style="vertical-align:middle;" | Performs a traceline using a random spread based on the given spread amount. This is a CBaseTank method.
| The bounds are relative to the input traceline's endpoint.
|-
|}

== Enums ==
===== IGNORE_MONSTERS =====
{| class="wikitable" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
! Constant
! Purpose
|-
| dont_ignore_monsters
| Don't ignore monsters.
|-
| ignore_monsters
| Ignore monsters.
|-
| missile
| The trace bounds are set to mins -15, -15, -15 and maxs 15, 15, 15. Otherwise, the bounds are specified by the traceline operation.
|}

===== IGNORE_GLASS =====
{| class="wikitable" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
! Constant
! Purpose
|-
| dont_ignore_glass
| Don't ignore glass.
|-
| ignore_glass
| Ignore glass.
|}

===== HULL_NUMBER =====
{| class="wikitable" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
! Constant
! Hull #
! Default Mins
! Default Maxs
! Default Size
|-
| point_hull
| 0
| 0, 0, 0
| 0, 0, 0
| 0x0x0
|-
| human_hull
| 1
| -16, -16, -36
| 16, 16, 36
| 32x32x72
|-
| large_hull
| 2
| -32, -32, -32
| 32, 32, 32
| 64x64x64
|-
| head_hull
| 3
| -16, -16, -18
| 16, 16, 18
| 32x32x36
|}

[[Category:Scripting]]

TE PLAYERATTACHMENT

2025-05-31T15:23:52Z

Outerbeast:

Attaches a sprite or model to the target player.
[[File:TE PLAYERATTACHMENT.gif|frame|TE_PLAYERATTACHMENT]]

A CBasePlayer method exists: <code>void ShowOverheadSprite(const string& in szSpriteName, const float flZOffset, const float flLifeTime)</code>

<pre>
void te_playerattachment(CBasePlayer@ target, float vOffset=51.0f,
string sprite="sprites/bubble.spr", uint16 life=16,
NetworkMessageDest msgType=MSG_BROADCAST, edict_t@ dest=null)
{
NetworkMessage m(msgType, NetworkMessages::SVC_TEMPENTITY, dest);
m.WriteByte(TE_PLAYERATTACHMENT);
m.WriteByte(target.entindex());
m.WriteCoord(vOffset);
m.WriteShort(g_EngineFuncs.ModelIndex(sprite));
m.WriteShort(life);
m.End();
}
</pre>

* <code>CBasePlayer@ target</code> Player to attach the sprite/model to
* <code>float vOffset</code> Vertical sprite offset relative to the player's origin
* <code>string sprite</code> Sprite to display (alpha transparency)
* <code>uint16 life</code> Time to display the attachement (seconds * 0.1)
[[Category:Scripting]]

TE PLAYERATTACHMENT

2025-05-31T15:18:53Z

Outerbeast: Created page with "Attaches a sprite or model to the target player. TE_PLAYERATTACHMENT A CBasePlayer method exists: <code>void ShowOverheadSprite(const s..."

TE KILLPLAYERATTACHMENTS

2025-05-31T15:11:07Z

Outerbeast: Created page with "Removes attachments created with TE_PLAYERATTACHMENT from the target player. <pre> void te_killplayerattachments(CBasePlayer@ plr, NetworkMessageDest msgType=MSG_BROADCA..."

Removes attachments created with [[TE_PLAYERATTACHMENT]] from the target player.
<pre>
void te_killplayerattachments(CBasePlayer@ plr,
NetworkMessageDest msgType=MSG_BROADCAST, edict_t@ dest=null)
{
NetworkMessage m(msgType, NetworkMessages::SVC_TEMPENTITY, dest);
m.WriteByte(TE_KILLPLAYERATTACHMENTS);
m.WriteByte(plr.entindex());
m.End();
}
</pre>

<code>CBasePlayer@ target</code> Player to remove attachments from

TE ARMOR RICOCHET

2025-05-31T15:08:24Z

Outerbeast: Created page with "Armor ricochet sprite and sound effect. TE_ARMOR_RICOCHET <pre> void te_ricochet(Vector pos, uint8 scale=10, NetworkMessageDest msgType=..."

Armor ricochet sprite and sound effect.
[[File:TE ARMOR RICOCHET.gif|frame|TE_ARMOR_RICOCHET]]
<pre>
void te_ricochet(Vector pos, uint8 scale=10,
NetworkMessageDest msgType=MSG_BROADCAST, edict_t@ dest=null)
{
NetworkMessage m(msgType, NetworkMessages::SVC_TEMPENTITY, dest);
m.WriteByte(TE_ARMOR_RICOCHET);
m.WriteCoord(pos.x);
m.WriteCoord(pos.y);
m.WriteCoord(pos.z);
m.WriteByte(scale);
m.End();
}
</pre>
* <code>Vector pos</code> Center point for the effect
* <code>uint8 scale</code> Sprite scale * 0.1

[[Category:Scripting]]

TE GLOWSPRITE

2025-05-31T15:06:01Z

Outerbeast:

A sprite that slowly fades out after its life expires. Not animated.
[[File:TE GLOWSPRITE.gif|frame|TE_GLOWSPRITE]]
<pre>
void te_glowsprite(Vector pos, string sprite="sprites/glow01.spr",
uint8 life=1, uint8 scale=10, uint8 alpha=255,
NetworkMessageDest msgType=MSG_BROADCAST, edict_t@ dest=null)
{
NetworkMessage m(msgType, NetworkMessages::SVC_TEMPENTITY, dest);
m.WriteByte(TE_GLOWSPRITE);
m.WriteCoord(pos.x);
m.WriteCoord(pos.y);
m.WriteCoord(pos.z);
m.WriteShort(g_EngineFuncs.ModelIndex(sprite));
m.WriteByte(life);
m.WriteByte(scale);
m.WriteByte(alpha);
m.End();
}
</pre>
* <code>Vector pos</code> Center point for the effect
* <code>string sprite</code> Non-animated Sprite (additive)
* <code>uint8 life</code> Time to wait before fading out (seconds * 0.1)
* <code>uint8 scale</code> Sprite scale * 0.1
* <code>uint8 alpha</code> Sprite opacity
[[Category:Scripting]]

TE GLOWSPRITE

2025-05-31T15:05:45Z

Outerbeast: Created page with "A sprite that slowly fades out after its life expires. Not animated. TE_GLOWSPRITE <pre> void te_glowsprite(Vector pos, string sprite="sprites..."

A sprite that slowly fades out after its life expires. Not animated.
[[File:TE GLOWSPRITE.gif|frame|TE_GLOWSPRITE]]
<pre>
void te_glowsprite(Vector pos, string sprite="sprites/glow01.spr",
uint8 life=1, uint8 scale=10, uint8 alpha=255,
NetworkMessageDest msgType=MSG_BROADCAST, edict_t@ dest=null)
{
NetworkMessage m(msgType, NetworkMessages::SVC_TEMPENTITY, dest);
m.WriteByte(TE_GLOWSPRITE);
m.WriteCoord(pos.x);
m.WriteCoord(pos.y);
m.WriteCoord(pos.z);
m.WriteShort(g_EngineFuncs.ModelIndex(sprite));
m.WriteByte(life);
m.WriteByte(scale);
m.WriteByte(alpha);
m.End();
}
</pre>
<code>Vector pos</code> Center point for the effect
<code>string sprite</code> Non-animated Sprite (additive)
<code>uint8 life</code> Time to wait before fading out (seconds * 0.1)
<code>uint8 scale</code> Sprite scale * 0.1
<code>uint8 alpha</code> Sprite opacity
[[Category:Scripting]]

TE SPRITE

2025-05-31T13:05:39Z

Outerbeast: Created page with "An animated sprite. Plays once. frame <pre> void te_sprite(Vector pos, string sprite="sprites/zerogxplode.spr", uint8 scale=10, uint8 alpha=200, Net..."

An animated sprite. Plays once.
[[File:TE SPRITE.gif|frame]]
<pre>
void te_sprite(Vector pos, string sprite="sprites/zerogxplode.spr",
uint8 scale=10, uint8 alpha=200,
NetworkMessageDest msgType=MSG_BROADCAST, edict_t@ dest=null)
{
NetworkMessage m(msgType, NetworkMessages::SVC_TEMPENTITY, dest);
m.WriteByte(TE_SPRITE);
m.WriteCoord(pos.x);
m.WriteCoord(pos.y);
m.WriteCoord(pos.z);
m.WriteShort(g_EngineFuncs.ModelIndex(sprite));
m.WriteByte(scale);
m.WriteByte(alpha);
m.End();
}
</pre>

* <code>Vector pos</code> Center point for the effect
* <code>string sprite</code> Animated sprite (additive)
* <code>uint8 scale</code> Sprite scale * 0.1
* <code>uint8 alpha</code> Sprite opacity
[[Category:Scripting]]

TE SPARKS

2025-05-31T11:49:05Z

Outerbeast: Created page with "A flashing sprite combined with a small splash of tracers. Sound effect not included. frame A CUtility method exists: <code>void Sparks(const Vector..."

A flashing sprite combined with a small splash of tracers. Sound effect not included.
[[File:TE SPARKS.gif|frame]]
A [[CUtility]] method exists:
<code>void Sparks(const Vector& in vecPosition)</code>
<pre>
void te_sparks(Vector pos,
NetworkMessageDest msgType=MSG_BROADCAST, edict_t@ dest=null)
{
NetworkMessage m(msgType, NetworkMessages::SVC_TEMPENTITY, dest);
m.WriteByte(TE_SPARKS);
m.WriteCoord(pos.x);
m.WriteCoord(pos.y);
m.WriteCoord(pos.z);
m.End();
}
</pre>
[[Category:Scripting]]

TE SMOKE

2025-05-31T11:41:52Z

Outerbeast:

An animated sprite that moves upward at 30 units per second. Plays once.
[[File:TE SMOKE.gif|frame|TE_SMOKE]]
<pre>
void te_smoke(Vector pos, string sprite="sprites/steam1.spr",
int scale=10, int frameRate=15,
NetworkMessageDest msgType=MSG_BROADCAST, edict_t@ dest=null)
{
NetworkMessage m(msgType, NetworkMessages::SVC_TEMPENTITY, dest);
m.WriteByte(TE_SMOKE);
m.WriteCoord(pos.x);
m.WriteCoord(pos.y);
m.WriteCoord(pos.z);
m.WriteShort(g_EngineFuncs.ModelIndex(sprite));
m.WriteByte(scale);
m.WriteByte(frameRate);
m.End();
}
</pre>

* <code>Vector pos</code> Center point for the effect
* <code>string sprite</code> Animated smoke sprite (alpha transparency)
* <code>uint8 scale</code> Sprite scale * 0.1
* <code>uint8 frameRate</code> Frame rate of the sprite (FPS * 0.1)
[[Category:Scripting]]

TE SMOKE

2025-05-31T11:41:30Z

Outerbeast: Created page with "An animated sprite that moves upward at 30 units per second. Plays once. TE_SMOKE <pre> void te_smoke(Vector pos, string sprite="sprites/steam1.spr..."

Angelscript

2025-04-16T15:14:07Z

Outerbeast: /* Miscellaneous */

This page contains basic coverage and tutorials for Sven Co-op's Angelscript API.

[https://r4to0.github.io/asautodocs/nd_prerelease/index.html API auto-generated documentation is available here.]
For information on the AngelScript language, visit the [https://www.angelcode.com/angelscript/sdk/docs/manual/doc_script.html official AngelScript manual here]
== Getting Started ==
{| class="wikitable"
|-
! style="text-decoration:underline;" | Tutorials
! style="vertical-align:middle;" | Basics of building scripts
|-
| style="text-decoration:underline; " | [[Running Scripts]]
| style="vertical-align:middle; " | Covers how to import and execute script files, such as map scripts and plugins
|-
| style="text-decoration:underline; " | [[Typecasting]]
| style="vertical-align:middle; " | Covers how and when to use typecasts
|-
| style="text-decoration:underline; " | [[Debugging]]
| style="vertical-align:middle; " | Debugging scripts
|-
| style="text-decoration:underline; " | [[Entity Basics]]
| style="vertical-align:middle; " | Covers the basics of what entities are and how to use them.
|-
| style="text-decoration:underline; " | [[Entity Intermediate]]
| style="vertical-align:middle; " | Covers intermediate topics regarding entities.
|-
| style="text-decoration:underline; " | [[Custom Entities]]
| style="vertical-align:middle; " | Build your own custom entity
|}
== API Features ==
{| class="wikitable"
|-
! style="text-decoration:underline;" | API Features
! style="vertical-align:middle;" | Covers some fundamental aspects of writing scripts for Sven Co-op
|-
| style="text-decoration:underline; " | [[CEntityFuncs|Entity Functions]]
| style="vertical-align:middle; " | How to use the various entity functions.
|-
| style="text-decoration:underline; " | [[CPlayerFuncs|Player Functions]]
| style="vertical-align:middle; " | Various player related functions
|-
| style="text-decoration:underline; " | [[CSoundEngine|Sound System]]
| style="vertical-align:middle; " | How to use the sound system.
|-
| style="text-decoration:underline; " | [[CEngineFuncs|Engine Functions]]
| style="vertical-align:middle; " | How to use engine functions.
|-
| style="text-decoration:underline; " | [[Mapping/Custom_Keyvalues#Custom_keyvalues_in_Angelscript|Custom Keyvalues]]
| style="vertical-align:middle; " | Covers the usage of custom keyvalues in scripts.
|-
| style="text-decoration:underline; " | [[CEngine]]
| style="vertical-align:middle; " | Covers the CEngine class. This class includes the current time and frametime, as well as engine configuration and the global trace.
|-
| style="text-decoration:underline; " | [[CGame]]
| style="vertical-align:middle; " | Contains methods integral to the game's operation.
|-
| style="text-decoration:underline; " | [[Tracing]]
| style="vertical-align:middle; " | Covers performing traces and usage of the TraceResult class, as well as related enumerations.
|-
| style="text-decoration:underline; " | [[CUtility|Utility Functions]]
| style="vertical-align:middle; " | Covers various utility methods
|-
| style="text-decoration:underline; " | [[Hooks]]
| style="vertical-align:middle; " | Covers the purpose and use of hooks.
|-
| style="text-decoration:underline; " | [[Scheduler]]
| style="vertical-align:middle; " | Covers the use of the scheduler.
|-
| style="text-decoration:underline; " | [[CMath|Math]]
| style="vertical-align:middle; " | Covers the use of various math operations
|-
| style="text-decoration:underline; " | [[HUD]]
| style="vertical-align:middle; " | Covers the usage of various HUD elements
|-
| style="text-decoration:underline; " | [[Temporary Effects]]
| style="vertical-align:middle; " | Covers the use of temporary entities.
|-
| style="text-decoration:underline; " | [[File System]]
| style="vertical-align:middle; " | Covers the use of the virtual file system
|-
| style="text-decoration:underline; " | [[CConCommandSystem| Console Command System]]
| style="vertical-align:middle; " | Covers the console command system. This is used to add console commands and variables.
|-
| style="text-decoration:underline; " | [[Trigger_script#Scripting|trigger_script]]
| style="vertical-align:middle; " | Build a trigger_script entity function
|-
| style="text-decoration:underline; " | [[squadmaker function]]
| style="vertical-align:middle; " | Describes the usage of the squadmaker entity to call script functions.
|-
| style="text-decoration:underline; " | [[ondestroyfn]]
| style="vertical-align:middle; " | Describes the usage of the "ondestroyfn" function
|}

== Data Types ==
{| class="wikitable"
|-
! style="text-decoration:underline;" | Data Types
! style="vertical-align:middle;" | Covers some common data types used in scripts
|-
| style="text-decoration:underline;" | [[Strings]]
| style="vertical-align:middle;" | Covers the basics of strings in scripts
|-
| style="text-decoration:underline;" | [[Vector|Vectors]]
| style="vertical-align:middle;" | Covers the basics of Vectors in scripts
|-
| style="text-decoration:underline;" | [[RGBA]]
| style="vertical-align:middle;" | Covers the basics of the RGBA structure
|-
| style="text-decoration:underline;" | [[EHandle]]
| style="vertical-align:middle;" | Covers the usage of EHandle structure for storing entity handles
|-
| style="text-decoration:underline;" | [[CCVar]]
| style="vertical-align:middle;" | Covers how to create and use custom CVars
|-
|}

== Miscellaneous ==
{| class="wikitable"
|-
! style="text-decoration:underline;" | Page
! style="vertical-align:middle;" | Description
|-
| style="text-decoration:underline;" | [[DateTime]]
| style="vertical-align:middle;" | Covers the basics of the date and time structure
|-
| style="text-decoration:underline;" | [[SayParameters]]
| style="vertical-align:middle;" | Stores data used by the ClientSay [[Hooks|hook]].
|-
| style="text-decoration:underline;" | [[Animation Extensions]]
| style="vertical-align:middle;" | Animation Extensions used by weapons for player models.
|-
| style="text-decoration:underline;" | [[Default Ammo Types]]
| style="vertical-align:middle;" | Default Ammo Types used by the game.
|-
| style="text-decoration:underline;" | [[Bullet]]
| style="vertical-align:middle;" | The Bullet enum contains bullet types used by the game.
|-
| style="text-decoration:underline;" | [[KeyValueBuffer]]
| style="vertical-align:middle;" | Key Value Buffer
|-
|}

[[Category:Scripting]]