MapBase/source-sdk-2013-mapbase
1
0
Fork 0
mirror of https://github.com/mapbase-source/source-sdk-2013.git synced 2025-01-27 14:17:59 +03:00
Code Issues Packages Projects Releases Wiki Activity

Finished base entity I/O/KV list

Blixibon 2019-07-10 11:24:50 -05:00
parent 4cc94a9194
commit 795390f383
1 changed files with 31 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
Base-Entity.md

@ -1,6 +1,6 @@
This page lists all changes to `CBaseEntity`, the class that every single entity in the Source engine derives from. This means the all entities in Hammer technically possess these changes (except for internal entities removed on compile), although whether they actually show up depend on how relevant they are. (e.g. "Draw/UndrawEntity" is irrelevant on logic entities)
This page lists all changes to `CBaseEntity`, the class that every single entity in the Source engine derives from. This means every entity in Hammer technically possesses these changes, but whether they actually show up depend on how relevant the changes are to a certain entity. (e.g. "Draw/UndrawEntity" is irrelevant on logic entities)
Some I/O were ported from other games or were already possible through other, more complicated means (e.g. AddOutput).
Some I/O were ported from other games or were already possible through other, more complicated means (e.g. keyvalues changed with AddOutput).
### Inputs
---
@ -14,42 +14,46 @@ New User I/O that could pass parameters:
* **PassRandomUser** `<any>` - Fires OutUser1, OutUser2, OutUser3, or OutUser4 with a 25% chance of each, passing any parameter.
---
* **SetTarget** `<string>` - A special new input designed to change an entity's "target", including things like path_track paths and env_gunfire targets. By default, this changes the common `target` keyvalue on entities. Some entities override SetTarget for their own keyvalues, e.g. `scripted_sequence`'s target NPC. This also calls `Activate()`, which is commonly used to assign m_target to cached entity handles.
* **SetOwnerEntity** `<ehandle>` - Sets the owner entity. Owner entities are used for kill credit, non-collision, etc.
* **SetOwnerEntity** `<ehandle>` - Sets this entity's "owner entity". Owner entities are used for kill credit, non-collision, etc.
---
* **SetHealth** `<integer>` - Sets an entity's health. This input already existed on several entities, but now it's part of all entities.
* **AddHealth/RemoveHealth** `<integer>` - Adds to/removes from an entity's health. These inputs already existed on props and func_breakables, but now they're part of all entities, including NPCs.
* **SetMaxHealth** `<integer>` - Sets an entity's maximum health. This will not change the entity's current health unless it exceeds the new maximum.
* **SetHealth** `<integer>` - Sets this entity's health. This input already existed on several entities, but now it's part of all entities.
* **AddHealth/RemoveHealth** `<integer>` - Adds to/removes from this entity's health. These inputs already existed on props and func_breakables, but now they're part of all entities, including NPCs.
* **SetMaxHealth** `<integer>` - Sets this entity's maximum health. This will not change the entity's current health unless it exceeds the new maximum.
---
* **FireOutput** `<string>` - Fires the named output on an entity. Format: `<output name>:<activator>:<caller>:<parameter>:<delay>` (OnDeath:hl3cardgame:gaben). Everything beyond the output name is optional.
* **RemoveOutput** `<string>` - Removes all instances of the named output on an entity. Wildcards are supported, meaning you could just pass '*' to wipe all outputs from this entity.
* **FireOutput** `<string>` - Fires the named output on this entity. Format: `<output name>:<activator>:<caller>:<parameter>:<delay>` (OnDeath:hl3cardgame:gaben). Everything beyond the output name is optional.
* **RemoveOutput** `<string>` - Removes all instances of the named output on this entity. Wildcards are supported, meaning you could just pass '*' to wipe all outputs from this entity.
* **AcceptInput** `<string>` - Fires the named input an this entity. Format: `<input name>:<parameter>:<activator>:<caller>:<output ID>` (SetTarget:cheese). Everything beyond the input name is optional. Mind the fact this is arranged differently from FireOutput, having the parameter right after the input name.
* **CancelPending** `<void>` - Cancels any events fired by an entity that are currently pending in the I/O event queue. This input originated from logic_relay, but it's been promoted to a base input so any entity could cancel their outputs.
* **CancelPending** `<void>` - Cancels any events fired by this entity that are currently pending in the I/O event queue. This input originated from logic_relay, but it's been promoted to a base input so any entity could cancel their outputs.
---
* **FreeChildren** `<void>` - Unparents all entities parented to an entity in a movement hierarchy.
* **FreeChildren** `<void>` - Unparents all entities parented to this entity in a movement hierarchy.
---
* **SetLocalOrigin** `<vector>` - Sets an entity's origin in the map.
* **SetLocalAngles** `<vector>` - Set an entity's angles.
* **SetLocalVelocity** `<vector>` - Sets an entity's current velocity.
* **SetLocalAngularVelocity** `<vector>` - Sets an entity's current angular velocity.
* **SetLocalOrigin** `<vector>` - Sets this entity's origin in the map.
* **SetLocalAngles** `<vector>` - Set this entity's angles.
* **SetLocalVelocity** `<vector>` - Sets this entity's current velocity.
* **SetLocalAngularVelocity** `<vector>` - Sets this entity's current angular velocity.
---
* **AddSpawnFlags** `<integer>` - Adds spawnflag(s) to an entity. Many spawnflags have their respective numbers suffixed in Mapbase's FGD.
* **RemoveSpawnFlags** `<integer>` - Removes spawnflag(s) from an entity. Many spawnflags have their respective numbers suffixed in Mapbase's FGD.
* **SetRenderMode** `<integer>` - Sets an entity's render mode.
* **SetRenderFX** `<integer>` - Sets an entity's render FX.
* **AddEffects** `<integer>` - Adds to an entity's effects flags.
* **RemoveEffects** `<integer>` - Removes from an entity's effects flags.
* **DrawEntity** `<void>` - Draws an entity if it was undrawn before. Equivalent to `RemoveEffects > 32`.
* **UndrawEntity** `<void>` - Undraws an entity if it was drawn before. Equivalent to `AddEffects > 32`.
* **AddEFlags** `<integer>` - Adds to an entity's EFlags.
* **RemoveEFlags** `<integer>` - Removes from an entity's EFlags.
* **SetMoveType** `<integer>` - Sets an entity's movetype.
* **SetCollisionGroup** `<integer>` - Sets an entity's collision group.
* **AddSpawnFlags** `<integer>` - Adds spawnflag(s) to this entity. Many spawnflags have their respective numbers suffixed in Mapbase's FGD.
* **RemoveSpawnFlags** `<integer>` - Removes spawnflag(s) from this entity. Many spawnflags have their respective numbers suffixed in Mapbase's FGD.
* **SetRenderMode** `<integer>` - Sets this entity's render mode.
* **SetRenderFX** `<integer>` - Sets this entity's render FX.
* **AddEffects** `<integer>` - Adds to this entity's effects flags.
* **RemoveEffects** `<integer>` - Removes from this entity's effects flags.
* **DrawEntity** `<void>` - Draws this entity if it was undrawn before. Equivalent to `RemoveEffects > 32`.
* **UndrawEntity** `<void>` - Undraws this entity if it was drawn before. Equivalent to `AddEffects > 32`.
* **AddEFlags** `<integer>` - Adds to this entity's EFlags.
* **RemoveEFlags** `<integer>` - Removes from this entity's EFlags.
* **SetMoveType** `<integer>` - Sets this entity's movetype.
* **SetCollisionGroup** `<integer>` - Sets this entity's collision group.
---
* **Touch** `<ehandle>` - Simulates the specified entity touching the entity receiving this input. (e.g. a trigger receiving this input with a player as the parameter will be triggered by that player)
---
* **KillIfNotVisible** `<void>` - Kills this entity if it's not visible to any players.
* **KillWhenNotVisible** `<float>` - Kills this entity when it's not visible to any players. A specific amount of time before this is evaluated can be passed.
---
* **SetThinkNull** `<void>` - Sets this entity's general think function to NULL. A string can be passed to clear the think of a specific context.
---
* **ChangeVariable** `<string>` - A special version of AddOutput that changes a datadesc variable instead of a keyvalue, similar to logic_datadesc_accessor.
---
### Outputs
---
@ -62,4 +66,4 @@ New User I/O that could pass parameters:
### KeyValues
---
No keyvalues have actually been added, although the owner entity can now be accessed with the **OwnerEntity** keyvalue and m_fFlags can now be accessed with the aptly named **m_fFlags** keyvalue, but neither are actually used in any base FGD classes to avoid clutter.
No new keyvalues have actually been added to CBaseEntity, although the owner entity can now be accessed with the **OwnerEntity** keyvalue and m_fFlags can now be accessed with the aptly named **m_fFlags** keyvalue, but neither are actually used in any base FGD classes to avoid clutter.