Fortress Forever Wiki - User contributions [en]

Lua:AddHudText

2021-04-16T04:08:22Z

R00Kie: /* Input */

{{Infobox manual/Header}}
==AddHudText==

Puts a text object on a player's screen.

===Usage===
<pre>AddHudText(player, text_id, text, a, b, c, d)</pre>

===Input===
* player(CFFPlayer) The player receiving the text
* text_id(string) the name of this text (so we can remove it later)
* text(string) The text to display
* a(integer) x position
* b(integer) y position
* c(integer) horizontal alignment
* d(integer) vertical alignment

===Output===
Returns: nothing

===Example===
<pre>local player = CastToPlayer( player_entity )
AddHudText( player, "hunted_location", "Hunted Location: " .. player_hunted:GetLocation(), 4, 44, 0, 1 )</pre>

[[Category:HUD_Items]]
{{Infobox manual/Footer}}

Category:HUD Items

2017-07-12T11:21:41Z

R00Kie:

{{Infobox manual/Header}}
{{Infobox_mapping}}
HUD items are visuals you can stick up on the player's screen through Lua. We use them for showing the player flag status and other useful information.

{| border="1" cellspacing="0"
! LUA Command !! Description
|-
| [[Lua:AddHudIcon|AddHudIcon]]( player, HudIconType, NameOfHudIcon, X, Y, Width, Height, Align ) || adds HUD icon to given player of given type. Name is generally taken from the flag entity to apply the right kind. X, Y, W, H, and A are all standard.
|-
| [[Lua:AddHudIconToAll|AddHudIconToAll]]( HudIconType, NameOfHudUcon, X, Y, W, H, A ) || adds HUD icon to all players like those used for flag info.
|-
| [[Lua:AddHudText|AddHudText]] || Puts a bit of text on the screen.
|-
| [[Lua:AddHudTextToAll|AddHudTextToAll]] ||
|-
| [[Lua:AddHudTimer|AddHudTimer]] || Puts a countdown timer on the screen of one player.
|-
| [[Lua:AddHudTimerToTeam|AddHudTimerToTeam]] || Puts a countdown timer on the screen of players on a specified team.
|-
| [[Lua:AddHudTimerToAll|AddHudTimerToAll]] ||
|-
| [[AddHudBox]](player, identifier, x, y, width, height, CustomColor, CustomBorder, xalign, yalign ) ||
|-
| [[AddHudBoxToTeam]](team, identifier, x, y, width, height, CustomColor, CustomBorder, xalign, yalign ) ||
|-
| [[AddHudBoxToAll]](identifier, x, y, width, height, CustomColor, CustomBorder, xalign, yalign ) ||Adds a hud box to the screen. Color and border are set with CustomColor(r, g, b, a) and CustomBorder(CustomColor(), width)
|-
| [[Lua:RemoveHudItem|RemoveHudItem]] ||
|-
| [[Lua:RemoveHudItemFromAll|RemoveHudItemFromAll]] ||
|}

Additionally, see [[Lua:Timer]] for a more useful way to control HUD timers.
[[Category:Lua_Commands]]
{{Infobox manual/Footer}}

Category:HUD Items

2017-07-12T11:20:28Z

R00Kie:

{{Infobox manual/Header}}
{{Infobox_mapping}}
HUD items are visuals you can stick up on the player's screen through Lua. We use them for showing the player flag status and other useful information.

{| border="1" cellspacing="0"
! LUA Command !! Description
|-
| [[Lua:AddHudIcon|AddHudIcon]]( player, HudIconType, NameOfHudIcon, X, Y, Width, Height, Align ) || adds HUD icon to given player of given type. Name is generally taken from the flag entity to apply the right kind. X, Y, W, H, and A are all standard.
|-
| [[Lua:AddHudIconToAll|AddHudIconToAll]]( HudIconType, NameOfHudUcon, X, Y, W, H, A ) || adds HUD icon to all players like those used for flag info.
|-
| [[Lua:AddHudText|AddHudText]] || Puts a bit of text on the screen.
|-
| [[Lua:AddHudTextToAll|AddHudTextToAll]] ||
|-
| [[Lua:AddHudTimer|AddHudTimer]] || Puts a countdown timer on the screen of one player.
|-
| [[Lua:AddHudTimerToTeam|AddHudTimerToTeam]] || Puts a countdown timer on the screen of players on a specified team.
|-
| [[Lua:AddHudTimerToAll|AddHudTimerToAll]] ||
|-
| [[AddHudBox]](player, identifier, x, y, width, height, CustomColor, CustomBorder, xalign, yalign ) ||
|-
| [[AddHudBoxToTeam]](team, identifier, x, y, width, height, CustomColor, CustomBorder, xalign, yalign ) ||
|-
| [[AddHudBoxToAll]](identifier, x, y, width, height, CustomColor, CustomBorder, xalign, yalign ) ||Adds a hud box to the screen color and border are set with CustomColor(r, g, b, a) and CustomBorder(CustomColor(), width)
|-
| [[Lua:RemoveHudItem|RemoveHudItem]] ||
|-
| [[Lua:RemoveHudItemFromAll|RemoveHudItemFromAll]] ||
|}

Additionally, see [[Lua:Timer]] for a more useful way to control HUD timers.
[[Category:Lua_Commands]]
{{Infobox manual/Footer}}

Category:Global Callbacks

2017-07-04T09:39:10Z

R00Kie: /* A short list */

{{Infobox mapping}}
These are Callbacks which are not connected with any game entity. Declare the function in your lua script, and the game will run it at the appropriate time.

==Example==
<pre>
function startup()
-- set up team limits
local team = GetTeam( Team.kBlue )
team:SetPlayerLimit( 0 )

team = GetTeam( Team.kRed )
team:SetPlayerLimit( 0 )

team = GetTeam( Team.kYellow )
team:SetPlayerLimit( -1 )

team = GetTeam( Team.kGreen )
team:SetPlayerLimit( -1 )
end
</pre>

==A short list==
This list needs a LOT of work!
*[[Lua:Effect-triggered callbacks]]
*[[Lua:Flaginfo]]
*[[Lua:Startup]]
*[[Lua:shutdown]]() Calls right before map change.
*[[Lua:Tick]]
*[[buildable_killed]] ( buildable, damageinfo )
*[[Lua:player killed]]
*[[Lua:player ondamage]]
*[[Lua:player spawn]]
*[[player_onchat]]( player, chatstring ) Return false to prevent the chat message from being sent to others
*[[Lua:precache]]
*[[Player onkill]]
*[[Player switchteam]]
*[[player_onthrowgren1]]
*[[player_onthrowgren2]]
*[[player_onuse]] ( player )
*[[player_canconnect]]( playername, address, entindex ) Called when a player tries to join the server. Return false to prevent the player from joining.
*[[player_connected]]( player ) Called when a player successfully joins the server
*[[player_disconnected]]( player )
*[[Category:Lua]][[Category:Lua_Callbacks]]

Player throwgren2

2017-07-04T09:38:31Z

R00Kie: R00Kie moved page Player throwgren2 to Player onthrowgren2

#REDIRECT [[Player onthrowgren2]]

Player onthrowgren2

2017-07-04T09:38:31Z

R00Kie: R00Kie moved page Player throwgren2 to Player onthrowgren2

{{Infobox manual/Header}}
==player_onthrowgren2( player, time )==
This function is called whenever a player throws a secondary grenade. Return true or false to allow/disallow the throw.
===Inputs===
player(CFFPlayer) The player trying to throw the grenade
time(float) The time, in seconds, since the grenade was primed.

===Examples===
<pre>function player_onthrowgren2( player, time )
if time < .5 then
ApplyToPlayer( player, {AT.kStopPrimedGrens} )
BroadcastMessageToPlayer(player, "Stop spamming!")
return EVENT_DISALLOWED
end
end
</pre>

[[Category:Lua Callbacks]]
{{Infobox manual/Footer}}

Player onthrowgren2

2017-07-04T09:38:13Z

R00Kie:

Category:Global Callbacks

2017-07-04T09:29:08Z

R00Kie: /* A short list */

{{Infobox mapping}}
These are Callbacks which are not connected with any game entity. Declare the function in your lua script, and the game will run it at the appropriate time.

==Example==
<pre>
function startup()
-- set up team limits
local team = GetTeam( Team.kBlue )
team:SetPlayerLimit( 0 )

team = GetTeam( Team.kRed )
team:SetPlayerLimit( 0 )

team = GetTeam( Team.kYellow )
team:SetPlayerLimit( -1 )

team = GetTeam( Team.kGreen )
team:SetPlayerLimit( -1 )
end
</pre>

==A short list==
This list needs a LOT of work!
*[[Lua:Effect-triggered callbacks]]
*[[Lua:Flaginfo]]
*[[Lua:Startup]]
*[[Lua:shutdown]]() Calls right before map change.
*[[Lua:Tick]]
*[[buildable_killed]] ( buildable, damageinfo )
*[[Lua:player killed]]
*[[Lua:player ondamage]]
*[[Lua:player spawn]]
*[[player_onchat]]( player, chatstring ) Return false to prevent the chat message from being sent to others
*[[Lua:precache]]
*[[Player onkill]]
*[[Player switchteam]]
*[[player_onthrowgren1]]
*[[Player_onthrowgren2]]
*[[player_onuse]] ( player )
*[[player_canconnect]]( playername, address, entindex ) Called when a player tries to join the server. Return false to prevent the player from joining.
*[[player_connected]]( player ) Called when a player successfully joins the server
*[[player_disconnected]]( player )
*[[Category:Lua]][[Category:Lua_Callbacks]]

Player throwgren1

2017-07-04T08:38:20Z

R00Kie: R00Kie moved page Player throwgren1 to Player onthrowgren1

#REDIRECT [[Player onthrowgren1]]

Player onthrowgren1

2017-07-04T08:38:20Z

R00Kie: R00Kie moved page Player throwgren1 to Player onthrowgren1

{{Infobox manual/Header}}
==player_onthrowgren1( player, primetime )==
This function is called whenever a player throws a frag grenade. Return true or false to allow/disallow the throw.
===Inputs===
player(CFFPlayer) The player trying to throw the grenade.
time(float) The time, in seconds, since the grenade was primed.

===Examples===
<pre>function player_onthrowgren1( player, time )
if time < .5 then
ApplyToPlayer( player, {AT.kStopPrimedGrens} )
BroadcastMessageToPlayer(player, "Stop spamming!")
return EVENT_DISALLOWED
end
end
</pre>

[[Category:Lua Callbacks]]
{{Infobox manual/Footer}}

Player onthrowgren1

2017-07-04T08:36:47Z

R00Kie: /* player_onthrowgren1( player, primetime ) */

Category:Global Callbacks

2017-07-04T08:35:48Z

R00Kie: /* A short list */

{{Infobox mapping}}
These are Callbacks which are not connected with any game entity. Declare the function in your lua script, and the game will run it at the appropriate time.

==Example==
<pre>
function startup()
-- set up team limits
local team = GetTeam( Team.kBlue )
team:SetPlayerLimit( 0 )

team = GetTeam( Team.kRed )
team:SetPlayerLimit( 0 )

team = GetTeam( Team.kYellow )
team:SetPlayerLimit( -1 )

team = GetTeam( Team.kGreen )
team:SetPlayerLimit( -1 )
end
</pre>

==A short list==
This list needs a LOT of work!
*[[Lua:Effect-triggered callbacks]]
*[[Lua:Flaginfo]]
*[[Lua:Startup]]
*[[Lua:shutdown]]() Calls right before map change.
*[[Lua:Tick]]
*[[buildable_killed]] ( buildable, damageinfo )
*[[Lua:player killed]]
*[[Lua:player ondamage]]
*[[Lua:player spawn]]
*[[player_onchat]]( player, chatstring ) Return false to prevent the chat message from being sent to others
*[[Lua:precache]]
*[[Player onkill]]
*[[Player switchteam]]
*[[player throwgren1]]
*[[Player throwgren2]]
*[[player_onuse]] ( player )
*[[player_canconnect]]( playername, address, entindex ) Called when a player tries to join the server. Return false to prevent the player from joining.
*[[player_connected]]( player ) Called when a player successfully joins the server
*[[player_disconnected]]( player )
*[[Category:Lua]][[Category:Lua_Callbacks]]

Category:Global Callbacks

2017-07-04T08:35:01Z

R00Kie: /* A short list */

{{Infobox mapping}}
These are Callbacks which are not connected with any game entity. Declare the function in your lua script, and the game will run it at the appropriate time.

==Example==
<pre>
function startup()
-- set up team limits
local team = GetTeam( Team.kBlue )
team:SetPlayerLimit( 0 )

team = GetTeam( Team.kRed )
team:SetPlayerLimit( 0 )

team = GetTeam( Team.kYellow )
team:SetPlayerLimit( -1 )

team = GetTeam( Team.kGreen )
team:SetPlayerLimit( -1 )
end
</pre>

==A short list==
This list needs a LOT of work!
*[[Lua:Effect-triggered callbacks]]
*[[Lua:Flaginfo]]
*[[Lua:Startup]]
*[[Lua:shutdown]]() Calls right before map change.
*[[Lua:Tick]]
*[[buildable_killed]] ( buildable, damageinfo )
*[[Lua:player killed]]
*[[Lua:player ondamage]]
*[[Lua:player spawn]]
*[[player_onchat]]( player, chatstring ) Return false to prevent the chat message from being sent to others
*[[Lua:precache]]
*[[Player onkill]]
*[[Player switchteam]]
*[[player_onthrowgren1]]
*[[Player throwgren2]]
*[[player_onuse]] ( player )
*[[player_canconnect]]( playername, address, entindex ) Called when a player tries to join the server. Return false to prevent the player from joining.
*[[player_connected]]( player ) Called when a player successfully joins the server
*[[player_disconnected]]( player )
*[[Category:Lua]][[Category:Lua_Callbacks]]

Category:Player functions

2017-05-31T07:49:14Z

R00Kie: /* Example */

{{Infobox manual/Header}}
{{Infobox_mapping}}
Any player that's connected to the server can be accessed by the lua system. Once you have identified a specific player object you can use these functions to affect the player or get information about it.

===Usage===
CFFPlayer:'''function'''(''parameters'')

===Example===
<pre>function location_info:ontouch( touch_entity )

-- set the location of the player
if IsPlayer( touch_entity ) then
local player = CastToPlayer( touch_entity )
--this new variable is of type CFFPlayer; we can use any player function on it
player:SetLocation(entity:GetId(), self.text, self.team)
end
end</pre>
{| border="1" cellspacing="2" cellpadding="5"
! Command !! Description
|-
|'''AddAmmo'''([[Lua:Flags#Ammo]], integer) || Gives ammunition to the player
|-
| '''AddArmor'''(integer) ||Gives armor to the player
|-
| '''AddFrags'''(integer) ||Adds to the player's kill count
|-
| '''AddFortPoints'''(integer, string) ||Gives the player Fortress Points. String is an explanation for the points, eg. "Hunted Escape"
|-
| '''AddHealth'''(integer, bool) ||Gives the player health points. Negative numbers will hurt the player. If set to true the player will over-heal their maximum health.
|-
| integer '''GetFortPoints'''() || Returns the player's Fortress Points.
|-
| integer '''GetFrags'''() || Returns the player's Frag count.
|-
| integer '''GetDeaths'''() || Returns the player's death count.
|-
| integer '''GetClass'''() ||Returns the class of the player as a number (0-9)
|-
| string '''GetName'''() ||Returns the name of the player
|-
| integer '''GetArmor'''() || Returns the player's armor level
|-
| integer '''GetMaxArmor'''() || Returns the player's max armor
|-
| integer '''GetHealth'''() || Returns the player's health points
|-
| integer '''GetMaxHealth'''() || Returns the player's max health
|-
| float '''GetSpeed'''() || Returns the speed of the player
|-
| boolean '''HasItem'''(string) || returns true or false is the player is holding the named [[Lua:info_ff_script]]
|-
| boolean '''IsFeetDeepInWater'''()
|-
| boolean '''IsInNoBuild'''()
|-
| boolean '''IsUnderWater'''()
|-
| boolean '''IsWaistDeepInWater'''()
|-
| boolean '''IsInAttack1'''() || Is the player pressing his *primary attack* key?
|-
| boolean '''IsInAttack2'''()
|-
| boolean '''IsInUse'''()
|-
| boolean '''IsInJump'''()
|-
| boolean '''IsInForward'''()
|-
| boolean '''IsInBack'''()
|-
| boolean '''IsInMoveLeft'''()
|-
| boolean '''IsInMoveRight'''()
|-
| boolean '''IsInLeft'''()
|-
| boolean '''IsInRight'''()
|-
| boolean '''IsInRun'''()
|-
| boolean '''IsInReload'''()
|-
| boolean '''IsInSpeed'''() || same as walk?
|-
| boolean '''IsInWalk'''()
|-
| boolean '''IsInZoom'''()
|-
| boolean '''IsOnGround'''()
|-
| boolean '''IsInAir'''( int )|| Checks if the player is the specified number of units above the ground.
|-
| boolean '''IsDucking'''()
|-
| boolean '''IsGrenade1Primed'''() || Player has a live frag grenade
|-
| boolean '''IsGrenade2Primed'''()
|-
| boolean '''IsGrenadePrimed'''()
|-
| boolean '''IsFlashlightOn'''()
|-
| integer '''GetAmmoInClip'''()
|-
| integer '''GetAmmoInClip'''( weaponname )
|-
| '''SetAmmoInClip'''( num )
|-
| '''SetAmmoInClip'''( weaponname, num )
|-
| integer '''GetAmmoCount'''( ammotype )
|-
| '''ReloadClips'''() || magic reload!
|-
| boolean '''IsBot'''()
|-
| '''MarkRadioTag'''() || No uses found
|-
| '''RemoveArmor'''(integer) || Removes armor from the player
|-
| '''RemoveLocation'''(entityId) || Clears the player's location info? Never used.
|-
| string '''GetLocation'''() || Returns the current map location of the player
|-
| '''Respawn'''() || Respawn the player.
|-
| '''SetDisguisable'''(boolean) || Allow/disallow a spy to use disguise
|-
| '''SetDisguise'''(int teamId, int classId, bool isInstant) || Changes the player's disguise.
|-
| '''ResetDisguise'''() || Resets the player's disguise.
|-
| boolean '''IsDisguisable'''() || returns whether the player is allowed to disguise
|-
| '''SetCloakable'''(boolean) || Allow/disallow a spy to use cloak
|-
| boolean '''IsCloakable'''() || returns whether the player is allowed to cloak
|-
| '''SetRespawnable'''(boolean) || Send false to make players stay dead (unable to respawn).
|-
| boolean '''IsRespawnable'''() || See above.
|-
| '''SetLocation'''(entityId, string, [[Lua:Flags#Team]]) || Sends text to the player's location HUD. Team determines the color of the text.
|-
| '''SetRespawnDelay''' || Probably should send this an integer or float.
|-
| string '''GetActiveWeaponName'''() || returns the [[Lua:weapon_classes]] of the weapon equipped by the player, eg. "ff_weapon_spanner"
|-
| '''GiveWeapon'''(string, boolean) || Give the player a weapon, specified by [[Lua:weapon_classes]]. If boolean is set to true, the player will autoswitch to this weapon.
|-
| '''RemoveWeapon'''(string) || Take from the player a weapon, specified by [[Lua:weapon_classes]]
|-
| '''RemoveAllWeapons'''() || Strip all the player's weapons.
|-
| '''RemoveAllAmmo'''(boolean)
|-
| boolean '''IsCloaked'''()
|-
| boolean '''IsDisguised'''()
|-
| integer '''GetDisguisedClass'''()
|-
| integer '''GetDisguisedTeam'''()
|-
| '''AddEffect'''( [[Lua:Flags#EF]], EFFECT_DURATION, ICON_DURATION, SPEED_MULTIPLIER ) || Adds a status affect to the player. SPEED_MULTIPLIER is used for altering the player's speed.
|-
| boolean '''IsEffectActive'''([[Lua:Flags#EF]])
|-
| '''RemoveEffect'''([[Lua:Flags#EF]]) || Cancels a status effect on the player
|-
| integer '''GetId'''() || Gets the ID number of the player
|-
| integer '''GetSteamID'''()
|-
| integer '''GetPing'''()
|-
| '''GetPacketloss'''()
|-
| boolean '''IsAlive'''()
|-
| '''Freeze'''(boolean) || Stop the player from moving or shooting. Send false to unfreeze a player.
|-
| boolean '''IsFrozen'''() || Returns true or false depending on whether the player is in a frozen state.
|-
| '''RemoveBuildables'''() || Removes all the player's owned buildables ( [[Buildables|List of buildables]] )
|-
| '''RemoveProjectiles'''() || Removes all the player's owned projectiles ( rockets, nails, etc. )
|-
| '''RemoveItems'''() || Removes all the player's owned buildables AND projectiles.
|-
| '''LockInPlace'''(boolean) || Stop the player from moving, and disable their gravity. Player can still rotate and shoot. Send false to unlock player.
|-
| '''SetGravity'''(float) || Sets the player's gravity.
|-
| float '''GetGravity'''() || Gets the player's gravity.
|-
| '''SetVelocity'''( Vector(0,0,0) ) || Sets the player's velocity.
|-
| '''GetVelocity'''() || Gets the player's velocity.
|-
| '''SpeedMod'''(float) || Sets a host_timescale type movement to the player's speed.
|-
| float '''GetSpeedMod'''() || Gets the player's speed mod.
|-
|'''EmitSound'''(String) || Causes the player or assigned entity to emit a sound. Make sure to precache sounds.
|-
| '''GetSentryGun'''() || Gets the player's Sentry gun or nil if it's unbuilt.
|-
| '''GetDispenser'''() || Gets the player's Dispenser or nil if it's unbuilt.
|-
| '''GetDetpack'''() || Gets the player's Detpack or nil if it's unbuilt.
|-
| '''GetJumpPad'''() || Gets the player's Jump Pad or nil if it's unbuilt.
|-
| '''SetFriction'''() || Sets the player's friction similar to sv_friction
|-
|}
[[Category:Lua]]
[[Category:Lua_Commands]]

Lua:Flags

2015-04-24T03:13:31Z

R00Kie:

{{Infobox manual/Header}}
{{Infobox mapping}}
{{Lua:FlagType
|prefix=Class
|usage=Returns a specific class ID
|flags=
{{Lua:Flag|Player.kScout | Scout Class }}
{{Lua:Flag|Player.kSniper | Sniper Class}}
{{Lua:Flag|Player.kSoldier | Soldier Class}}
{{Lua:Flag|Player.kDemoman | Demoman Class}}
{{Lua:Flag|Player.kMedic | Medic Class}}
{{Lua:Flag|Player.kHwGuy | Heavy Weapons Class}}
{{Lua:Flag|Player.kPyro | Pyro Class}}
{{Lua:Flag|Player.kSpy | Spy Class}}
{{Lua:Flag|Player.kEngineer | Engineer Class}}
|example=
<code><pre>
local player = CastToPlayer( touch_entity )
if player:GetClass() == Player.kSniper then
...
end
</pre></code>
}}
{{Lua:FlagType
|prefix=Team
|usage=Returns a specific team's ID
|flags=
{{Lua:Flag|Team.kUnassigned|The Unassigned team consists of players that have not picked a team)}}
{{Lua:Flag|Team.kSpectator|Spectators}}
{{Lua:Flag|Team.kRed|The Red team}}
{{Lua:Flag|Team.kBlue|The Blue team}}
{{Lua:Flag|Team.kYellow|The Yellow team}}
{{Lua:Flag|Team.kGreen|The Green team}}
|example=
<code><pre>
local player = CastToPlayer( touch_entity )
if player:GetTeamId() == Team.kRed then
...
end
</pre></code>
}}

{{Lua:FlagType
|prefix=Grenade
|usage=Returns a specific grenade's ID
|flags=
{{Lua:Flag|Grenade.kNormal|Frag grenade (All classes except Scout and Civilian)}}
{{Lua:Flag|Grenade.kCaltrop|Caltrop grenades are no longer in the game}}
{{Lua:Flag|Grenade.kNail|Nail Grenade (Soldier)}}
{{Lua:Flag|Grenade.kMirv|Mirv grenade (Demoman)}}
{{Lua:Flag|Grenade.kMirvlet|The four mini-grenades that come out of the Mirv grenade (Demoman)}}
{{Lua:Flag|Grenade.kConc|Concussion grenade (Scout and Medic)}}
{{Lua:Flag|Grenade.kNapalm|Napalm grenade (Pyro)}}
{{Lua:Flag|Grenade.kGas|Gas grenade (Spy)}}
{{Lua:Flag|Grenade.kEmp|EMP grenade (Engineer)}}
|example=
<code><pre>
local grenade = CastToGrenade( explode_entity )
if grenade:Type() == Grenade.kNormal then
...
end
</pre></code>
}}

{{Lua:FlagType
|prefix=Damage
|usage=Returns a specific damage type's ID; predominately used to detect fall damage
|flags=
{{Lua:Flag|Damage.kGeneric|Generic damage}}
{{Lua:Flag|Damage.kCrush|Crushing damage (as in by an elevator or door)}}
{{Lua:Flag|Damage.kBullet|Bullet damage}}
{{Lua:Flag|Damage.kSlash|Unknown}}
{{Lua:Flag|Damage.kBurn|Burn damage (maybe by pyro, maybe by trigger_hurt)}}
{{Lua:Flag|Damage.kVehicle|Vehicle damage}}
{{Lua:Flag|Damage.kFall|Fall damage}}
{{Lua:Flag|Damage.kBlast|Blast damage, DamageID 64}}
{{Lua:Flag|Damage.kClub|Unknown}}
{{Lua:Flag|Damage.kShock|Shock damage}}
{{Lua:Flag|Damage.kSonic|Unknown}}
{{Lua:Flag|Damage.kEnergyBeam|Unknown}}
{{Lua:Flag|Damage.kPreventPhysForce|Unknown}}
{{Lua:Flag|Damage.kNeverGib|Unknown}}
{{Lua:Flag|Damage.kAlwaysGib|Unknown}}
{{Lua:Flag|Damage.kDrown|Drowning damage}}
{{Lua:Flag|Damage.kTimeBased|Unknown}}
{{Lua:Flag|Damage.kParalyze|Unknown}}
{{Lua:Flag|Damage.kNerveGas|Unknown}}
{{Lua:Flag|Damage.kPoison|Unknown}}
{{Lua:Flag|Damage.kRadiation|Unknown}}
{{Lua:Flag|Damage.kDrownRecover|Unknown}}
{{Lua:Flag|Damage.kAcid|Unknown}}
{{Lua:Flag|Damage.kSlowBurn|Unknown}}
{{Lua:Flag|Damage.kRemoveNoRagdoll|Unknown}}
{{Lua:Flag|Damage.kPhysgun|Unknown; likely not applicable}}
{{Lua:Flag|Damage.kPlasma|Unknown}}
{{Lua:Flag|Damage.kAirboat|Likely not applicable}}
{{Lua:Flag|Damage.kDissolve|Can be dealt by a trigger_hurt}}
{{Lua:Flag|Damage.kBlastSurface|Unknown}}
{{Lua:Flag|Damage.kDirect|Unknown}}
{{Lua:Flag|Damage.kBuckshot|Unknown}}
{{Lua:Flag|Damage.kGibCorpse|Unknown}}
{{Lua:Flag|Damage.kShownHud|Unknown}}
{{Lua:Flag|Damage.kNoPhysForce|Unknown}}
|example=
<code><pre>
local damagetype = damageinfo:GetDamageType()
if damagetype == Damage.kFall then
...
end
</pre></code>
}}

{{Lua:FlagType
|prefix=Ammo
|usage=Returns a specific ammo type's ID; predominately used to add or remove ammo from a player
|flags=
{{Lua:Flag|Ammo.kShells|[[Reference:Ammo#Shell|Shell]] ammo type}}
{{Lua:Flag|Ammo.kCells|[[Reference:Ammo#Cell|Cell]] ammo type}}
{{Lua:Flag|Ammo.kNails|[[Reference:Ammo#Nail|Nail]] ammo type}}
{{Lua:Flag|Ammo.kRockets|[[Reference:Ammo#Rocket|Rocket]] ammo type}}
{{Lua:Flag|Ammo.kDetpack|[[Reference:Ammo#Detpack|Detpack]] ammo type}}
{{Lua:Flag|Ammo.kManCannon|[[Reference:Ammo#Jump Pad|Jump Pad]] ammo type}}
{{Lua:Flag|Ammo.kGren1|[[Reference:Grenades|Primary grenade]] ammo type}}
{{Lua:Flag|Ammo.kGren2|[[Reference:Grenades|Secondary grenade]] ammo type}}
{{Lua:Flag|Ammo.kInvalid|Unknown}}
|example=
<code><pre>
local player = CastToPlayer( player_entity )

player:AddAmmo( Ammo.kNails, 400 )
player:AddAmmo( Ammo.kShells, 400 )
player:AddAmmo( Ammo.kRockets, 400 )
player:AddAmmo( Ammo.kCells, 400 )
player:AddAmmo( Ammo.kDetpack, 1 )
player:AddAmmo( Ammo.kManCannon, 1 )
</pre></code>
}}

{{Lua:FlagType
|prefix=EF
|usage=Returns a specific status effect's ID
|flags=
{{Lua:Flag|EF.kOnfire|[[:Category:Status_Effects#On_Fire|On Fire]] status effect}}
{{Lua:Flag|EF.kConc|[[:Category:Status_Effects#Concussed|Concussed]] status effect}}
{{Lua:Flag|EF.kGas|[[:Category:Status_Effects#Hallucinations|Hallucinati ons]] status effect}}
{{Lua:Flag|EF.kInfect|[[:Category:Status_Effects#Infected|Infected]] status effect}}
{{Lua:Flag|EF.kRadiotag|[[:Category:Status_Effects#Transmitting|Transmitting]] status effect}}
{{Lua:Flag|EF.kHeadshot|Headshot status effect}}
{{Lua:Flag|EF.kLegshot|[[:Category:Status_Effects#Crippled|Crippled]] status effect}}
{{Lua:Flag|EF.kTranq|[[:Category:Status_Effects#Tranquilized|Tranquilized]] status effect}}
{{Lua:Flag|EF.kCaltrop|Defunct}}
{{Lua:Flag|EF.kACSpinup|Assault Cannon spinup status effect}}
{{Lua:Flag|EF.kSniperrifle|Unknown}}
{{Lua:Flag|EF.kSpeedlua1|Custom speed effect 1}}
{{Lua:Flag|EF.kSpeedlua2|Custom speed effect 2}}
{{Lua:Flag|EF.kSpeedlua3|Custom speed effect 3}}
{{Lua:Flag|...|...}}
{{Lua:Flag|EF.kSpeedlua10|Custom speed effect 10}}
|example=
<code><pre>
local player = CastToPlayer( player_entity )

SPEED_MULTIPLIER = 2.0
EFFECT_DURATION = -1 -- Infinite duration
ICON_DURATION = 0

player:AddEffect( EF.kSpeedlua1, EFFECT_DURATION, ICON_DURATION, SPEED_MULTIPLIER )
</pre></code>
}}

{{Lua:FlagType
|prefix=AT
|usage=Returns a specific "apply to" ID; Applies various commands to players, or to the entire server. Use with [[ApplyToAll]](ApplyToFlags), [[ApplyToTeam]](team, ApplyToFlags), or [[ApplyToPlayer]](player, ApplyToFlags) (not all flags are suitable for all functions).
|flags=
{{Lua:Flag|AT.kKillPlayers|}}
{{Lua:Flag|AT.kRespawnPlayers|}}
{{Lua:Flag|AT.kDropItems|}}
{{Lua:Flag|AT.kForceDropItems|}}
{{Lua:Flag|AT.kThrowItems|}}
{{Lua:Flag|AT.kForceThrowItems|}}
{{Lua:Flag|AT.kReturnCarriedItems|}}
{{Lua:Flag|AT.kReturnDroppedItems|ApplyToAll only?}}
{{Lua:Flag|AT.kRemoveRagdolls|ApplyToAll only?}}
{{Lua:Flag|AT.kRemovePacks|ApplyToAll only?}}
{{Lua:Flag|AT.kRemoveProjectiles|}}
{{Lua:Flag|AT.kRemoveBuildables|}}
{{Lua:Flag|AT.kRemoveDecals|ApplyToAll only?}}
{{Lua:Flag|AT.kEndMap|ApplyToAll only}}
{{Lua:Flag|AT.kReloadClips|}}
{{Lua:Flag|AT.kAllowRespawn|}}
{{Lua:Flag|AT.kDisallowRespawn|}}

{{Lua:Flag|AT.kChangeClassScout|}}
{{Lua:Flag|AT.kChangeClassSniper|}}
{{Lua:Flag|AT.kChangeClassSoldier|}}
{{Lua:Flag|AT.kChangeClassDemoman|}}
{{Lua:Flag|AT.kChangeClassMedic|}}
{{Lua:Flag|AT.kChangeClassHWGuy|}}
{{Lua:Flag|AT.kChangeClassPyro|}}
{{Lua:Flag|AT.kChangeClassSpy|}}
{{Lua:Flag|AT.kChangeClassEngineer|}}
{{Lua:Flag|AT.kChangeClassCivilian|}}
{{Lua:Flag|AT.kChangeClassRandom|}}

{{Lua:Flag|AT.kChangeTeamBlue|}}
{{Lua:Flag|AT.kChangeTeamRed|}}
{{Lua:Flag|AT.kChangeTeamYellow|}}
{{Lua:Flag|AT.kChangeTeamGreen|}}
{{Lua:Flag|AT.kChangeTeamSpectator|}}

{{Lua:Flag|AT.kStopPrimedGrens|}}

|example=
<code><pre>
ApplyToAll({ AT.kRemovePacks, AT.kRemoveProjectiles, AT.kRespawnPlayers, AT.kRemoveBuildables, AT.kRemoveRagdolls, AT.kStopPrimedGrens, AT.kReloadClips })
</pre></code>
}}

{{Lua:FlagType
|prefix=ClipFlags
|usage=Used with [[Lua:trigger_ff_clip]] to determine what types of entities are allowed to pass through the trigger.
|flags=
{{Lua:Flag|ClipFlags.kClipTeamBlue|Use in conjunction with "ByTeam" flags.}}
{{Lua:Flag|ClipFlags.kClipTeamRed|Use in conjunction with "ByTeam" flags.}}
{{Lua:Flag|ClipFlags.kClipTeamYellow|Use in conjunction with "ByTeam" flags.}}
{{Lua:Flag|ClipFlags.kClipTeamGreen|Use in conjunction with "ByTeam" flags.}}
{{Lua:Flag|ClipFlags.kClipAllPlayers|}}
{{Lua:Flag|ClipFlags.kClipAllGrenades|}}
{{Lua:Flag|ClipFlags.kClipAllProjectiles|projectiles such as nails and rockets.}}
{{Lua:Flag|ClipFlags.kClipAllBullets|hitscan weapons such as shotguns.}}
{{Lua:Flag|ClipFlags.kClipAllBuildables|Can buildables be placed?}}
{{Lua:Flag|ClipFlags.kClipAllBuildableWeapons|Can sentries fire through?}}
{{Lua:Flag|ClipFlags.kClipAllBackpacks|Thrown/dropped ammo.}}
{{Lua:Flag|ClipFlags.kClipAllInfoScripts|Flags, balls, etc. These currently cannot be filtered by team.}}
{{Lua:Flag|ClipFlags.kClipAllSpawnTurrets|}}
{{Lua:Flag|ClipFlags.kClipAllNonPlayers|}}
{{Lua:Flag|ClipFlags.kClipPlayersByTeam or ClipFlags.kClipPlayers|The following pairs behave identically; the first form is preferred, but the second form is for backwards-compatibility.}}
{{Lua:Flag|ClipFlags.kClipGrenadesByTeam or ClipFlags.kClipGrenades|}}
{{Lua:Flag|ClipFlags.kClipProjectilesByTeam or ClipFlags.kClipProjectiles|}}
{{Lua:Flag|ClipFlags.kClipBulletsByTeam or ClipFlags.kClipBullets|}}
{{Lua:Flag|ClipFlags.kClipBuildablesByTeam or ClipFlags.kClipBuildables|}}
{{Lua:Flag|ClipFlags.kClipBuildableWeaponsByTeam or ClipFlags.kClipBuildableWeapons|}}
{{Lua:Flag|ClipFlags.kClipBackpacksByTeam or ClipFlags.kClipBackpacks|}}
{{Lua:Flag|ClipFlags.kClipSpawnTurretsByTeam or ClipFlags.kClipSpawnTurrets|}}
{{Lua:Flag|ClipFlags.kClipNonPlayersByTeam or ClipFlags.kClipNonPlayers|}}

|example=
This clip brush will be solid to everything except blue players.
<code><pre>
clip_example = trigger_ff_clip:new({ clipflags = {
ClipFlags.kClipPlayersByTeam, ClipFlags.kClipTeamRed,
ClipFlags.kClipTeamYellow, ClipFlags.kClipTeamGreen,
ClipFlags.kClipAllNonPlayers} })
</pre></code>
}}

{{Lua:FlagType
|prefix=CF
|usage=Returns a specific "collection filter" ID;. Use with [[Lua:Collection|Collection()]] functions to add certain entities to a list.
|flags=

{{Lua:Flag|CF.kNone|No filter}}

{{Lua:Flag|CF.kPlayers|}}
{{Lua:Flag|CF.kHumanPlayers|Meaning bots are excluded.}}
{{Lua:Flag|CF.kBotPlayers|FF does not support bots at this time.}}
{{Lua:Flag|CF.kPlayerScout|}}
{{Lua:Flag|CF.kPlayerSniper|}}
{{Lua:Flag|CF.kPlayerSoldier|}}
{{Lua:Flag|CF.kPlayerDemoman|}}
{{Lua:Flag|CF.kPlayerMedic|}}
{{Lua:Flag|CF.kPlayerHWGuy|}}
{{Lua:Flag|CF.kPlayerPyro|}}
{{Lua:Flag|CF.kPlayerSpy|}}
{{Lua:Flag|CF.kPlayerEngineer|}}
{{Lua:Flag|CF.kPlayerCivilian|}}

{{Lua:Flag|CF.kTeams|Not sure if the team filters work on just players or on any team-aligned object.}}
{{Lua:Flag|CF.kTeamSpec|Spectators}}
{{Lua:Flag|CF.kTeamBlue|}}
{{Lua:Flag|CF.kTeamRed|}}
{{Lua:Flag|CF.kTeamYellow|}}
{{Lua:Flag|CF.kTeamGreen|}}

{{Lua:Flag|CF.kProjectiles|Applies to non-hitscan projectile weapons like rockets.}}
{{Lua:Flag|CF.kGrenades|}}
{{Lua:Flag|CF.kInfoScipts|Applies to any info_ff_script}}

{{Lua:Flag|CF.kInfoScript_Carried| Use the following on info_ff_scripts to determine their status}}
{{Lua:Flag|CF.kInfoScript_Dropped|}}
{{Lua:Flag|CF.kInfoScript_Returned|}}
{{Lua:Flag|CF.kInfoScript_Active|}}
{{Lua:Flag|CF.kInfoScript_Inactive|}}
{{Lua:Flag|CF.kInfoScript_Removed|}}

{{Lua:Flag|CF.kTraceBlockWalls|This flag must be used if you are using the [[Lua:Collection#GetInSphere|Collection:GetInSphere]] function.}}

{{Lua:Flag|CF.kBuildables|}}
{{Lua:Flag|CF.kDispenser|}}
{{Lua:Flag|CF.kSentrygun|}}
{{Lua:Flag|CF.kDetpack|}}

|example=
<code><pre>
local col = Collection()

-- get all blue snipers
col:GetByFilter( { CF.kPlayers, CF.kPlayerSniper, CF.kTeamBlue } )
</pre></code>
}}
{{Lua:FlagType
|prefix=Color
|usage=Shorthand for some common colors
|flags=

{{Lua:Flag|Color.kInvalid|}}
{{Lua:Flag|Color.kDefault|}}
{{Lua:Flag|Color.kBlue|}}
{{Lua:Flag|Color.kRed|}}
{{Lua:Flag|Color.kYellow|}}
{{Lua:Flag|Color.kGreen|}}
{{Lua:Flag|Color.kWhite|}}
{{Lua:Flag|Color.kBlack|}}
{{Lua:Flag|Color.kOrange|}}
{{Lua:Flag|Color.kPink|}}
{{Lua:Flag|Color.kPurple|}}
{{Lua:Flag|Color.kGrey|}}
|example=
<code><pre>
BroadCastMessage( "Goal!", 5, Color.kBlue )
</pre></code>
}}
[[Category:Lua]]
{{Infobox manual/Footer}}

Lua:Flags

2015-04-23T02:21:50Z

R00Kie:

{{Infobox manual/Header}}
{{Infobox mapping}}
{{Lua:FlagType
|prefix=Class
|usage=Returns a specific class ID
|flags=
{{Lua:Flag|Player.kScout | Scout Class }}
{{Lua:Flag|Player.kSniper | Sniper Class}}
{{Lua:Flag|Player.kSoldier | Soldier Class}}
{{Lua:Flag|Player.kDemoman | Demoman Class}}
{{Lua:Flag|Player.kMedic | Medic Class}}
{{Lua:Flag|Player.kHwGuy | Heavy Weapons Class}}
{{Lua:Flag|Player.kPyro | Pyro Class}}
{{Lua:Flag|Player.kSpy | Spy Class}}
{{Lua:Flag|Player.kEngineer | Engineer Class}}
|example=
<code><pre>
local player = CastToPlayer( touch_entity )
if player:GetClass() == Player.kSniper then
...
end
</pre></code>
}}
{{Lua:FlagType
|prefix=Team
|usage=Returns a specific team's ID
|flags=
{{Lua:Flag|Team.kUnassigned|The Unassigned team consists of players that have not picked a team)}}
{{Lua:Flag|Team.kSpectator|Spectators}}
{{Lua:Flag|Team.kRed|The Red team}}
{{Lua:Flag|Team.kBlue|The Blue team}}
{{Lua:Flag|Team.kYellow|The Yellow team}}
{{Lua:Flag|Team.kGreen|The Green team}}
|example=
<code><pre>
local player = CastToPlayer( touch_entity )
if player:GetTeamId() == Team.kRed then
...
end
</pre></code>
}}

{{Lua:FlagType
|prefix=Grenade
|usage=Returns a specific grenade's ID
|flags=
{{Lua:Flag|Grenade.kNormal|Frag grenade (All classes except Scout and Civilian)}}
{{Lua:Flag|Grenade.kCaltrop|Caltrop grenades are no longer in the game}}
{{Lua:Flag|Grenade.kNail|Nail Grenade (Soldier)}}
{{Lua:Flag|Grenade.kMirv|Mirv grenade (Demoman)}}
{{Lua:Flag|Grenade.kMirvlet|The four mini-grenades that come out of the Mirv grenade (Demoman)}}
{{Lua:Flag|Grenade.kConc|Concussion grenade (Scout and Medic)}}
{{Lua:Flag|Grenade.kNapalm|Napalm grenade (Pyro)}}
{{Lua:Flag|Grenade.kGas|Gas grenade (Spy)}}
{{Lua:Flag|Grenade.kEmp|EMP grenade (Engineer)}}
|example=
<code><pre>
local grenade = CastToGrenade( explode_entity )
if grenade:Type() == Grenade.kNormal then
...
end
</pre></code>
}}

{{Lua:FlagType
|prefix=Damage
|usage=Returns a specific damage type's ID; predominately used to detect fall damage
|flags=
{{Lua:Flag|Damage.kGeneric|Generic damage}}
{{Lua:Flag|Damage.kCrush|Crushing damage (as in by an elevator or door)}}
{{Lua:Flag|Damage.kBullet|Bullet damage}}
{{Lua:Flag|Damage.kSlash|Unknown}}
{{Lua:Flag|Damage.kBurn|Burn damage (maybe by pyro, maybe by trigger_hurt)}}
{{Lua:Flag|Damage.kVehicle|Vehicle damage}}
{{Lua:Flag|Damage.kFall|Fall damage}}
{{Lua:Flag|Damage.kBlast|Blast damage}}
{{Lua:Flag|Damage.kClub|Unknown}}
{{Lua:Flag|Damage.kShock|Shock damage}}
{{Lua:Flag|Damage.kSonic|Unknown}}
{{Lua:Flag|Damage.kEnergyBeam|Unknown}}
{{Lua:Flag|Damage.kPreventPhysForce|Unknown}}
{{Lua:Flag|Damage.kNeverGib|Unknown}}
{{Lua:Flag|Damage.kAlwaysGib|Unknown}}
{{Lua:Flag|Damage.kDrown|Drowning damage}}
{{Lua:Flag|Damage.kTimeBased|Unknown}}
{{Lua:Flag|Damage.kParalyze|Unknown}}
{{Lua:Flag|Damage.kNerveGas|Unknown}}
{{Lua:Flag|Damage.kPoison|Unknown}}
{{Lua:Flag|Damage.kRadiation|Unknown}}
{{Lua:Flag|Damage.kDrownRecover|Unknown}}
{{Lua:Flag|Damage.kAcid|Unknown}}
{{Lua:Flag|Damage.kSlowBurn|Unknown}}
{{Lua:Flag|Damage.kRemoveNoRagdoll|Unknown}}
{{Lua:Flag|Damage.kPhysgun|Unknown; likely not applicable}}
{{Lua:Flag|Damage.kPlasma|Unknown}}
{{Lua:Flag|Damage.kAirboat|Likely not applicable}}
{{Lua:Flag|Damage.kDissolve|Can be dealt by a trigger_hurt}}
{{Lua:Flag|Damage.kBlastSurface|Unknown}}
{{Lua:Flag|Damage.kDirect|Unknown}}
{{Lua:Flag|Damage.kBuckshot|Unknown}}
{{Lua:Flag|Damage.kGibCorpse|Unknown}}
{{Lua:Flag|Damage.kShownHud|Unknown}}
{{Lua:Flag|Damage.kNoPhysForce|Unknown}}
|example=
<code><pre>
local damagetype = damageinfo:GetDamageType()
if damagetype == Damage.kFall then
...
end
</pre></code>
}}

{{Lua:FlagType
|prefix=Ammo
|usage=Returns a specific ammo type's ID; predominately used to add or remove ammo from a player
|flags=
{{Lua:Flag|Ammo.kShells|[[Reference:Ammo#Shell|Shell]] ammo type}}
{{Lua:Flag|Ammo.kCells|[[Reference:Ammo#Cell|Cell]] ammo type}}
{{Lua:Flag|Ammo.kNails|[[Reference:Ammo#Nail|Nail]] ammo type}}
{{Lua:Flag|Ammo.kRockets|[[Reference:Ammo#Rocket|Rocket]] ammo type}}
{{Lua:Flag|Ammo.kDetpack|[[Reference:Ammo#Detpack|Detpack]] ammo type}}
{{Lua:Flag|Ammo.kManCannon|[[Reference:Ammo#Jump Pad|Jump Pad]] ammo type}}
{{Lua:Flag|Ammo.kGren1|[[Reference:Grenades|Primary grenade]] ammo type}}
{{Lua:Flag|Ammo.kGren2|[[Reference:Grenades|Secondary grenade]] ammo type}}
{{Lua:Flag|Ammo.kInvalid|Unknown}}
|example=
<code><pre>
local player = CastToPlayer( player_entity )

player:AddAmmo( Ammo.kNails, 400 )
player:AddAmmo( Ammo.kShells, 400 )
player:AddAmmo( Ammo.kRockets, 400 )
player:AddAmmo( Ammo.kCells, 400 )
player:AddAmmo( Ammo.kDetpack, 1 )
player:AddAmmo( Ammo.kManCannon, 1 )
</pre></code>
}}

{{Lua:FlagType
|prefix=EF
|usage=Returns a specific status effect's ID
|flags=
{{Lua:Flag|EF.kOnfire|[[:Category:Status_Effects#On_Fire|On Fire]] status effect}}
{{Lua:Flag|EF.kConc|[[:Category:Status_Effects#Concussed|Concussed]] status effect}}
{{Lua:Flag|EF.kGas|[[:Category:Status_Effects#Hallucinations|Hallucinati ons]] status effect}}
{{Lua:Flag|EF.kInfect|[[:Category:Status_Effects#Infected|Infected]] status effect}}
{{Lua:Flag|EF.kRadiotag|[[:Category:Status_Effects#Transmitting|Transmitting]] status effect}}
{{Lua:Flag|EF.kHeadshot|Headshot status effect}}
{{Lua:Flag|EF.kLegshot|[[:Category:Status_Effects#Crippled|Crippled]] status effect}}
{{Lua:Flag|EF.kTranq|[[:Category:Status_Effects#Tranquilized|Tranquilized]] status effect}}
{{Lua:Flag|EF.kCaltrop|Defunct}}
{{Lua:Flag|EF.kACSpinup|Assault Cannon spinup status effect}}
{{Lua:Flag|EF.kSniperrifle|Unknown}}
{{Lua:Flag|EF.kSpeedlua1|Custom speed effect 1}}
{{Lua:Flag|EF.kSpeedlua2|Custom speed effect 2}}
{{Lua:Flag|EF.kSpeedlua3|Custom speed effect 3}}
{{Lua:Flag|...|...}}
{{Lua:Flag|EF.kSpeedlua10|Custom speed effect 10}}
|example=
<code><pre>
local player = CastToPlayer( player_entity )

SPEED_MULTIPLIER = 2.0
EFFECT_DURATION = -1 -- Infinite duration
ICON_DURATION = 0

player:AddEffect( EF.kSpeedlua1, EFFECT_DURATION, ICON_DURATION, SPEED_MULTIPLIER )
</pre></code>
}}

{{Lua:FlagType
|prefix=AT
|usage=Returns a specific "apply to" ID; Applies various commands to players, or to the entire server. Use with [[ApplyToAll]](ApplyToFlags), [[ApplyToTeam]](team, ApplyToFlags), or [[ApplyToPlayer]](player, ApplyToFlags) (not all flags are suitable for all functions).
|flags=
{{Lua:Flag|AT.kKillPlayers|}}
{{Lua:Flag|AT.kRespawnPlayers|}}
{{Lua:Flag|AT.kDropItems|}}
{{Lua:Flag|AT.kForceDropItems|}}
{{Lua:Flag|AT.kThrowItems|}}
{{Lua:Flag|AT.kForceThrowItems|}}
{{Lua:Flag|AT.kReturnCarriedItems|}}
{{Lua:Flag|AT.kReturnDroppedItems|ApplyToAll only?}}
{{Lua:Flag|AT.kRemoveRagdolls|ApplyToAll only?}}
{{Lua:Flag|AT.kRemovePacks|ApplyToAll only?}}
{{Lua:Flag|AT.kRemoveProjectiles|}}
{{Lua:Flag|AT.kRemoveBuildables|}}
{{Lua:Flag|AT.kRemoveDecals|ApplyToAll only?}}
{{Lua:Flag|AT.kEndMap|ApplyToAll only}}
{{Lua:Flag|AT.kReloadClips|}}
{{Lua:Flag|AT.kAllowRespawn|}}
{{Lua:Flag|AT.kDisallowRespawn|}}

{{Lua:Flag|AT.kChangeClassScout|}}
{{Lua:Flag|AT.kChangeClassSniper|}}
{{Lua:Flag|AT.kChangeClassSoldier|}}
{{Lua:Flag|AT.kChangeClassDemoman|}}
{{Lua:Flag|AT.kChangeClassMedic|}}
{{Lua:Flag|AT.kChangeClassHWGuy|}}
{{Lua:Flag|AT.kChangeClassPyro|}}
{{Lua:Flag|AT.kChangeClassSpy|}}
{{Lua:Flag|AT.kChangeClassEngineer|}}
{{Lua:Flag|AT.kChangeClassCivilian|}}
{{Lua:Flag|AT.kChangeClassRandom|}}

{{Lua:Flag|AT.kChangeTeamBlue|}}
{{Lua:Flag|AT.kChangeTeamRed|}}
{{Lua:Flag|AT.kChangeTeamYellow|}}
{{Lua:Flag|AT.kChangeTeamGreen|}}
{{Lua:Flag|AT.kChangeTeamSpectator|}}

{{Lua:Flag|AT.kStopPrimedGrens|}}

|example=
<code><pre>
ApplyToAll({ AT.kRemovePacks, AT.kRemoveProjectiles, AT.kRespawnPlayers, AT.kRemoveBuildables, AT.kRemoveRagdolls, AT.kStopPrimedGrens, AT.kReloadClips })
</pre></code>
}}

{{Lua:FlagType
|prefix=ClipFlags
|usage=Used with [[Lua:trigger_ff_clip]] to determine what types of entities are allowed to pass through the trigger.
|flags=
{{Lua:Flag|ClipFlags.kClipTeamBlue|Use in conjunction with "ByTeam" flags.}}
{{Lua:Flag|ClipFlags.kClipTeamRed|Use in conjunction with "ByTeam" flags.}}
{{Lua:Flag|ClipFlags.kClipTeamYellow|Use in conjunction with "ByTeam" flags.}}
{{Lua:Flag|ClipFlags.kClipTeamGreen|Use in conjunction with "ByTeam" flags.}}
{{Lua:Flag|ClipFlags.kClipAllPlayers|}}
{{Lua:Flag|ClipFlags.kClipAllGrenades|}}
{{Lua:Flag|ClipFlags.kClipAllProjectiles|projectiles such as nails and rockets.}}
{{Lua:Flag|ClipFlags.kClipAllBullets|hitscan weapons such as shotguns.}}
{{Lua:Flag|ClipFlags.kClipAllBuildables|Can buildables be placed?}}
{{Lua:Flag|ClipFlags.kClipAllBuildableWeapons|Can sentries fire through?}}
{{Lua:Flag|ClipFlags.kClipAllBackpacks|Thrown/dropped ammo.}}
{{Lua:Flag|ClipFlags.kClipAllInfoScripts|Flags, balls, etc. These currently cannot be filtered by team.}}
{{Lua:Flag|ClipFlags.kClipAllSpawnTurrets|}}
{{Lua:Flag|ClipFlags.kClipAllNonPlayers|}}
{{Lua:Flag|ClipFlags.kClipPlayersByTeam or ClipFlags.kClipPlayers|The following pairs behave identically; the first form is preferred, but the second form is for backwards-compatibility.}}
{{Lua:Flag|ClipFlags.kClipGrenadesByTeam or ClipFlags.kClipGrenades|}}
{{Lua:Flag|ClipFlags.kClipProjectilesByTeam or ClipFlags.kClipProjectiles|}}
{{Lua:Flag|ClipFlags.kClipBulletsByTeam or ClipFlags.kClipBullets|}}
{{Lua:Flag|ClipFlags.kClipBuildablesByTeam or ClipFlags.kClipBuildables|}}
{{Lua:Flag|ClipFlags.kClipBuildableWeaponsByTeam or ClipFlags.kClipBuildableWeapons|}}
{{Lua:Flag|ClipFlags.kClipBackpacksByTeam or ClipFlags.kClipBackpacks|}}
{{Lua:Flag|ClipFlags.kClipSpawnTurretsByTeam or ClipFlags.kClipSpawnTurrets|}}
{{Lua:Flag|ClipFlags.kClipNonPlayersByTeam or ClipFlags.kClipNonPlayers|}}

|example=
This clip brush will be solid to everything except blue players.
<code><pre>
clip_example = trigger_ff_clip:new({ clipflags = {
ClipFlags.kClipPlayersByTeam, ClipFlags.kClipTeamRed,
ClipFlags.kClipTeamYellow, ClipFlags.kClipTeamGreen,
ClipFlags.kClipAllNonPlayers} })
</pre></code>
}}

{{Lua:FlagType
|prefix=CF
|usage=Returns a specific "collection filter" ID;. Use with [[Lua:Collection|Collection()]] functions to add certain entities to a list.
|flags=

{{Lua:Flag|CF.kNone|No filter}}

{{Lua:Flag|CF.kPlayers|}}
{{Lua:Flag|CF.kHumanPlayers|Meaning bots are excluded.}}
{{Lua:Flag|CF.kBotPlayers|FF does not support bots at this time.}}
{{Lua:Flag|CF.kPlayerScout|}}
{{Lua:Flag|CF.kPlayerSniper|}}
{{Lua:Flag|CF.kPlayerSoldier|}}
{{Lua:Flag|CF.kPlayerDemoman|}}
{{Lua:Flag|CF.kPlayerMedic|}}
{{Lua:Flag|CF.kPlayerHWGuy|}}
{{Lua:Flag|CF.kPlayerPyro|}}
{{Lua:Flag|CF.kPlayerSpy|}}
{{Lua:Flag|CF.kPlayerEngineer|}}
{{Lua:Flag|CF.kPlayerCivilian|}}

{{Lua:Flag|CF.kTeams|Not sure if the team filters work on just players or on any team-aligned object.}}
{{Lua:Flag|CF.kTeamSpec|Spectators}}
{{Lua:Flag|CF.kTeamBlue|}}
{{Lua:Flag|CF.kTeamRed|}}
{{Lua:Flag|CF.kTeamYellow|}}
{{Lua:Flag|CF.kTeamGreen|}}

{{Lua:Flag|CF.kProjectiles|Applies to non-hitscan projectile weapons like rockets.}}
{{Lua:Flag|CF.kGrenades|}}
{{Lua:Flag|CF.kInfoScipts|Applies to any info_ff_script}}

{{Lua:Flag|CF.kInfoScript_Carried| Use the following on info_ff_scripts to determine their status}}
{{Lua:Flag|CF.kInfoScript_Dropped|}}
{{Lua:Flag|CF.kInfoScript_Returned|}}
{{Lua:Flag|CF.kInfoScript_Active|}}
{{Lua:Flag|CF.kInfoScript_Inactive|}}
{{Lua:Flag|CF.kInfoScript_Removed|}}

{{Lua:Flag|CF.kTraceBlockWalls|This flag must be used if you are using the [[Lua:Collection#GetInSphere|Collection:GetInSphere]] function.}}

{{Lua:Flag|CF.kBuildables|}}
{{Lua:Flag|CF.kDispenser|}}
{{Lua:Flag|CF.kSentrygun|}}
{{Lua:Flag|CF.kDetpack|}}

|example=
<code><pre>
local col = Collection()

-- get all blue snipers
col:GetByFilter( { CF.kPlayers, CF.kPlayerSniper, CF.kTeamBlue } )
</pre></code>
}}
{{Lua:FlagType
|prefix=Color
|usage=Shorthand for some common colors
|flags=

{{Lua:Flag|Color.kInvalid|}}
{{Lua:Flag|Color.kDefault|}}
{{Lua:Flag|Color.kBlue|}}
{{Lua:Flag|Color.kRed|}}
{{Lua:Flag|Color.kYellow|}}
{{Lua:Flag|Color.kGreen|}}
{{Lua:Flag|Color.kWhite|}}
{{Lua:Flag|Color.kBlack|}}
{{Lua:Flag|Color.kOrange|}}
{{Lua:Flag|Color.kPink|}}
{{Lua:Flag|Color.kPurple|}}
{{Lua:Flag|Color.kGrey|}}
|example=
<code><pre>
BroadCastMessage( "Goal!", 5, Color.kBlue )
</pre></code>
}}
[[Category:Lua]]
{{Infobox manual/Footer}}

Category:Global Callbacks

2015-04-13T22:20:51Z

R00Kie: /* A short list */

{{Infobox mapping}}
These are Callbacks which are not connected with any game entity. Declare the function in your lua script, and the game will run it at the appropriate time.

==Example==
<pre>
function startup()
-- set up team limits
local team = GetTeam( Team.kBlue )
team:SetPlayerLimit( 0 )

team = GetTeam( Team.kRed )
team:SetPlayerLimit( 0 )

team = GetTeam( Team.kYellow )
team:SetPlayerLimit( -1 )

team = GetTeam( Team.kGreen )
team:SetPlayerLimit( -1 )
end
</pre>

==A short list==
This list needs a LOT of work!
*[[Lua:Effect-triggered callbacks]]
*[[Lua:Flaginfo]]
*[[Lua:Startup]]
*[[Lua:shutdown]]() Calls right before map change.
*[[Lua:Tick]]
*[[buildable_killed]] ( buildable, damageinfo )
*[[Lua:player killed]]
*[[Lua:player ondamage]]
*[[Lua:player spawn]]
*[[player_onchat]]( player, chatstring ) Return false to prevent the chat message from being sent to others
*[[Lua:precache]]
*[[Player onkill]]
*[[Player switchteam]]
*[[Player throwgren1]]
*[[Player throwgren2]]
*[[player_onuse]] ( player )
*[[player_canconnect]]( playername, address, entindex ) Called when a player tries to join the server. Return false to prevent the player from joining.
*[[player_connected]]( player ) Called when a player successfully joins the server
*[[player_disconnected]]( player )
*[[Category:Lua]][[Category:Lua_Callbacks]]

Category:Entity functions

2015-04-05T21:23:25Z

R00Kie: /* Entity Functions */

{{Infobox manual/Header}}
{{Infobox mapping}}
==Entity Functions==

These Lua functions are common to all entities in FF Generally, any entity placed in the map should work with these.
*object = baseentity:'''new'''({''collection''}) creates a Lua object that corresponds to a map entity. You must call new() before you can access any entity through Lua. ''Collection'' is a table you can use to define any custom Lua variables you want. See [[Lua:info_ff_script#Example]] for example code.

{| border="1" cellspacing="0"
! Command !! Description
|-
|entity '''Teleport''' ( Vector neworigin, QAngle newangles, Vector newvelocity ) || Teleports an entity.
|-
|entity '''GetOwner''' () || Returns the entity that "owns" the first entity.
|-
|entity '''StartTrail''' (int teamid, float start_width, float end_width, float lifetime) || Starts a trail with the Team ID as the color.
|-
|entity '''StopTrail''' () || Stops a trail on an entity.
|}

==Example==
<pre></pre>
[[Category:Lua_Commands]]
{{Infobox manual/Footer}}

Lua:info ff script

2015-04-05T21:09:06Z

R00Kie: /* Get Functions */

{{Infobox_mapping}}
==Introduction==
info_ff_script is used to represent items that can affect, and be affected by players. Such items might be the flags in a CTF map, or the armor, health and ammo packs in a respawn room.

These entities are placed in a map editor, such as Hammer, and must be given a name in order to function correctly. This name will be used to link it into the map's corresponding Lua file. So, whenever you put a named info_ff_script entity in your map, the game attempts to find a correspondingly named object in '''mapname'''.lua.

FF includes a number of pre-existing game modes that require very little work to implement in your own maps--that is, assuming your map's gameplay is similar enough to one of these templates. You'll simply need to add the appropriate entities, give them the proper names, and you're all set. More on that can be found by looking at the available [[map templates]].
====Example====
Let's assume you don't want to use one of FF's pre-existing base items, and you just want to make your own. For the sake of the example let's say we're setting up our own flag as a learning experience. First, put two info_ff_script entities in your map, and give them the names: ''myfirstflag'' and ''mysecondflag''. Now, create a new text file, and save the file as ''yourmapname''.lua.

So far, we don't have much of anything. We'll need to let Lua know that these entities are in our map. As you might expect, there's other options you can specify here, but this is our first script so we're going to keep it simple. This is how we'd get it started in our previously created Lua file.

-- This is my first base flag!
baseflag = info_ff_script:new({
name = "base flag",
model = "models/flag/flag.mdl",
modelskin = 1
})

You're probably noticing that nothing in the above bit of Lua has anything directly related to the two named entities you put in your map. We're creating a new info_ff_script object in Lua, and setting some default parameters. For our example, the model won't be changing, but we have two flags and we're going to easily change it's name and skin. This ''baseflag'' is our blank that we'll copy and modify to create other team-specific flags that are sitting in our map.

--We're extending our baseflag!
myfirstflag = baseflag:new({
name = "Flag one",
modelskin = 2
})

Any functions and variables we define in baseflag will be inherited by those entities which use it as a base. We can redefine functions and variables in the derived entites, to override the basic functionality.
==Events, or callbacks==
info_ff_script has various callbacks that allow your Lua script to detect events that happen in the game.

Access to events is typically in the following format:

function item:'''eventname'''( ''parameters'' )
--What to do when this method is called
--return anything, if necessary
end

Different methods may provide data by passing on a number of parameters. The types of these parameters, returned values and examples of usage can be found in the following links.

==="On" Events===
These callbacks are available to detect when certain events happen to the info_ff_script.
*[[Info_ff_script:spawn|ondrop( owner_entity )]]--The flag is dropped, either intentionally or by death.
*[[Info_ff_script:onloseitem|onloseitem( owner_entity )]]--The item is taken from the player for any reason.
*[[Info_ff_script:onreturn|onreturn()]]--The flag returns to its origin.
*[[Info_ff_script:onownerdie|onownerdie( owner_entity )]]--A player dies while holding the item.
*[[Info_ff_script:onownerforcerespawn|onownerforcerespawn( owner_entity )]]--The player is forced to respawn while holding the item.
*[[Info_ff_script:ownercloak|ownercloak( owner_entity )]]--A spy activates his cloak while holding the item. NOTE: This one doesn't start with "on".

===Other Events===
*[[Info_ff_script:dropitemcmd|dropitemcmd(owner_entity)]]--The player holding the item presses the dropitems key.
*[[Info_ff_script:touch|touch( player_entity )]]--The info_ff_script is touched by a player.
*[[Info_ff_script:precache|precache()]]--Called on each info_ff_script when the map is loaded, but before it starts. See [[Lua:precache]].
*[[Info_ff_script:materialize|materialize()]]--Called when an item respawns.

===Options===
*dropatspawn()--Return true to make the object drop to the ground when the map loads. Return false to leave it floating where it was placed in Hammer.
*hasanimation()--Return true if the model used is animated.
*usephysics()--Return true for dropped items to act as physics props. Default behavior is for the item to stop when it hits the ground.

==Functions==
Whenever you have a reference to a particular entity, you can use its functions to control its behavior.

===Example===
-- find the flag and cast it to an info_ff_script
local flag = GetInfoScriptByName("redflag")
-- Make sure flag isn't nil
if flag then
-- check if the player is carrying the flag
if player:HasItem(flag:GetName()) then
-- return the flag
flag:Return()
end
end

===Attachment Functions===
These functions can be used to change the offset by which an item is attached to a player. These offsets are relative to the player's absolute origin.
*[[Info_ff_script:attachoffsetforward|attachoffsetforward]]
*[[Info_ff_script:attachoffsetright|attachoffsetright]]
*[[Info_ff_script:attachoffsetup|attachoffsetup]]

===Get Functions===
Get functions return some information. Information you can use.
{| border="1" cellspacing="0"
! Command !! Description
|-
|[[Info_ff_script:GetAngles]]() || Returns an orientation array. (p,y,r, I believe)
|-
|[[Info_ff_script:GetOrigin]] () || Returns a location array. (x,y,z)
|-
|[[Info_ff_script:GetName]] () || Returns a string containing the name of the info_ff_script.
|-
|[[Info_ff_script:gettouchsizes]] ( mins, maxs ) || Passes min and max vectors by reference for the function to alter in place.
|-
|[[Info_ff_script:getphysicssizes]] ( mins, maxs ) || Passes min and max vectors by reference for the function to alter in place.
|-
|[[Info_ff_script:getbloatsize]] () || Expects a float return value, uses the value to inflate the touch bounding box (default bloat is 12).
|}

===Set Functions===
These functions change some property of the info_ff_script.
*[[info_ff_script:SetAngles|SetAngles]](angles) Turns the item to a specific angle.
*[[info_ff_script:SetModel|SetModel]](string) Sets the model of the item. Remember to [[Lua:Precache|precache]].
*[[info_ff_script:SetOrigin|SetOrigin]](origin) Moves the item to a specific spot on the map.
*[[info_ff_script:SetSkin|SetSkin]](int) Changes the skin of the model.
*[[info_ff_script:SetStartAngles|SetStartAngles]](angles) Sets the orientation of the item for when it respawns.
*[[info_ff_script:SetStartOrigin|SetOrigin]](origin) Sets the location of the item for when it respawns.

===State Checking Functions===
These all return true or false. You'll generally use them in a conditional statement.
*[[Info_ff_script:IsActive|IsActive]]
*[[Info_ff_script:IsCarried|IsCarried]]
*[[Info_ff_script:IsDropped|IsDropped]]
*[[Info_ff_script:IsInactive|IsInactive]]
*[[Info_ff_script:IsRemoved|IsRemoved]]
*[[Info_ff_script:IsReturned|IsReturned]]

===Misc. Functions===
*addnotouch() Defined in base_teamplay. Default behavior is to prevent the player from picking up the flag for 2 seconds after dropping it. Disabling this behavior will prevent players from being able to throw the flag at all--or rather, they will throw it, and pick it up an instant later.
*new({collection}) creates a new type of info_ff_script. See [[Lua:info_ff_script#Example]]
*Drop(FLAG_RETURN_TIME, FLAG_THROW_SPEED) Causes the player to throw/drop the flag.
*Pickup(player) Causes the specified player to carry this item.
*Respawn(int) Causes the item to disappear, and reappear after a specified number of seconds.
*Return() Causes the item to return to its starting point.
*EmitSound(String) Causes the item to make a sound.
*Remove() Causes the item to disappear from the map.
*Restore() Re-enables an item that has been removed.
[[Category:Lua]][[Category:Lua_Commands]][[Category:Lua_Callbacks]]

Lua:Entity typing

2015-04-05T20:55:29Z

R00Kie: /* Entity Checking */

{{Infobox manual/Header}}
{{Infobox_mapping}}
Lua is a dynamically typed language--this means that a variable can hold any type of data at any time. C objects, such as those used in Fortress Forever, are accessed as blocks of raw data. Because altering these objects incorrectly can cause the game to crash, It's important that the Lua system correctly knows what type of class it is dealing with.

==FF Object Types==
===CBaseEntity===
This is the basic type from which all other entities are derived. Consequently there's not a lot you can do with it--see [[:Category:Entity_functions]]. When naming an object of this type, it's best to use the word "entity" to prevent confusion.

The following commands will return a CBaseEntity:
*[[Lua:GetEntity|GetEntity]]( int ) Every entity in the game has a unique ID number. Use the [[Lua:GetId|GetId]]() function to access this number for a particular entity.
*[[Lua:GetEntityByName|GetEntityByName]]( String )
*String [[Lua:GetClassName|GetClassName]]() Returns the entity type as a string.
===InfoScript===
An InfoScript is created by using the [[Lua:info_ff_script | info_ff_script]]:new() command in lua, and placing an info_ff_script in a map. This is usually a game item such as a flag, ball, or supply pack,

The following commands will return an InfoScript:
*[[Lua:GetInfoScriptById|GetInfoScriptById]]( int )
*[[Lua:GetInfoScriptByName|GetInfoScriptByName]]( String )

===TriggerScript===
This is similar to InfoScript, but it's brush-based. Cap points and nobuild zones are Trigger scripts.

The following commands will return a TriggerScript:
*[[Lua:GetTriggerScriptByName|GetTriggerScriptByName]]( String )

===CFFPlayer===
This refers to any client on the server. See [[:Category:Player_functions]] For a list of what you can do with CFFPlayer.
The following commands will return a CFFPlayer:
*[[Lua:GetPlayer|GetPlayer]]( entity ) --This would appear to do the same thing as CastToPlayer (see below). Use that instead.
*[[Lua:GetPlayerByID|GetPlayerByID]]( int )

===CFFTeam===
This refers to one of six teams--"Unassigned" and Spectators, in addition to Blue, Red, Yellow, and Green. See [[:Category:Team_functions]] For a list of what you can do with CFFTeam.

The following commands will return a CFFTeam:
*[[Lua:GetTeam|GetTeam]]( teamId ) This returns a CFFTeam object when given a team number. See [[Lua:Flags#Team]].
===CFFBuildableObject===
Objects that the player can place or build. Includes dispensers, sentry guns, mancannons, and detpacks. See [[:Category:Buildable_functions]].
===CFFGrenadeBase===
Refers to thrown grenades
*[[Lua:GetGrenade|GetGrenade]]() TODO: what parameters does this take?
===CTakeDamageInfo===
Damageinfo is an object that's passed along whenever a player is damaged or dies. By intercepting this object, you can detect events in the game, or change the outcome of those events. Damageinfo can be accessed from within the callbacks player_ondamage and player_killed. See [[:Category:Damageinfo_functions]].

==Entity Checking==
Often in a lua script an entity will be passed to the script as a CBaseEntity. To gain access to more specific functions, we must ''cast'' the variable to a more specific type. But before casting to a more specific type of object, it's usually necessary to verify that the object exists, and that it's the kind of object we expect. Failing to do so can cause the script to fail and the game to crash.

If these functions return ''true'', it is safe to cast to that type of object.
{| border="1" cellspacing="0"
! LUA Command !! Description
|-
| [[Lua:IsPlayer|IsPlayer]]( ent_id ) || used to see if a passed in entity is a player to before actions are performed on said player.
|-
| [[Lua:IsEntity|IsEntity]]( ent_id ) ||
|-
| [[Lua:IsInfoScript|IsInfoScript]]( ent_id ) ||
|-
| [[Lua:IsDispenser|IsDispenser]]( ent_id ) ||
|-
| [[Lua:IsSentrygun|IsSentrygun]]( ent_id ) ||
|-
| [[Lua:IsDetpack|IsDetpack]]( ent_id ) ||
|-
| [[Lua:IsGrenade|IsGrenade]]( ent_id ) ||
|-
| [[Lua:IsProjectile|IsProjectile]]( ent_id ) ||
|-
| [[Lua:IsBuildable|IsBuildable]]( ent_id ) ||
|-
| [[Lua:IsJumpPad|IsJumpPad]]( ent_id ) ||
|-
| [[Lua:IsTurret|IsTurret]]( ent_id ) || Refers to respawn turrets.
|}

==Casting Commands==
A casting function accepts a CBaseEntity and returns the requested type of object, which you can assign to a new variable.
{| border="1" cellspacing="0"
! LUA Command !! Description
|-
| [[Lua:CastToBeam|CastToBeam]]( ent_id ) || tries to cast the entity to a beam (to see if whatever triggered the event was a laser beam, a la SD2). If it fails, it returns null.
|-
| [[Lua:CastToPlayer|CastToPlayer]]( ent_id ) || used to cast the passed in entity to a player, often used for touch commands.
|-
| [[Lua:CastToInfoScript|CastToInfoScript]]( ent_id ) || This may be a flag, resupply pack, or the like.
|-
| [[Lua:CastToTriggerScript|CastToTriggerScript]]( ent_id ) || This may be any kind of brush trigger that's referred to in an active lua script.
|-
| [[Lua:CastToTriggerClip|CastToTriggerClip]]( ent_id ) || Refers to a [[Lua:trigger_ff_clip|trigger_ff_clip]].
|-
| [[Lua:CastToGrenade|CastToGrenade]]( ent_id ) ||
|-
| [[Lua:CastToDispenser|CastToDispenser]]( ent_id ) ||
|-
| [[Lua:CastToSentrygun|CastToSentrygun]]( ent_id ) ||
|-
| [[Lua:CastToDetpack|CastToDetpack]]( ent_id ) ||
|-
| [[Lua:CastToBuildable|CastToBuildable]]( ent_id ) ||
|-
| [[Lua:CastToProjectile|CastToProjectile]]( ent_id ) ||
|-
| [[Lua:CastToJumpPad|CastToJumpPad]]( ent_id ) ||
|}

==Example==
<pre>--This callback runs when something explodes inside the trigger name detpack_trigger.
function detpack_trigger:onexplode( trigger_entity )
--We want to know if this mysterious exploding CBaseEntity is a detpack. If not we can skip the rest.
if IsDetpack( trigger_entity ) then
local detpack = CastToDetpack( trigger_entity )
--now that we have a detpack object, we can ask it what team it belongs to.
if detpack:GetTeamId() == attackers then
--This triggers a logic_relay in the map, which opens the hole and can trigger any other effect.
OutputEvent( self.prefix .. "_detpack_relay", "Trigger" )
end
end
--This line tells all grenades, etc. that it's still OK to explode.
return EVENT_ALLOWED
end</pre>

[[Category:Lua]]
{{Infobox manual/Footer}}

Lua:Entity typing

2015-04-05T20:54:05Z

R00Kie: /* Casting Commands */

{{Infobox manual/Header}}
{{Infobox_mapping}}
Lua is a dynamically typed language--this means that a variable can hold any type of data at any time. C objects, such as those used in Fortress Forever, are accessed as blocks of raw data. Because altering these objects incorrectly can cause the game to crash, It's important that the Lua system correctly knows what type of class it is dealing with.

==FF Object Types==
===CBaseEntity===
This is the basic type from which all other entities are derived. Consequently there's not a lot you can do with it--see [[:Category:Entity_functions]]. When naming an object of this type, it's best to use the word "entity" to prevent confusion.

The following commands will return a CBaseEntity:
*[[Lua:GetEntity|GetEntity]]( int ) Every entity in the game has a unique ID number. Use the [[Lua:GetId|GetId]]() function to access this number for a particular entity.
*[[Lua:GetEntityByName|GetEntityByName]]( String )
*String [[Lua:GetClassName|GetClassName]]() Returns the entity type as a string.
===InfoScript===
An InfoScript is created by using the [[Lua:info_ff_script | info_ff_script]]:new() command in lua, and placing an info_ff_script in a map. This is usually a game item such as a flag, ball, or supply pack,

The following commands will return an InfoScript:
*[[Lua:GetInfoScriptById|GetInfoScriptById]]( int )
*[[Lua:GetInfoScriptByName|GetInfoScriptByName]]( String )

===TriggerScript===
This is similar to InfoScript, but it's brush-based. Cap points and nobuild zones are Trigger scripts.

The following commands will return a TriggerScript:
*[[Lua:GetTriggerScriptByName|GetTriggerScriptByName]]( String )

===CFFPlayer===
This refers to any client on the server. See [[:Category:Player_functions]] For a list of what you can do with CFFPlayer.
The following commands will return a CFFPlayer:
*[[Lua:GetPlayer|GetPlayer]]( entity ) --This would appear to do the same thing as CastToPlayer (see below). Use that instead.
*[[Lua:GetPlayerByID|GetPlayerByID]]( int )

===CFFTeam===
This refers to one of six teams--"Unassigned" and Spectators, in addition to Blue, Red, Yellow, and Green. See [[:Category:Team_functions]] For a list of what you can do with CFFTeam.

The following commands will return a CFFTeam:
*[[Lua:GetTeam|GetTeam]]( teamId ) This returns a CFFTeam object when given a team number. See [[Lua:Flags#Team]].
===CFFBuildableObject===
Objects that the player can place or build. Includes dispensers, sentry guns, mancannons, and detpacks. See [[:Category:Buildable_functions]].
===CFFGrenadeBase===
Refers to thrown grenades
*[[Lua:GetGrenade|GetGrenade]]() TODO: what parameters does this take?
===CTakeDamageInfo===
Damageinfo is an object that's passed along whenever a player is damaged or dies. By intercepting this object, you can detect events in the game, or change the outcome of those events. Damageinfo can be accessed from within the callbacks player_ondamage and player_killed. See [[:Category:Damageinfo_functions]].

==Entity Checking==
Often in a lua script an entity will be passed to the script as a CBaseEntity. To gain access to more specific functions, we must ''cast'' the variable to a more specific type. But before casting to a more specific type of object, it's usually necessary to verify that the object exists, and that it's the kind of object we expect. Failing to do so can cause the script to fail and the game to crash.

If these functions return ''true'', it is safe to cast to that type of object.
{| border="1" cellspacing="0"
! LUA Command !! Description
|-
| [[Lua:IsPlayer|IsPlayer]]( ent_id ) || used to see if a passed in entity is a player to before actions are performed on said player.
|-
| [[Lua:IsDispenser|IsDispenser]]( ent_id ) ||
|-
| [[Lua:IsSentrygun|IsSentrygun]]( ent_id ) ||
|-
| [[Lua:IsDetpack|IsDetpack]]( ent_id ) ||
|-
| [[Lua:IsGrenade|IsGrenade]]( ent_id ) ||
|-
| [[Lua:IsProjectile|IsProjectile]]( ent_id ) ||
|-
| [[Lua:IsBuildable|IsBuildable]]( ent_id ) ||
|-
| [[Lua:IsTurret|IsTurret]]( ent_id ) || Refers to respawn turrets.
|}

==Casting Commands==
A casting function accepts a CBaseEntity and returns the requested type of object, which you can assign to a new variable.
{| border="1" cellspacing="0"
! LUA Command !! Description
|-
| [[Lua:CastToBeam|CastToBeam]]( ent_id ) || tries to cast the entity to a beam (to see if whatever triggered the event was a laser beam, a la SD2). If it fails, it returns null.
|-
| [[Lua:CastToPlayer|CastToPlayer]]( ent_id ) || used to cast the passed in entity to a player, often used for touch commands.
|-
| [[Lua:CastToInfoScript|CastToInfoScript]]( ent_id ) || This may be a flag, resupply pack, or the like.
|-
| [[Lua:CastToTriggerScript|CastToTriggerScript]]( ent_id ) || This may be any kind of brush trigger that's referred to in an active lua script.
|-
| [[Lua:CastToTriggerClip|CastToTriggerClip]]( ent_id ) || Refers to a [[Lua:trigger_ff_clip|trigger_ff_clip]].
|-
| [[Lua:CastToGrenade|CastToGrenade]]( ent_id ) ||
|-
| [[Lua:CastToDispenser|CastToDispenser]]( ent_id ) ||
|-
| [[Lua:CastToSentrygun|CastToSentrygun]]( ent_id ) ||
|-
| [[Lua:CastToDetpack|CastToDetpack]]( ent_id ) ||
|-
| [[Lua:CastToBuildable|CastToBuildable]]( ent_id ) ||
|-
| [[Lua:CastToProjectile|CastToProjectile]]( ent_id ) ||
|-
| [[Lua:CastToJumpPad|CastToJumpPad]]( ent_id ) ||
|}

==Example==
<pre>--This callback runs when something explodes inside the trigger name detpack_trigger.
function detpack_trigger:onexplode( trigger_entity )
--We want to know if this mysterious exploding CBaseEntity is a detpack. If not we can skip the rest.
if IsDetpack( trigger_entity ) then
local detpack = CastToDetpack( trigger_entity )
--now that we have a detpack object, we can ask it what team it belongs to.
if detpack:GetTeamId() == attackers then
--This triggers a logic_relay in the map, which opens the hole and can trigger any other effect.
OutputEvent( self.prefix .. "_detpack_relay", "Trigger" )
end
end
--This line tells all grenades, etc. that it's still OK to explode.
return EVENT_ALLOWED
end</pre>

[[Category:Lua]]
{{Infobox manual/Footer}}

Lua:Entity typing

2015-04-05T20:51:10Z

R00Kie: /* Entity Checking */

{{Infobox manual/Header}}
{{Infobox_mapping}}
Lua is a dynamically typed language--this means that a variable can hold any type of data at any time. C objects, such as those used in Fortress Forever, are accessed as blocks of raw data. Because altering these objects incorrectly can cause the game to crash, It's important that the Lua system correctly knows what type of class it is dealing with.

==FF Object Types==
===CBaseEntity===
This is the basic type from which all other entities are derived. Consequently there's not a lot you can do with it--see [[:Category:Entity_functions]]. When naming an object of this type, it's best to use the word "entity" to prevent confusion.

The following commands will return a CBaseEntity:
*[[Lua:GetEntity|GetEntity]]( int ) Every entity in the game has a unique ID number. Use the [[Lua:GetId|GetId]]() function to access this number for a particular entity.
*[[Lua:GetEntityByName|GetEntityByName]]( String )
*String [[Lua:GetClassName|GetClassName]]() Returns the entity type as a string.
===InfoScript===
An InfoScript is created by using the [[Lua:info_ff_script | info_ff_script]]:new() command in lua, and placing an info_ff_script in a map. This is usually a game item such as a flag, ball, or supply pack,

The following commands will return an InfoScript:
*[[Lua:GetInfoScriptById|GetInfoScriptById]]( int )
*[[Lua:GetInfoScriptByName|GetInfoScriptByName]]( String )

===TriggerScript===
This is similar to InfoScript, but it's brush-based. Cap points and nobuild zones are Trigger scripts.

The following commands will return a TriggerScript:
*[[Lua:GetTriggerScriptByName|GetTriggerScriptByName]]( String )

===CFFPlayer===
This refers to any client on the server. See [[:Category:Player_functions]] For a list of what you can do with CFFPlayer.
The following commands will return a CFFPlayer:
*[[Lua:GetPlayer|GetPlayer]]( entity ) --This would appear to do the same thing as CastToPlayer (see below). Use that instead.
*[[Lua:GetPlayerByID|GetPlayerByID]]( int )

===CFFTeam===
This refers to one of six teams--"Unassigned" and Spectators, in addition to Blue, Red, Yellow, and Green. See [[:Category:Team_functions]] For a list of what you can do with CFFTeam.

The following commands will return a CFFTeam:
*[[Lua:GetTeam|GetTeam]]( teamId ) This returns a CFFTeam object when given a team number. See [[Lua:Flags#Team]].
===CFFBuildableObject===
Objects that the player can place or build. Includes dispensers, sentry guns, mancannons, and detpacks. See [[:Category:Buildable_functions]].
===CFFGrenadeBase===
Refers to thrown grenades
*[[Lua:GetGrenade|GetGrenade]]() TODO: what parameters does this take?
===CTakeDamageInfo===
Damageinfo is an object that's passed along whenever a player is damaged or dies. By intercepting this object, you can detect events in the game, or change the outcome of those events. Damageinfo can be accessed from within the callbacks player_ondamage and player_killed. See [[:Category:Damageinfo_functions]].

==Entity Checking==
Often in a lua script an entity will be passed to the script as a CBaseEntity. To gain access to more specific functions, we must ''cast'' the variable to a more specific type. But before casting to a more specific type of object, it's usually necessary to verify that the object exists, and that it's the kind of object we expect. Failing to do so can cause the script to fail and the game to crash.

If these functions return ''true'', it is safe to cast to that type of object.
{| border="1" cellspacing="0"
! LUA Command !! Description
|-
| [[Lua:IsPlayer|IsPlayer]]( ent_id ) || used to see if a passed in entity is a player to before actions are performed on said player.
|-
| [[Lua:IsDispenser|IsDispenser]]( ent_id ) ||
|-
| [[Lua:IsSentrygun|IsSentrygun]]( ent_id ) ||
|-
| [[Lua:IsDetpack|IsDetpack]]( ent_id ) ||
|-
| [[Lua:IsGrenade|IsGrenade]]( ent_id ) ||
|-
| [[Lua:IsProjectile|IsProjectile]]( ent_id ) ||
|-
| [[Lua:IsBuildable|IsBuildable]]( ent_id ) ||
|-
| [[Lua:IsTurret|IsTurret]]( ent_id ) || Refers to respawn turrets.
|}

==Casting Commands==
A casting function accepts a CBaseEntity and returns the requested type of object, which you can assign to a new variable.
{| border="1" cellspacing="0"
! LUA Command !! Description
|-
| [[Lua:CastToBeam|CastToBeam]]( ent_id ) || tries to cast the entity to a beam (to see if whatever triggered the event was a laser beam, a la SD2). If it fails, it returns null.
|-
| [[Lua:CastToPlayer|CastToPlayer]]( ent_id ) || used to cast the passed in entity to a player, often used for touch commands.
|-
| [[Lua:CastToInfoScript|CastToInfoScript]]( ent_id ) || This may be a flag, resupply pack, or the like.
|-
| [[Lua:CastToTriggerScript|CastToTriggerScript]]( ent_id ) || This may be any kind of brush trigger that's referred to in an active lua script.
|-
| [[Lua:CastToTriggerClip|CastToTriggerClip]]( ent_id ) || Refers to a [[Lua:trigger_ff_clip|trigger_ff_clip]].
|-
| [[Lua:CastToGrenade|CastToGrenade]]( ent_id ) ||
|-
| [[Lua:CastToDispenser|CastToDispenser]]( ent_id ) ||
|-
| [[Lua:CastToSentrygun|CastToSentrygun]]( ent_id ) ||
|-
| [[Lua:CastToDetpack|CastToDetpack]]( ent_id ) ||
|}

==Example==
<pre>--This callback runs when something explodes inside the trigger name detpack_trigger.
function detpack_trigger:onexplode( trigger_entity )
--We want to know if this mysterious exploding CBaseEntity is a detpack. If not we can skip the rest.
if IsDetpack( trigger_entity ) then
local detpack = CastToDetpack( trigger_entity )
--now that we have a detpack object, we can ask it what team it belongs to.
if detpack:GetTeamId() == attackers then
--This triggers a logic_relay in the map, which opens the hole and can trigger any other effect.
OutputEvent( self.prefix .. "_detpack_relay", "Trigger" )
end
end
--This line tells all grenades, etc. that it's still OK to explode.
return EVENT_ALLOWED
end</pre>

[[Category:Lua]]
{{Infobox manual/Footer}}

Category:Buildable functions

2015-04-05T20:49:23Z

R00Kie:

{{Infobox manual/Header}}
{{Infobox_mapping}}
These are functions that can be applied to machines built by players, such as sentry guns.

===Usage===
CFFBuildableObject:''function''(''parameters)

or

CFFSentryGun:''function''(''parameters)

or

CFFDispener:''function''(''parameters)

''Probably mancannons and detpacks would apply here as well''

===Example===
<pre>
function player_killed ( player_victim, damageinfo )

-- if no damageinfo do nothing
if not damageinfo then return end

-- Entity that is attacking
local attacker = damageinfo:GetAttacker()

-- If no attacker do nothing
if not attacker then return end

elseif IsSentrygun(attacker) then
attacker = CastToSentrygun(attacker)
--attacker now refers to a CFFSentryGun object;
--we can do sentry specific stuff, as well as general buildable stuff.
player_attacker = attacker:GetOwner()
--We now know who owns the sentry who killed this player
end
end
</pre>

CFFBuildableObject -- The basic form of buildable
{| border="1" cellspacing="2" cellpadding="5"
! Command !! Description
|-
| '''GetTeamId'''() || returns teamid of the buildable.
|-
| '''GetOwner'''() || returns the player that built it. Not sure if this is a player object or entity.
|-
| '''GetTeam'''() || returns the team of the buildable.
|}

CFFSentryGun -- Sentrygun is a type of buildable, and inherits all of the above.
{| border="1" cellspacing="2" cellpadding="5"
! Command !! Description
|-
| '''GetLevel'''() || Returns the level of the sentry.
|-
| '''SetLevel'''(int level) || sets the level (does not play upgrade sounds)
|-
| '''Upgrade'''() || upgrades to the next level.
|-
| '''Repair'''(int cells) || adds health based on the number of cells
|-
| '''AddAmmo'''(int shells, int rockets) || adds ammo
|-
| '''RocketPosition'''() || returns the Vector position of where rockets are fired from.
|-
| '''MuzzlePosition'''() || returns the Vector position of where bullets are fired from
|-
| '''GetRockets'''() || number of rockets the SG has
|-
| '''GetShells'''() || number of shells the SG has
|-
| '''GetHealth'''() || amount of health the SG has
|-
| '''SetRockets'''(int rockets) ||
|-
| '''SetShells'''(int shells) ||
|-
| '''SetHealth'''(int health) ||
|-
| '''GetMaxRockets'''() ||
|-
| '''GetMaxShells'''() ||
|-
| '''GetMaxHealth'''() ||
|-
| '''SetFocusPoint'''(Vector point) || sets where the SG wants to look
|-
| '''GetEnemy'''() || gets the target of the SG (CBaseEntity)
|-
| '''SetEnemy'''(CBaseEntity enemy) ||
|-
| '''GetVecAiming'''() || gets the direction vector of the SG's current aim direction
|-
| '''GetVecGoal'''() || gets the direction vector of the SG's goal aim direction
|-
| '''Shoot'''() || makes the SG shoot one shell
|-
| '''ShootRocket'''() || makes the SG shoot one rocket
|}

[[Category:Lua]]
[[Category:Lua_Commands]]
{{Infobox manual/Footer}}