View source for User:Windolon/PopExtensionsPlus Documentation

{{toc-right}}
{{sq}} This is the documentation for [https://github.com/potato-tf/PopExtensionsPlus PopExtensionsPlus], a [[VScript]] library for use in {{tf2|4}}.
{{tip|While it is generally discouraged to edit user pages, please feel free to contribute and edit away! This is because this is a documentation, not something personal. You can do so here and in all other subpages of the documentation.}}

== Constants ==

:''See [[User:Windolon/PopExtensionsPlus_Documentation/Constants|this page]] for a full list of constants available from the library.''

== Script function additions ==

{{warning|PopExtensionsPlus modifies <code>AddThinkToEnt</code> so that the native function is unavailable for use. Trying to call <code>AddThinkToEnt</code> will result in a library-raised error. Use <code>PopExtUtil.AddThinkToEnt</code> instead. If you need to call <code>AddThinkToEnt</code> anyway, use <code>_AddThinkToEnt</code>. More about this [[User:Windolon/PopExtensionsPlus_Documentation#:~:text=AddThinkToEnt,-void|below]].}}

=== PopExtensions ===

These script functions come from the original repository that this library is forked from, and are accessed from the table <code>PopExt</code>. E.g. To call the <code>AddRobotTag</code> function, write <code>PopExt.AddRobotTag</code>.

{| class="standard-table" style="width:100%"
|- style="position:sticky; z-index:10; top:0"
! Function
! Signature
! Description
|-
| <code>_PopIncrementIcon</code>
| <code> void _PopIncrementIcon(table ''icon'')</code>
| A function that is used internally to handle adding custom icons. Generally does not need to be touched.
|-
| <code>_PopIncrementTankIcon</code>
| <code> void _PopIncrementTankIcon(table ''icon'')</code>
| A function that is used internally to handle adding custom tank icons. Generally does not need to be touched.
|-
| <code>AddCustomIcon</code>
| <code>void AddCustomIcon(string ''name'', int ''count'', bool ''isCrit = false'', bool ''isBoss = false'', bool ''isSupport = false'', bool ''isSupportLimited = false'')</code>
| Add custom icon to the wavebar, should be called in InitWaveOutput.
|-
| <code>AddCustomTankIcon</code>
| <code>void AddCustomTankIcon(string ''name'', int ''count'', bool ''isCrit = false'', bool ''isBoss = false'', bool ''isSupport = false'', bool ''isSupportLimited = false'')</code>
| Add custom tank icon to the wavebar, should be called in InitWaveOutput.
{{note|In the original PopExtensions documentation, it is warned that functions which change wavebar icons will crash linux servers.
{{todo|How true is this?}}}}
|-
| <code>[[User:Windolon/PopExtensionsPlus_Documentation/AddRobotTag|AddRobotTag]]</code>
| <code>void AddRobotTag(string ''tag'', table ''hooks'')</code>
| Adds hooks to robots with specified popfile <code>Tag</code>. See [[User:Windolon/PopExtensionsPlus_Documentation/AddRobotTag|main page]] for more details.
|-
| <code>AddTankName</code>
| <code>void AddTankName(string ''name'', table ''hooks'')</code>
| Adds hooks to tanks with specified popfile <code>Name</code>. Wildcard <code>*</code> suffix is supported.
|-
| <code>SetWaveIconsFunction</code>
| <code>void SetWaveIconsFunction(function ''func'')</code>
| Use this function if you want to use <code>IncrementWaveIconSpawnCount</code> functions to add icons to the wavebar.
|}

==== Wavebar function flags ====

These flags are used as inputs to the wavebar functions described below. They are accessible without the need to prefix. These are also inserted into root table so that they are available in popfile RunScriptCode params.

{| class = "standard-table"
! Name
! Value
! Description
|-
| <code>MVM_CLASS_FLAG_NONE</code>
| 0
|
|-
| <code>MVM_CLASS_FLAG_NORMAL</code>
| 1
| Non support or mission icon.
|-
| <code>MVM_CLASS_FLAG_SUPPORT</code>
| 2
| Support icon flag. Mission icon does not have this flag.
|-
| <code>MVM_CLASS_FLAG_MISSION</code>
| 4
| Mission icon flag. Support icon does not have this flag.
|-
| <code>MVM_CLASS_FLAG_MINIBOSS</code>
| 8
| Giant icon flag. Support and mission icons do not display red background when set.
|-
| <code>MVM_CLASS_FLAG_ALWAYSCRIT</code>
| 16
| Crit icon flag. Support and mission icons do not display crit outline when set.
|-
| <code>MVM_CLASS_FLAG_SUPPORT_LIMITED</code>
| 32
| Support limited flag. Game uses it together with support flag.
|}

==== Wavebar functions ====

These functions, to reiterate, are accessed from the table <code>PopExt</code>.

{| class="standard-table" style="width:100%"
|- style="position:sticky; z-index:10; top:0"
! Function
! Signature
! Description
|-
| <code>DecrementWaveIconSpawnCount</code>
| <code>void/int DecrementWaveIconSpawnCount(string ''name'', int ''flags'', int ''count = 1'', bool ''changeMaxEnemyCount = false'')</code>
| Increment wavebar spawn count of an icon with specified name and flags. Use it to decrement the spawn count when the enemy is killed. Should not be used for support type icons.
{{warning|Documentation is taken from the original repository. The description seems to be contradictory?}}
|-
| <code>GetWaveIconActive</code>
| <code>bool GetWaveIconActive(string ''name'', int ''flags'')</code>
| Used for mission and support limited bots to display them on a wavebar during the wave, set by the game automatically when an enemy with this icon spawns.
|-
| <code>GetWaveIconSpawnCount</code>
| <code>int GetWaveIconSpawnCount(string ''name'', int ''flags'')</code>
| Get wavebar spawn count of an icon with specified name and flags.
|-
| <code>IncrementWaveIconSpawnCount</code>
| <code>int IncrementWaveIconSpawnCount(string ''name'', int ''flags'', int ''count = 1'', bool ''changeMaxEnemyCount = true'')</code>
| Increment wavebar spawn count of an icon with specified name and flags. Can be used to put custom icons on a wavebar. This function always returns 0.
|-
| <code>SetWaveIconActive</code>
| <code>void SetWaveIconActive(string ''name'', int ''flags'', bool ''active'')</code>
| Used for mission and support limited bots to display them on a wavebar during the wave, set by the game automatically when an enemy with this icon spawns.
|-
| <code>SetWaveIconSpawnCount</code>
| <code>void SetWaveIconSpawnCount(string ''name'', int ''flags'', int ''count'', bool ''changeMaxEnemyCount = true'')</code>
| Set wavebar spawn count of an icon with specified name and flags. If <code>count</code> is set to 0, removes the icon from the wavebar. Can be used to put custom icons on a wavebar.
|}

=== Utilities ===

Some useful utility variables and functions have been provided. They are all accessed from the table <code>PopExtUtil</code>.

==== Variables ====

===== Arrays and tables =====

{| class="standard-table"
! Name
! Type
! Description
|-
| <code>AllNavAreas</code>
| table
| desc
|-
| <code>BotArray</code>
| array
| desc
|-
| <code>Classes</code>
| array
| desc
|-
| <code>ClassesCaps</code>
| array
| desc
|-
| <code>DeflectableProjectiles</code>
| table
| desc
|-
| <code>HomingProjectiles</code>
| table
| desc
|-
| <code>HUMAN_ARM_PATHS</code>
| array
| desc
|-
| <code>HumanArray</code>
| array
| desc
|-
| <code>ItemBlacklist</code>
| array
| desc
|-
| <code>ItemWhitelist</code>
| array
| desc
|-
| <code>MaxAmmoTable</code>
| table
| desc
|-
| <code>PlayerArray</code>
| array
| desc
|-
| <code>ROBOT_ARM_PATHS</code>
| array
| desc
|-
| <code>ROMEVISION_MODELINDEXES</code>
| array
| desc
|-
| <code>ROMEVISION_MODELS</code>
| table
| desc
|-
| <code>Slots</code>
| array
| desc
|}

===== Other types =====

{| class="standard-table"
! Name
! Type
! Description
|-
| <code>ClientCommand</code>
| handle
| desc
|-
| <code>CurrentWaveNum</code>
| integer
| desc
|-
| <code>FinishedRelay</code>
| handle
| desc
|-
| <code>GameRoundWin</code>
| handle
| desc
|-
| <code>GameRules</code>
| handle
| desc
|-
| <code>IsWaveStarted</code>
| boolean
| desc
|-
| <code>MonsterResource</code>
| handle
| desc
|-
| <code>MvMLogicEnt</code>
| handle
| desc
|-
| <code>MvMStatsEnt</code>
| handle
| desc
|-
| <code>ObjectiveResource</code>
| handle
| desc
|-
| <code>PlayerManager</code>
| handle
| desc
|-
| <code>RespawnOverride</code>
| handle
| desc
|-
| <code>StartRelay</code>
| handle
| desc
|-
| <code>TriggerHurt</code>
| handle
| desc
|-
| <code>Worldspawn</code>
| handle
| desc
|}

==== Functions ====

{| class="standard-table" style="width:100%"
|- style="position:sticky; z-index:10; top:0"
! Function
! Signature
! Description
|-
| <code>_SetOwner</code>
| <code>_SetOwner()</code>
| desc
|-
| <code>AddAttributeToLoadout</code>
| <code>AddAttributeToLoadout()</code>
| desc
|-
| <code>AddThinkToEnt</code>
| <code>void AddThinkToEnt(handle ''ent'', string ''func'')</code>
| desc
|-
| <code>AnglesToVector</code>
| <code>AnglesToVector()</code>
| desc
|-
| <code>ApproachAngle</code>
| <code>ApproachAngle()</code>
| desc
|-
| <code>capwords</code>
| <code>capwords()</code>
| desc
|-
| <code>ChangePlayerTeamMvM</code>
| <code>ChangePlayerTeamMvM()</code>
| desc
|-
| <code>CheckBitwise</code>
| <code>CheckBitwise()</code>
| desc
|-
| <code>Clamp</code>
| <code>Clamp()</code>
| desc
|-
| <code>ClearLastKnownArea</code>
| <code>ClearLastKnownArea()</code>
| desc
|-
| <code>CopyTable</code>
| <code>CopyTable()</code>
| desc
|-
| <code>CountAliveBots</code>
| <code>CountAliveBots()</code>
| desc
|-
| <code>CountAlivePlayers</code>
| <code>CountAlivePlayers()</code>
| desc
|-
| <code>CreatePlayerWearable</code>
| <code>CreatePlayerWearable()</code>
| desc
|-
| <code>DisableCloak</code>
| <code>DisableCloak()</code>
| desc
|-
| <code>DoExplanation</code>
| <code>DoExplanation()</code>
| desc
|-
| <code>DoPrintTable</code>
| <code>DoPrintTable()</code>
| desc
|-
| <code>EndWaveReverse</code>
| <code>EndWaveReverse()</code>
| desc
|-
| <code>Explanation</code>
| <code>Explanation()</code>
| desc
|-
| <code>ForceChangeClass</code>
| <code>ForceChangeClass()</code>
| desc
|-
| <code>GetAllEnts</code>
| <code>GetAllEnts()</code>
| desc
|-
| <code>GetEntityColor</code>
| <code>GetEntityColor()</code>
| desc
|-
| <code>GetHammerID</code>
| <code>GetHammerID()</code>
| desc
|-
| <code>GetItemIndex</code>
| <code>GetItemIndex()</code>
| desc
|-
| <code>GetItemInSlot</code>
| <code>GetItemInSlot()</code>
| desc
|-
| <code>GetPlayerName</code>
| <code>GetPlayerName()</code>
| desc
|-
| <code>GetPlayerReadyCount</code>
| <code>GetPlayerReadyCount()</code>
| desc
|-
| <code>GetPlayerSteamID</code>
| <code>GetPlayerSteamID()</code>
| desc
|-
| <code>GetPlayerUserID</code>
| <code>GetPlayerUserID()</code>
| desc
|-
| <code>GetPopfileName</code>
| <code>GetPopfileName()</code>
| desc
|-
| <code>GetSpawnFlags</code>
| <code>GetSpawnFlags()</code>
| desc
|-
| <code>GetWeaponMaxAmmo</code>
| <code>GetWeaponMaxAmmo()</code>
| desc
|-
| <code>GiveWeapon</code>
| <code>GiveWeapon()</code>
| desc
|-
| <code>HasEffect</code>
| <code>HasEffect()</code>
| desc
|-
| <code>HasItemInLoadout</code>
| <code>HasItemInLoadout()</code>
| desc
|-
| <code>HexToRgb</code>
| <code>HexToRgb()</code>
| desc
|-
| <code>HideAnnotation</code>
| <code>HideAnnotation()</code>
| desc
|-
| <code>Ignite</code>
| <code>Ignite()</code>
| desc
|-
| <code>InButton</code>
| <code>InButton()</code>
| desc
|-
| <code>Info</code>
| <code>Info()</code>
| desc
|-
| <code>IntersectionPointBox</code>
| <code>IntersectionPointBox()</code>
| desc
|-
| <code>InUpgradeZone</code>
| <code>InUpgradeZone()</code>
| desc
|-
| <code>IsAlive</code>
| <code>IsAlive()</code>
| desc
|-
| <code>IsDucking</code>
| <code>IsDucking()</code>
| desc
|-
| <code>IsEntityClassnameInList</code>
| <code>IsEntityClassnameInList()</code>
| desc
|-
| <code>IsLinuxServer</code>
| <code>IsLinuxServer()</code>
| desc
|-
| <code>IsOnGround</code>
| <code>IsOnGround()</code>
| desc
|-
| <code>IsPointInRespawnRoom</code>
| <code>IsPointInRespawnRoom()</code>
| desc
|-
| <code>IsPointInTrigger</code>
| <code>IsPointInTrigger()</code>
| desc
|-
| <code>IsSpaceToSpawnHere</code>
| <code>IsSpaceToSpawnHere()</code>
| desc
|-
| <code>KillAllBots</code>
| <code>KillAllBots()</code>
| desc
|-
| <code>KillPlayer</code>
| <code>KillPlayer()</code>
| desc
|-
| <code>LockInPlace</code>
| <code>LockInPlace()</code>
| desc
|-
| <code>Max</code>
| <code>Max()</code>
| desc
|-
| <code>Min</code>
| <code>Min()</code>
| desc
|-
| <code>NormalizeAngle</code>
| <code>NormalizeAngle()</code>
| desc
|-
| <code>OnWeaponFire</code>
| <code>OnWeaponFire()</code>
| desc
|-
| <code>PlayerClassCount</code>
| <code>PlayerClassCount()</code>
| desc
|-
| <code>PlayerRespawn</code>
| <code>PlayerRespawn()</code>
| desc
|-
| <code>PlayerRobotModel</code>
| <code>PlayerRobotModel()</code>
| desc
|-
| <code>PlaySoundOnAllClients</code>
| <code>PlaySoundOnAllClients()</code>
| desc
|-
| <code>PlaySoundOnClient</code>
| <code>PlaySoundOnClient()</code>
| desc
|-
| <code>PrecacheParticle</code>
| <code>PrecacheParticle()</code>
| desc
|-
| <code>PressButton</code>
| <code>PressButton()</code>
| desc
|-
| <code>PrintTable</code>
| <code>PrintTable()</code>
| desc
|-
| <code>QAngleDistance</code>
| <code>QAngleDistance()</code>
| desc
|-
| <code>ReleaseButton</code>
| <code>ReleaseButton()</code>
| desc
|-
| <code>RemapVal</code>
| <code>RemapVal()</code>
| desc
|-
| <code>RemapValClamped</code>
| <code>RemapValClamped()</code>
| desc
|-
| <code>RemoveAmmo</code>
| <code>RemoveAmmo()</code>
| desc
|-
| <code>RemoveOutputAll</code>
| <code>RemoveOutputAll()</code>
| desc
|-
| <code>RemovePlayerWearables</code>
| <code>RemovePlayerWearables()</code>
| desc
|-
| <code>Round</code>
| <code>Round()</code>
| desc
|-
| <code>SetDestroyCallback</code>
| <code>SetDestroyCallback()</code>
| desc
|-
| <code>SetEffect</code>
| <code>SetEffect()</code>
| desc
|-
| <code>SetEntityColor</code>
| <code>SetEntityColor()</code>
| desc
|-
| <code>SetItemIndex</code>
| <code>SetItemIndex()</code>
| desc
|-
| <code>SetParentLocalOrigin</code>
| <code>SetParentLocalOrigin()</code>
| desc
|-
| <code>SetParentLocalOriginDo</code>
| <code>SetParentLocalOriginDo()</code>
| desc
|-
| <code>SetPlayerAttributes</code>
| <code>SetPlayerAttributes()</code>
| desc
|-
| <code>SetPlayerClassRespawnAndTeleport</code>
| <code>SetPlayerClassRespawnAndTeleport()</code>
| desc
|-
| <code>SetPlayerName</code>
| <code>SetPlayerName()</code>
| desc
|-
| <code>SetTargetname</code>
| <code>SetTargetname()</code>
| desc
|-
| <code>SetupTriggerBounds</code>
| <code>SetupTriggerBounds()</code>
| desc
|-
| <code>ShowAnnotation</code>
| <code>ShowAnnotation()</code>
| desc
|-
| <code>ShowChatMessage</code>
| <code>ShowChatMessage()</code>
| desc
|-
| <code>ShowHudHint</code>
| <code>ShowHudHint()</code>
| desc
|-
| <code>ShowMessage</code>
| <code>ShowMessage()</code>
| desc
|-
| <code>ShowModelToPlayer</code>
| <code>ShowModelToPlayer()</code>
| desc
|-
| <code>SilentDisguise</code>
| <code>SilentDisguise()</code>
| desc
|-
| <code>SpawnEffect</code>
| <code>SpawnEffect()</code>
| desc
|-
| <code>splitonce</code>
| <code>splitonce()</code>
| desc
|-
| <code>StopAndPlayMVMSound</code>
| <code>StopAndPlayMVMSound()</code>
| desc
|-
| <code>StringReplace</code>
| <code>StringReplace()</code>
| desc
|-
| <code>StripWeapon</code>
| <code>StripWeapon()</code>
| desc
|-
| <code>StunPlayer</code>
| <code>StunPlayer()</code>
| desc
|-
| <code>SwitchToFirstValidWeapon</code>
| <code>SwitchToFirstValidWeapon()</code>
| desc
|-
| <code>SwitchWeaponSlot</code>
| <code>SwitchWeaponSlot()</code>
| desc
|-
| <code>TeleportNearVictim</code>
| <code>TeleportNearVictim()</code>
| desc
|-
| <code>VectorAngles</code>
| <code>VectorAngles()</code>
| desc
|-
| <code>WeaponSwitchSlot</code>
| <code>WeaponSwitchSlot()</code>
| desc
|}

== Custom attributes ==

The following table is similar to the [https://wiki.teamfortress.com/wiki/List_of_item_attributes item attributes table] found on the TF2 wiki, which lists:
* '''Name''': Internal name of the attribute.
* '''Description''': The hud hint text that displays when the user inspects the weapon with the attribute. "<code>'''%s1'''</code>", "<code>'''%s2'''</code>" and so on are replaced with the value of the attribute.
Unless otherwise stated, all values are formatted additively for display, i.e. by their flat value.

{| class="standard-table" style="width:100%"
|- style="position:sticky; z-index:10; top:0"
! Name
! Description
! Notes
|-
| add cond on hit
| applies cond '''%s1''' to victim on hit
| Accepts both an integer value and a length-2 array of an integer and a float. The float controls how long the cond will last.
|-
| add cond when active
| when active: player receives cond '''%s1'''
|
|-
| alt-fire disabled
| Secondary fire disabled
|
|-
| always crit
| Weapon always crits
|
|-
| arrow ignite
| arrows are always ignited
|
|-
| build small sentries
| Sentries are 20⁒ smaller, have 33⁒ less health, take 25⁒ less metal to upgrade
|
|-
| can breathe under water
| Player can breathe underwater
|
|-
| can headshot
| Crits on headshot
|
|-
| cannot be headshot
| Immune to headshots
|
|-
| cannot headshot
| weapon cannot headshot
|
|-
| cannot upgrade
| Weapon cannot be upgraded
|
|-
| collect currency on kill
| bots drop money when killed
|
|-
| crit when health below
| Player is crit boosted when below '''%s1''' health
|
|-
| custom kill icon
| Custom kill icon: '''%s1'''
| The input should be a string of the name of the kill icon, for example <code>"megaton"</code>. The full list can be found [https://developer.valvesoftware.com/w/images/9/9c/Tf2_kill_icons.png here].
|-
| custom projectile model
| Fires custom projectile model: '''%s1'''
| The input should be a string of the directory to the model, for example <code>"models/empty.mdl"</code>.
|-
| dmg bonus while half dead
| damage bonus while under 50% health
|
|-
| dmg penalty while half alive
| damage penalty while above 50% health
|
|-
| dont count damage towards crit rate
| Damage doesn't count towards crit rate
|
|-
| {{obs}} explosive bullets
| Fires explosive rounds that deal '''%s1''' damage
| Obsolete. Use <code>explosive bullets ext</code> instead.
|-
| explosive bullets ext
| Fires explosive rounds that deal '''%s1''' damage in a radius of '''%s2'''
| The input should be a table of keyvalues:
<syntaxhighlight lang=js>
"explosive bullets ext":
{
	// the values here are defaults, modify at will
	damage   = 150
	radius   = 150
	team     = player.GetTeam() // player is the owner of the weapon with this attribute
	model    = ""
	particle = "mvm_loot_explosion"
	sound    = "weapons/pipe_bomb1.wav"
	killicon = "megaton"
}
</syntaxhighlight>
Here, '''%s1''' is the damage value, and '''%s2''' is the radius value in hammer units.
|-
| fire full clip at once
| weapon fires full clip at once
| {{note|Not implemented yet}}
|-
| fire input on hit
| fires custom entity input on hit: '''%s1'''
| The input should be a string of <code>EntFire</code> inputs excluding the <code>activator</code>, separated by the ^ symbol. The target can also be <code>!self</code>. (The player who wields the weapon with this attribute.)
Example usage:
<syntaxhighlight>
"fire input on hit": "BigNet^RunScriptCode^printl(\`Someone got hit 2 seconds ago!\`)^2"
</syntaxhighlight>
The <code>value</code> and <code>delay</code> EntFire inputs default to <code>""</code> and <code>-1</code>.
|-
| fire input on kill
| fires custom entity input on kill: '''%s1'''
| The input should be a string of <code>EntFire</code> inputs excluding the <code>activator</code>, separated by the ^ symbol. The target can also be <code>!self</code>. (The player who wields the weapon with this attribute.)
Example usage:
<syntaxhighlight>
"fire input on kill": "BigNet^RunScriptCode^printl(\`Someone got killed 2 seconds ago!\`)^2"
</syntaxhighlight>
The <code>value</code> and <code>delay</code> EntFire inputs default to <code>""</code> and <code>-1</code>.
|-
| fires milk bolt
| Secondary attack: fires a bolt that applies milk for '''%s1''' seconds. Regenerates every '''%s2''' seconds.
| The input should be a table of keyvalues:
<syntaxhighlight lang=js>
"fires milk bolt":
{
	// the values here are defaults, modify at will
	duration = 10.0
	recharge = 20.0
}
</syntaxhighlight>
|-
| immune to cond
| wielder is immune to cond '''%s1'''
| Accepts a simple integer input, or an array of integers. Array length has no limit. The attribute will remove all from the array. The inspection text displays accordingly.
|-
| is invisible
| Weapon is invisible
|
|-
| is miniboss
| When weapon is active: player becomes giant
| {{note|Not implemented yet}}
|-
| last shot crits
| Crit boost on last shot. Crit boost will stay active for '''%s1''' seconds after holster
|
|-
| melee cleave attack
| On Swing: Weapon hits multiple targets
| The input value controls how big the cleave/splash radius is, in hammer units. Set it to 64 for fair results.
|-
| mod teleporter speed boost
| Teleporters grant a speed boost for '''%s1''' seconds upon exiting
|
|-
| mult building scale
| building scale multiplied by '''%s1'''
|
|-
| mult crit dmg
| crit damage multiplied by '''%s1'''
|
|-
| mult dmg vs airborne
| damage multiplied by '''%s1''' against airborne targets
|
|-
| mult dmg vs giants
| Damage vs giants multiplied by '''%s1'''
|
|-
| mult dmg vs same class
| Damage versus ''[player's own class]'' multiplied by '''%s1'''
|
|-
| mult dmg vs tanks
| Damage vs tanks multiplied by '''%s1'''
|
|-
| mult max health
| Player max health is multiplied by '''%s1'''
|
|-
| mult projectile scale
| projectile scale multiplied by '''%s1'''
|
|-
| mult swim speed
| Swimming speed multiplied by '''%s1'''
|
|-
| mult teleporter recharge rate
| Teleporter recharge rate multiplied by '''%s1'''
| {{note|Not implemented yet}}
|-
| mvm sentry ammo
| Sentry ammo multiplied by '''%s1'''
| {{note|Not implemented yet}}
|-
| no damage falloff
| Weapon has no damage fall-off or ramp-up
|
|-
| noclip projectile
| projectiles go through walls and enemies harmlessly
|
|-
| old sandman stun
| Uses pre-JI stun mechanics
|
|-
| passive reload
| weapon reloads when holstered
|
|-
| projectile gravity
| projectile gravity '''%s1''' hu/s
|
|-
| projectile lifetime
| projectile disappears after '''%s1''' seconds
|
|-
| radius sleeper
| On full charge headshot: create jarate explosion on victim
|
|-
| reloads full clip at once
| This weapon reloads its entire clip at once.
|
|-
| remove cond on hit
| Remove cond '''%s1''' on hit
|
|-
| replace weapon fire sound
| Weapon fire sound replaced with '''%s1'''
| Sound name can be raw filename or soundscript as this uses [[Team Fortress 2/Scripting/Script Functions/EmitSoundEx|EmitSoundEx]].
|-
| rocket penetration
| rocket penetrates up to '''%s1''' enemy players
|
|-
| self add cond on hit
| applies cond '''%s1''' to self on hit
| Accepts both an integer value and a length-2 array of an integer and a float. The float controls how long the cond will last.
|-
| self add cond on kill
| applies cond '''%s1''' to self on kill
| Accepts both an integer value and a length-2 array of an integer and a float. The float controls how long the cond will last.
|-
| set damage type
| Damage type set to '''%s1'''
| Combinable damage types. See [[Team_Fortress_2/Scripting/Script_Functions/Constants#FDmgType|Constants.FDmgType]] for a full list.
|-
| set damage type custom
| Custom damage type set to '''%s1'''
| Only one custom damage type may be set. See [[Team_Fortress_2/Scripting/Script_Functions/Constants#ETFDmgCustom|Constants.ETFDmgCustom]] for a full list.
|-
| set turn to ice
| On Kill: Turn victim to ice.
|
|-
| special item description
| '''%s1'''
| A purely cosmetic attribute used to give extra description.
|-
| stun on hit
| Stuns victim for '''%s1''' seconds on hit
| The input should be a table of keyvalues:
<syntaxhighlight lang=js>
"stun on hit":
{
	// the values here are defaults, modify at will
	duration   = 5
	type       = 2
	speedmult  = 0.2
	stungiants = true
}
</syntaxhighlight>
The <code>duration</code> key is '''%s1'''.
|-
| teleport instead of die
| '''%s1'''⁒ chance of teleporting to spawn with 1 health instead of dying
| The value is formatted as a percentage, so setting to 0.75 means a 75% chance of escaping death.
|-
| uber on damage taken
| On take damage: '''%s1'''⁒ chance of gaining invicibility for 3 seconds
| The value is formatted as a percentage, so setting to 0.75 means a 75% chance of getting uber.
|-
| wet immunity
| Immune to jar effects when active
|
|}

== Mission attributes ==



== Robot tags ==