User:Orin/Sandbox/Entity Additions

WIP. Feel free to edit, but don't paste anything from here into the main page without my consent. If you have anything that needs to go there, edit it there.

All entity-oriented feature additions: Inputs, Outputs, Targetting, etc. are all documented within their own heaps of lists.

Note I/O inputs have two different type of parameters: <Required> and [Optional].

I/O Expansions

Targetname Prefixes

When targetting entities, adding prefixes of the format @name1@ will instead target an entity relative to the given entity, usually by relationships.

Prefix	Description
@p@<targetname>	Targets the parent of an entity. Example: @p@!activator.
@c@<targetname>	Targets the child of an entity. Example: @c@!activator.
@bb<vector mins> <vector maxs>@<targetname>	Target all entiities within a bounding box relative to the given entity. Example: @bb-100 -100 -100 100 100 100@prop_dynamic.

Entity I/O Additions

All Entities

Inputs

Input	Description
$FireUserAsActivator1-4 <string>	Acts like FireUser1-4, but the entity becomes the !activator and is passed as the parameter of OnUser1-4 output
$FireUser5-8 <string>	Fires custom $OnUser5-8 output
$TakeDamage <int>	Take specified amount of damage
$TakeDamageFromActivator <int>	Take specified amount of damage, the !activator is the damage inflictor
$SetModel <string>	Set custom model
$SetModelOverride <string>	Set custom model, only changes the appearance
$SetModelSpecial <string>	Set custom model, in a special way, it does less additional changes to the entity
$SetOwner <entity>	Set entity owner
$InheritOwner <entity>	Set entity owner to the passed entity owner
$InheritParent <entity>	Set entity parent to the passed entity parent
$GetKeyValue <string>	Fire OnUser1 output, with key value as a parameter
$MoveType <int>,<int>	Set move type
$PlaySound <string>	Play sound from this entity
$StopSound <string>	Stop playing sound from this entity
$SetLocalOrigin <vector>	Set origin relative to parent
$SetLocalAngles <vector>	Set angles relative to parent
$SetLocalVelocity <vector>	Set velocity relative to parent
$TeleportToEntity <entity>	Teleport to specified entity
$MoveRelative <vector>	Move relative to parent (world)
$RotateRelative <vector>	Rotate relative to parent (world)
SetKey$(keyvalue name) <string>	Set keyvalue to specified value
GetKey$(keyvalue name) <string>	input|default value; example: !activator|$DisplayTextCenter|def Trigger the input of an entity, with keyvalue as a parameter (default value if not found)
SetVar$(variable name) <string>	Set custom entity variable
GetVar$(variable name) <string>	input|default value; example: !activator|$DisplayTextCenter|def Trigger the input of an entity, with variable as a parameter (default value if not found)
SetData$(datamap prop name) <string>	Set datamap property to specified value
GetData$(datamap prop name) <string>	input|default value; example: !activator|$DisplayTextCenter|def Trigger the input of an entity, with datamap prop as a parameter (default value if not found)
SetProp$(send prop name) <string>	Set send property to specified value
GetProp$(send prop name) <string>	input|default value; example: !activator|$DisplayTextCenter|def Trigger the input of an entity, with send prop as a parameter (default value if not found)

Outputs

Output	Description
$OnUser5-8 <string>	Called when $FireUser5-8 input is used.
$OnKilled	Fired when the entity is killed. The !caller entity will be inaccessible at this point.

logic_case

Redirects I/O in ways depending if a case's scenario has happened. VDC page

For the inputs used in text formatting and menus, look at the Entity Expansions section.

Inputs

Input	Description
$TestSigsegv	Dedicated for testing if the extension is successfully loaded. Fires OnUser1 output.
$ToFloat <any>	Converts argument to float, or known as number. Fires OnDefault output with result as parameter.
$ToInt <any>	Converts argument to integer, a number with no decimals. Fires OnDefault output with result as parameter.
$GetConVar <string>	Fetches a convar's (console variable) number value, but on two criterias: Having "replicated" flag, and not having a "protected" flag. If both pass, the OnDefault output fires with the parameter as the number value. ℹ️ Tip: The help concommand displays the flags of a convar.
$GetConVarString <string>	Identical to $GetConVar, but the fetched value is passed as a string.
$CallerToActivator	Fires OnDefault output with !activator overriden as the entity in !caller.
$GetKeyValueFromActivator <string>	Grab value of a key from the !activator entity. Fires OnDefault output with result as parameter. 🛑 Superseded: Use $GetKey$<keyvalue> input.

point_viewcontrol

A camera entity capable to force the viewport of any desired players to use its own. VDC page

Inputs

Input	Description
$EnableAll	Enable the camera for all players on the map.  ❗ Warning: Spawnflag #512 may not do anything. (Start At Player, Interruptable by Player)
$DisableAll	Disable the camera for all players on the map.
$SetTarget <entity>	The entity that the camera should point to.

tank_boss

The big sluggish Tank robot. VDC page

Outputs

Output	Description
$OnStartDeploy	Fired when the tank is deploying the bomb if a condition is fulfilled: Using "spawnflags" "1" Giving the Tank a PointTemplate.

Entity Expansions

obj_sentrygun

The Sentry Gun, one of Engineer's buildings. VDC page
Spawnflags

• [64] - Spawn as mini-sentry

tf_point_weapon_mimic

An entity that mimics firing of various projectiles, as if a player shot the projectile. VDC page
Miscellaneous

> Killing the mimic entity now automatically removes all of its Stickybombs.
> Setting an owner with $SetOwner or $InheritOwner will assign the same owner to fired projectiles are assigned the same owner.
> Mimic can shoot bullets if WeaponType is set to 4. It can be customised with these keyvalues:

> SpeedMax - max distance (infinite if not specified).

> SplashRadius - knockback force.

> If teamnum keyvalue is used, shot projectiles will be assigned a team. (Previously it was always team 3, BLU)

> 2 for RED, 3 for BLU.

Spawnflags

• [1] - Shot projectile callback; fires the OnUser4 output whenever a projectile is shot, with !activator as the projectile.
• [2] - Allow the keyvalues "FireSound" and "ParticleEffect" to have functionality.

Tank (tank_boss)

> When a tank with PointTemplate(s) starts deploying, "OnUser4" output is fired.

Medic shield (entity_medigun_shield)

Spawnflags

• [1] - Never expire, and don't block LOS
• [2] - Spawn as LV2 Shield

logic_case

Text formatter

With the use of the added inputs, logic_case can be transformed into a text formatter, replacing % in the format string into format parameters.

Example point template usage:

Formatter
{
	OnSpawnOutput
	{
		Target "formattest"
		Action "$Format"
		Delay 1
	}
	logic_case
	{
		"targetname" "formattest"
		"case16" "You have % out of % coins left. % %% done" // Formatter string
		"case01" "6" //First argument
		"case02" "12" //Second argument
		"case03" "50" //Third argument
		"ondefault" "player,$DisplayTextCenter,,0,-1"
	}
}

This would display "You have 6 out of 12 coins left. 50 % done" to all players

Inputs

Output	Description
$Format	Start a string format. When finished, fires OnDefault output with the formatted string as parameter.
$FormatInput1-15 <string>	Sets a respective formatting input's argument, then starts a string format.
$FormatInputNoFire1-15 <string>	Functionally, its $FormatInput1-15 without starting a string format.
$FormatString <string>	Sets the string to be used in formatting, then starts a string format.
$FormatStringNoFire <string>	Functionally, its $FormatString without starting a string format.

Menus

Sourcemod Menus are displayed using the $DisplayMenu input.

Case16 title, Case01-15 choices.

Example:

Menu
{
	OnSpawnOutput
	{
		Target "menutest"
		Action "$DisplayMenu"
		Delay 1
		Param "player"
	}
	logic_case
	{
		"targetname" "menutest"
		"case16" "Menu title|30|Cancel" // Title, menu duration (0 for infinite), display optional cancel button
		"case01" "option1" //First argument
		"case02" "!disabled option" //Second argument, disabled
		"case03" "suicide" //Third argument
		"oncase03" "!activator,sethealth,0,0,-1" // Selected 3rd option
		"ondefault" "player,$DisplayTextCenter,he,0,-1" // No option selected
	}
}

Inputs

Output	Description
$DisplayMenu <entity>	Start displaying a menu to the player entity.
$HideMenu <entity>	Forcefully hide the player's menu.

tf_gamerules

Inputs

• $StopVO <string>
  • Stops sound that was started with PlayVO input

• $StopVORed <string>
  • Stops sound that was started with PlayVORed input

• $StopVOBlue <string>
  • Stops sound that was started with PlayVOBlue input
• $SetBossHealthPercentage <float>
  • Set Halloween boss bar percentage to a value between 0 and 1. 0 hides the health bar, any other value makes the bar appear
• $SetBossState <int>
  • If set to 1, makes the health bar green, like if Merasmus is hiding. If set to 0, the bar goes back to normal
• $AddCurrencyGlobal <int>
  • Add currency to all players

player

Inputs

• $AllowClassAnimations <0|1>
  • Allow class animations instead of using refpose when UseCustomModel input is fired to change player model
• $SwitchClass <string>
  • Switch player class. The parameter can be either a class name (heavyweapons for example), or class index
• $SwitchClassInPlace <string>
  • Switch player class in current position. The parameter can be either a class name (heavyweapons for example), or class index
• $ForceRespawn
  • The player instantly respawns
• $ForceRespawnDead
  • The player instantly respawns, but only if they are dead
• $DisplayTextCenter <string>
  • Display text in the middle of the screen
• $DisplayTextChat <string>
  • Display text to the player's chat
• $Suicide
  • Kill the player
• $ChangeAttributes <string>
  • If the player is a bot, this can be used to change active EventChangeAttributes
• $RollCommonSpell
  • Roll common spell
• $SetSpell <string>
  • Set player current spell to one of the following:
    • Fireball
    • Ball O' Bats
    • Healing Aura
    • Pumpkin MIRV
    • Superjump
    • Invisibility
    • Teleport
    • Tesla Bolt
    • Minify
    • Meteor Shower
    • Summon Monoculus
    • Summon Skeletons
• $AddSpell <string>
  • Adds spell to the number of spells. If the spell is different than the current one, it replaces the spell. The parameter is the same as in $SetSpell
• $AddCond <int> [int]
  • Add condition to player. If a second argument is present, the condition will only run for a specified duration
• $RemoveCond <int>
  • Remove condition from player
• $AddPlayerAttribute <string>
  • Add attribute to player, the parameter should be passed in this way: attribute|value. Example: "move speed bonus|1.2"
• $RemovePlayerAttribute <string>
  • Remove attribute from player. Example: "move speed bonus"
• $AddItemAttribute <string>
  • Add attribute to item in slot, the parameter should be passed in this way: attribute|value|slot. Example "damage bonus|2|0" adds 100% damage bonus to primary weapon
• $RemoveItemAttribute <string>
  • Remove attribute from item in slot, the parameter should be passed in this way: attribute|slot. Example "damage bonus|0" removes damage bonus from primary weapon
• $PlaySoundToSelf <string>
  • Play sound to the player
• $IgnitePlayerDuration <float>
  • Ignite the player for a specified duration in seconds
• $WeaponSwitchSlot <int>
  • Forcibly switches to weapon in slot
• $WeaponStripSlot <int>
  • Removes weapon from a slot (-1 = current slot)
• $GiveItem <string>
  • Gives an item to the player
• $AddCurrency <int>
  • Add currency to the player
• $RemoveCurrency <int>
  • Remove currency from the player
• $SetCurrency <int>
  • Set currency to specified value
• $CurrencyOutputX <string>
  • Fires input if player currency is above specified value (the X in input name), the attribute should be passed in this way: target,input,parameter.
• $CurrencyInvertOutputX<string>
  • Fires input if player currency is below specified value(the X in input name), the attribute should be passed in this way: target,input,parameter
• $DropItem <int>
  • Drop item in slot (-1 = current slot)
• $RemoveItem <string>
  • Remove item with a name
• $Regenerate
  • Regenerate the player, as if touching resupply cabinet
• $RefillAmmo
  • Restore player ammo

trigger_hurt

If entity owner is set with $SetOwner or $InheritOwner, the owner will become the damage inflictor

Filter entities

The server will no longer crash if the activator entity got removed the time TestActivator is called

Inputs

• $TestEntity <entity>
  • Test any entity, rather than only the !activator

Trigger entities

The server will no longer crash if the caller entity got removed the time StartTouch or EndTouch is called

Inputs

• $StartTouchEntity <entity>
  • StartTouch any entity, rather than only the !caller
• $EndTouchEntity <entity>
  • EndTouch any entity, rather than only the !caller

game_ui

The server will no longer crash if the player using the entity disconnected from the server