Fortress Forever Wiki - User contributions [en]

Category:Utility functions

2015-03-31T00:42:24Z

R00Ki3:

{{Infobox manual/Header}}
{{Infobox mapping}}
These global functions are useful for getting your scripts working.
{| border="1" cellspacing="2" cellpadding="2"
! General Technical Functions !! Description
|-
| [[Lua:IncludeScript|IncludeScript]](string) || This function loads the contents of another lua file, located in FortresForever\maps\includes.
|-
| [[Lua:ConsoleToAll|ConsoleToAll]]( message ) || sends a message to server console. Inaccurately named--players will not see this.
|-
| [[Lua:PrecacheModel|PrecacheModel]]( modelfile ) || loads a given model into memory for use later.
|-
| [[Lua:PrecacheSound|PrecacheSound]]( soundfile ) || as above.
|-
| PrintBool , &FFLib::PrintBool ||
|-
| [[Lua:RandomFloat|RandomFloat]]( min, max ) || generates a random float.
|-
| [[Lua:RandomInt|RandomInt]]( min, max ) || generates a random integer
|-
| [[Lua:RemoveEntity|RemoveEntity]]( ent_id ) || removes entity.
|-
| [[Lua:OutputEvent|OutputEvent]]( entity, input, parameter, delay, x ) || Triggers any named entity in the map using Source's [http://developer.valvesoftware.com/wiki/Inputs_and_Outputs#Inputs I/O system].
|-
| [[Lua:SetConvar|SetConvar]]( player, var, value ) || sets a player's [http://developer.valvesoftware.com/wiki/Console_Command_List console variable] to a specified value.
|-
! Player information !!
|-
| [[Lua:GetPacketloss|GetPacketloss]]( playerentity ) || gets a player's packet loss. Woo?
|-
| [[Lua:GetPing|GetPing]]( playerentity ) ||
|-
| [[Lua:GetSteamID|GetSteamID]]( playerentity ) ||
|-
! Server Info !!
|-
| float [[Lua:GetServerTime|GetServerTime]]() || Returns the number of seconds the map has been running.
|-
| [[Lua:AreTeamsAllied|AreTeamsAllied]]( team1, team2 ) || Returns true if they are.
|-
| [[Lua:GetEntitiesByName|GetEntitiesByName]](entname) || returns a Lua table containing the matching entities.
|-
| [[Lua:NumPlayers|NumPlayers]]() || gets the number of players.
|-
| [[Lua:GetPlayers|GetPlayers]]() || returns a table (array) of all players on the server.
|-
| [[Lua:GetConvar|GetConvar]]( cvar ) || returns the value of a [http://developer.valvesoftware.com/wiki/Console_Command_List console variable] on the server(cvar).
|-
| string [[Lua:GetGameDescription|GetGameDescription]]
|-
! Server Effects !!
|-
| [[Lua:SetGameDescription|SetGameDescription]]( name ) || Changes what appears in the game column of the server browser (it is appended to "FF ")
For use in [[Lua:startup]]().
|-
| [[Lua:RespawnAllPlayers|RespawnAllPlayers]]( ) || Respawns everyone immediately.
|-
| [[Lua:KillAndRespawnAllPlayers|KillAndRespawnAllPlayers]]() || obvious!
|-
| [[Lua:GoToIntermission|GoToIntermission]]( ) || Sends all players to the info_intermission entity and shows them the scoreboard. Then, the map ends.
|-
| [[Lua:ResetMap|ResetMap]]() || resets map.
|-
| [[Lua:set_cvar|set_cvar]](cvar, value) || Sets a [http://developer.valvesoftware.com/wiki/Console_Command_List console variable] on the server
|-
| [[Lua:ApplyToAll|ApplyToAll]]( effect ) || pass this a list of [[Lua:Flags#AT | AT flags]] to apply global effects to the server.
|-
| [[Lua:ApplyToTeam|ApplyToTeam]]( effect, team ) || pass this a team id and a list of [[Lua:Flags#AT | AT flags]] to apply effects to players on a team.
|-
| [[Lua:ApplyToPlayer|ApplyToPlayer]]( effect, player ) || pass this a player id and a list of [[Lua:Flags#AT | AT flags]] to apply effects to a player.
|-
| [[Lua:HasGameStarted|HasGameStarted]]( ) || Returns false if the map is in prematch mode.
|-
| [[Lua:LogLuaEvent|LogLuaEvent]](int, int, string) || Sends a message to the servers logs.
|-
! Game Rules !!
|-
| [[Lua:SetGlobalRespawnDelay|SetGlobalRespawnDelay]]( time ) || enforces a respawn delay.
|-
| [[Lua:SetPlayerLimit|SetPlayerLimit]]( team , # ) || used to set player limit per team.
|-
| [[Lua:SetPlayerLimits|SetPlayerLimits]]( #, # ) ||
|-
| [[Lua:SmartClassLimits|SmartClassLimits]]( team, #scout, #sniper, #soldier, #demoman, #medic, #hwguy, #pyro, #spy, #engineer, #civilian ) || sets class limits for the entire team.
|-
| [[Lua:SetTeamAllies|SetTeamAllies]]( team , bits ) || used to ally one team to another.
|-
| [[Lua:SetTeamClassLimit|SetTeamClassLimit]]( team, class, limit ) ||
|-
| [[Lua:SetTeamName|SetTeamName]]( team, name ) || Set a custom name for a team: appears on the scoreboard and team selection screen.
|-
| [[Lua:SetTeamPlayerLimit|SetTeamPlayerLimit]]( team, limit ) ||
|}
[[Category:Lua]]
[[Category:Lua_Commands]]
{{Infobox manual/Footer}}

Category:Messages

2015-03-31T00:33:27Z

R00Ki3:

{{Infobox mapping}}
This group of Lua Commands deals with notifying players about events in the game.

NOTE: Since FF v2.3, the 'BroadCast' functions can also be used with 'Broadcast'.
{| border="1" cellspacing="0"
! LUA Command !! Description
|-
| [[Lua:BroadCastMessage|BroadCastMessage]]( message ) || broadcasts a given message to all players.
|-
| [[Lua:BroadCastMessageToPlayer|BroadCastMessageToPlayer]]( player, message ) || broadcasts message to one player.
|-
| [[Lua:SmartTeamMessage|SmartTeamMessage]] ||
|-
| [[Lua:SmartMessage|Smartmessage]] ||
|-
| [[Lua:BroadCastSound|BroadCastSound]]( sound ) || Plays a selected sound for players on the server
|-
| [[Lua:BroadCastSoundToPlayer|BroadCastSoundToPlayer]]( player, sound ) ||
|-
| [[Lua:SmartSound|SmartSound]] ||
|-
| [[Lua:SmartTeamSound|SmartTeamSound]] ||
|-
| [[Lua:SpeakAll|SpeakAll]] || Plays a vox sentence for everyone on the server
|-
| [[Lua:SpeakPlayer|SpeakPlayer]] ||
|-
| [[Lua:SmartSpeak|SmartSpeak]] ||
|-
| [[Lua:RandomFlagTouchSpeak|RandomFlagTouchSpeak]]() || Plays a predetermined set of flag touch announcements for the server.
|-
| [[Lua:ObjectiveNotice|ObjectiveNotice]]( player, string ) || Puts a notice in the kill notifications with the player's name, followed by the string. Use it when a player does something special.
|-
| ChatToAll(string) || Displays a message in chat
|-
| ChatToPlayer(player,string) || Displays a message in chat to just one player
|-
| [[Lua:DisplayMessage|SendHintToPlayer]]( player, string ) || Displays a message in the players hint box.
|-
| [[Lua:DisplayMessage|SendHintToTeam]]( teamid, string ) || Displays a message in the teams hint box.
|-
| [[Lua:DisplayMessage|SendHintToAll]]( string ) || Displays a message in everyones hint box.
|}
[[Category:Lua_Commands]]

Category:Messages

2015-03-31T00:32:33Z

R00Ki3:

{{Infobox mapping}}
This group of Lua Commands deals with notifying players about events in the game.

NOTE: Since FF v2.3, the 'BroadCast' functions can also be used with 'Broadcast'.
{| border="1" cellspacing="0"
! LUA Command !! Description
|-
| [[Lua:BroadCastMessage|BroadCastMessage]]( message ) || broadcasts a given message to all players.
|-
| [[Lua:BroadCastMessageToPlayer|BroadCastMessageToPlayer]]( player, message ) || broadcasts message to one player.
|-
| [[Lua:SmartTeamMessage|SmartTeamMessage]] ||
|-
| [[Lua:SmartMessage|Smartmessage]] ||
|-
| [[Lua:BroadCastSound|BroadCastSound]]( sound ) || Plays a selected sound for players on the server
|-
| [[Lua:BroadCastSoundToPlayer|BroadCastSoundToPlayer]]( player, sound ) ||
|-
| [[Lua:SmartSound|SmartSound]] ||
|-
| [[Lua:SmartTeamSound|SmartTeamSound]] ||
|-
| [[Lua:SpeakAll|SpeakAll]] || Plays a vox sentence for everyone on the server
|-
| [[Lua:SpeakPlayer|SpeakPlayer]] ||
|-
| [[Lua:SmartSpeak|SmartSpeak]] ||
|-
| [[Lua:RandomFlagTouchSpeak|RandomFlagTouchSpeak]]() || Plays a predetermined set of flag touch announcements for the server.
|-
| [[Lua:ObjectiveNotice|ObjectiveNotice]]( player, string ) || Puts a notice in the kill notifications with the player's name, followed by the string. Use it when a player does something special.
|-
| ChatToAll(string) || Displays a message in chat
|-
| ChatToPlayer(player,string) || Displays a message in chat to just one player
|-
| [[Lua:DisplayMessage|SendHintToPlayer]]( player, message ) || Displays a message in the players hint box.
|-
| [[Lua:DisplayMessage|SendHintToTeam]]( teamid, message ) || Displays a message in the teams hint box.
|-
| [[Lua:DisplayMessage|SendHintToAll]]( message ) || Displays a message in everyones hint box.
|}
[[Category:Lua_Commands]]

Category:Utility functions

2015-03-31T00:24:34Z

R00Ki3:

{{Infobox manual/Header}}
{{Infobox mapping}}
These global functions are useful for getting your scripts working.
{| border="1" cellspacing="2" cellpadding="2"
! General Technical Functions !! Description
|-
| [[Lua:IncludeScript|IncludeScript]](string) || This function loads the contents of another lua file, located in FortresForever\maps\includes.
|-
| [[Lua:ConsoleToAll|ConsoleToAll]]( message ) || sends a message to server console. Inaccurately named--players will not see this.
|-
| [[Lua:PrecacheModel|PrecacheModel]]( modelfile ) || loads a given model into memory for use later.
|-
| [[Lua:PrecacheSound|PrecacheSound]]( soundfile ) || as above.
|-
| PrintBool , &FFLib::PrintBool ||
|-
| [[Lua:RandomFloat|RandomFloat]]( min, max ) || generates a random float.
|-
| [[Lua:RandomInt|RandomInt]]( min, max ) || generates a random integer
|-
| [[Lua:RemoveEntity|RemoveEntity]]( ent_id ) || removes entity.
|-
| [[Lua:OutputEvent|OutputEvent]]( entity, input, parameter, delay, x ) || Triggers any named entity in the map using Source's [http://developer.valvesoftware.com/wiki/Inputs_and_Outputs#Inputs I/O system].
|-
| [[Lua:SetConvar|SetConvar]]( player, var, value ) || sets a player's [http://developer.valvesoftware.com/wiki/Console_Command_List console variable] to a specified value.
|-
! Player information !!
|-
| [[Lua:GetPacketloss|GetPacketloss]]( playerentity ) || gets a player's packet loss. Woo?
|-
| [[Lua:GetPing|GetPing]]( playerentity ) ||
|-
| [[Lua:GetSteamID|GetSteamID]]( playerentity ) ||
|-
! Server Info !!
|-
| float [[Lua:GetServerTime|GetServerTime]]() || Returns the number of seconds the map has been running.
|-
| [[Lua:AreTeamsAllied|AreTeamsAllied]]( team1, team2 ) || Returns true if they are.
|-
| [[Lua:NumPlayers|NumPlayers]]() || gets the number of players.
|-
| [[Lua:GetConvar|GetConvar]]( cvar ) || returns the value of a [http://developer.valvesoftware.com/wiki/Console_Command_List console variable] on the server(cvar).
|-
| string [[Lua:GetGameDescription|GetGameDescription]]
|-
! Server Effects !!
|-
| [[Lua:SetGameDescription|SetGameDescription]]( name ) || Changes what appears in the game column of the server browser (it is appended to "FF ")
For use in [[Lua:startup]]().
|-
| [[Lua:RespawnAllPlayers|RespawnAllPlayers]]( ) || Respawns everyone immediately.
|-
| [[Lua:KillAndRespawnAllPlayers|KillAndRespawnAllPlayers]]() || obvious!
|-
| [[Lua:GoToIntermission|GoToIntermission]]( ) || Sends all players to the info_intermission entity and shows them the scoreboard. Then, the map ends.
|-
| [[Lua:ResetMap|ResetMap]]() || resets map.
|-
| [[Lua:set_cvar|set_cvar]](cvar, value) || Sets a [http://developer.valvesoftware.com/wiki/Console_Command_List console variable] on the server
|-
| [[Lua:ApplyToAll|ApplyToAll]]( effect ) || pass this a list of [[Lua:Flags#AT | AT flags]] to apply global effects to the server.
|-
| [[Lua:ApplyToTeam|ApplyToTeam]]( effect, team ) || pass this a team id and a list of [[Lua:Flags#AT | AT flags]] to apply effects to players on a team.
|-
| [[Lua:ApplyToPlayer|ApplyToPlayer]]( effect, player ) || pass this a player id and a list of [[Lua:Flags#AT | AT flags]] to apply effects to a player.
|-
| [[Lua:HasGameStarted|HasGameStarted]]( ) || Returns false if the map is in prematch mode.
|-
| [[Lua:LogLuaEvent|LogLuaEvent]](int, int, string) || Sends a message to the servers logs.
|-
! Game Rules !!
|-
| [[Lua:SetGlobalRespawnDelay|SetGlobalRespawnDelay]]( time ) || enforces a respawn delay.
|-
| [[Lua:SetPlayerLimit|SetPlayerLimit]]( team , # ) || used to set player limit per team.
|-
| [[Lua:SetPlayerLimits|SetPlayerLimits]]( #, # ) ||
|-
| [[Lua:SmartClassLimits|SmartClassLimits]]( team, #scout, #sniper, #soldier, #demoman, #medic, #hwguy, #pyro, #spy, #engineer, #civilian ) || sets class limits for the entire team.
|-
| [[Lua:SetTeamAllies|SetTeamAllies]]( team , bits ) || used to ally one team to another.
|-
| [[Lua:SetTeamClassLimit|SetTeamClassLimit]]( team, class, limit ) ||
|-
| [[Lua:SetTeamName|SetTeamName]]( team, name ) || Set a custom name for a team: appears on the scoreboard and team selection screen.
|-
| [[Lua:SetTeamPlayerLimit|SetTeamPlayerLimit]]( team, limit ) ||
|}
[[Category:Lua]]
[[Category:Lua_Commands]]
{{Infobox manual/Footer}}

Category:Utility functions

2015-03-31T00:22:49Z

R00Ki3:

{{Infobox manual/Header}}
{{Infobox mapping}}
These global functions are useful for getting your scripts working.
{| border="1" cellspacing="2" cellpadding="2"
! General Technical Functions !! Description
|-
| [[Lua:IncludeScript|IncludeScript]](string) || This function loads the contents of another lua file, located in FortresForever\maps\includes.
|-
| [[Lua:ConsoleToAll|ConsoleToAll]]( message ) || sends a message to server console. Inaccurately named--players will not see this.
|-
| [[Lua:PrecacheModel|PrecacheModel]]( modelfile ) || loads a given model into memory for use later.
|-
| [[Lua:PrecacheSound|PrecacheSound]]( soundfile ) || as above.
|-
| PrintBool , &FFLib::PrintBool ||
|-
| [[Lua:RandomFloat|RandomFloat]]( min, max ) || generates a random float.
|-
| [[Lua:RandomInt|RandomInt]]( min, max ) || generates a random integer
|-
| [[Lua:RemoveEntity|RemoveEntity]]( ent_id ) || removes entity.
|-
| [[Lua:OutputEvent|OutputEvent]]( entity, input, parameter, delay, x ) || Triggers any named entity in the map using Source's [http://developer.valvesoftware.com/wiki/Inputs_and_Outputs#Inputs I/O system].
|-
| [[Lua:SetConvar|SetConvar]]( player, var, value ) || sets a player's [http://developer.valvesoftware.com/wiki/Console_Command_List console variable] to a specified value.
|-
! Player information !!
|-
| [[Lua:GetPacketloss|GetPacketloss]]( playerentity ) || gets a player's packet loss. Woo?
|-
| [[Lua:GetPing|GetPing]]( playerentity ) ||
|-
| [[Lua:GetSteamID|GetSteamID]]( playerentity ) ||
|-
! Server Info !!
|-
| float [[Lua:GetServerTime|GetServerTime]]() || Returns the number of seconds the map has been running.
|-
| [[Lua:AreTeamsAllied|AreTeamsAllied]]( team1, team2 ) || Returns true if they are.
|-
| [[Lua:NumPlayers|NumPlayers]]() || gets the number of players.
|-
| [[Lua:GetConvar|GetConvar]]( cvar ) || returns the value of a [http://developer.valvesoftware.com/wiki/Console_Command_List console variable] on the server(cvar).
|-
| [[Lua:GetGameDescription|GetGameDescription]]( name )
|-
! Server Effects !!
|-
| [[Lua:SetGameDescription|SetGameDescription]]( name ) || Changes what appears in the game column of the server browser (it is appended to "FF ")
For use in [[Lua:startup]]().
|-
| [[Lua:RespawnAllPlayers|RespawnAllPlayers]]( ) || Respawns everyone immediately.
|-
| [[Lua:KillAndRespawnAllPlayers|KillAndRespawnAllPlayers]]() || obvious!
|-
| [[Lua:GoToIntermission|GoToIntermission]]( ) || Sends all players to the info_intermission entity and shows them the scoreboard. Then, the map ends.
|-
| [[Lua:ResetMap|ResetMap]]() || resets map.
|-
| [[Lua:set_cvar|set_cvar]](cvar, value) || Sets a [http://developer.valvesoftware.com/wiki/Console_Command_List console variable] on the server
|-
| [[Lua:ApplyToAll|ApplyToAll]]( effect ) || pass this a list of [[Lua:Flags#AT | AT flags]] to apply global effects to the server.
|-
| [[Lua:ApplyToTeam|ApplyToTeam]]( effect, team ) || pass this a team id and a list of [[Lua:Flags#AT | AT flags]] to apply effects to players on a team.
|-
| [[Lua:ApplyToPlayer|ApplyToPlayer]]( effect, player ) || pass this a player id and a list of [[Lua:Flags#AT | AT flags]] to apply effects to a player.
|-
| [[Lua:HasGameStarted|HasGameStarted]]( ) || Returns false if the map is in prematch mode.
|-
| [[Lua:LogLuaEvent|LogLuaEvent]](int, int, string) || Sends a message to the servers logs.
|-
! Game Rules !!
|-
| [[Lua:SetGlobalRespawnDelay|SetGlobalRespawnDelay]]( time ) || enforces a respawn delay.
|-
| [[Lua:SetPlayerLimit|SetPlayerLimit]]( team , # ) || used to set player limit per team.
|-
| [[Lua:SetPlayerLimits|SetPlayerLimits]]( #, # ) ||
|-
| [[Lua:SmartClassLimits|SmartClassLimits]]( team, #scout, #sniper, #soldier, #demoman, #medic, #hwguy, #pyro, #spy, #engineer, #civilian ) || sets class limits for the entire team.
|-
| [[Lua:SetTeamAllies|SetTeamAllies]]( team , bits ) || used to ally one team to another.
|-
| [[Lua:SetTeamClassLimit|SetTeamClassLimit]]( team, class, limit ) ||
|-
| [[Lua:SetTeamName|SetTeamName]]( team, name ) || Set a custom name for a team: appears on the scoreboard and team selection screen.
|-
| [[Lua:SetTeamPlayerLimit|SetTeamPlayerLimit]]( team, limit ) ||
|}
[[Category:Lua]]
[[Category:Lua_Commands]]
{{Infobox manual/Footer}}

Category:Global Callbacks

2015-03-31T00:17:48Z

R00Ki3: /* 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: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]]

Player onuse

2015-03-31T00:13:35Z

R00Ki3:

{{Infobox manual/Header}}
{{Infobox mapping}}
==player_onuse ( player )==
This callback is called whenever the player presses the ''USE'' button.

==Usage==
<pre>
function player_onuse( player )
local MyName = player:GetName()

-- Says the players name on use.
ChatToPlayer(player, "My Name is "..MyName.."!")
end
</pre>
'''Return false''' to prevent the use from happening.

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

Player onuse

2015-03-31T00:10:56Z

R00Ki3: Created page with "This callback is called whenever the player presses the ''USE'' button. ==Usage== <pre> function player_onuse( player ) local MyName = player:GetName() -- Says the p..."

This callback is called whenever the player presses the ''USE'' button.

==Usage==
<pre>
function player_onuse( player )
local MyName = player:GetName()

-- Says the players name on use.
ChatToPlayer(player, "My Name is "..MyName.."!")
end
</pre>
'''Return false''' to prevent the use from happening.

Category:Global Callbacks

2015-03-30T23:50:24Z

R00Ki3: /* 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:Tick]]
*[[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:Player functions

2015-03-29T04:51:09Z

R00Ki3:

{{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.
|}
[[Category:Lua]]
[[Category:Lua_Commands]]

Map Editing

2015-03-19T04:31:10Z

R00Ki3: /* Map Editing */

{{Infobox manual/Header}}
{|
|valign="top"|
Fortress Forever allows users to create their own maps. Thanks to the LUA programming language that's implanted into Fortress Forever, map-makers are able to create their own game types.

=Map Editing=
* [[Hammer Intro|How to set up Hammer for Fortress Forever on Steam]]
* [[Mapping Intro|How to set up Hammer for Fortress Forever]] An illustrated guide
* [[Mapping Tips]] There's Nothing here yet.
* [[Entities]] A list of entities added by Fortress Forever
* [[Mapping Resources]] A list of links--downloads, tutorials, and articles.
* [[Releasing a map]] A checklist for sending your map out to the masses.
* [[Tutorials]] A list of tutorials created by the FF Mapping Community

=Lua=
* [[Lua:Getting_Started|Intro to Lua]] This guide shows how to use existing Lua code to create items such as player spawns, ammo bags, and flags. Great for mappers new to FF.
* [[Map_Templates|Templates for Game Types]] By using the included Lua scripts, you can set up common map types easily. Here's how.
* [[Lua:Map Location System|Map location system]] How to name areas of your map, and display those names on the player's screen.
* [[:Category:Lua]] A reference for Lua script writers.
** [[:Category:Lua_Commands|Basic Lua commands]] FF-specific Lua functions.
** [[:Category:Lua_Callbacks|Basic Lua callbacks]] Hooks into the FF code.
** [[Lua:Entity_typing|Entity typing in Lua]] How to handle entity types in Lua.
** [[Lua:Flags|Lua Flags]] Not the wavy things made of cloth. This is a useful reference to enumerations used in FF's Lua system.

[[Category:Mapping]]
|valign="top"|{{Infobox mapping}}
|valign="top"|{{Infobox manual}}
|}
{{Infobox manual/Footer}}

Map Editing

2015-03-19T03:49:01Z

R00Ki3: /* Map Editing */

{{Infobox manual/Header}}
{|
|valign="top"|
Fortress Forever allows users to create their own maps. Thanks to the LUA programming language that's implanted into Fortress Forever, map-makers are able to create their own game types.

=Map Editing=
* [[Hammer Intro|How Set up Hammer for Fortress Forever on Steam]]
* [[Mapping Intro|How to set up Hammer for Fortress Forever]] An illustrated guide
* [[Mapping Tips]] There's Nothing here yet.
* [[Entities]] A list of entities added by Fortress Forever
* [[Mapping Resources]] A list of links--downloads, tutorials, and articles.
* [[Releasing a map]] A checklist for sending your map out to the masses.
* [[Tutorials]] A list of tutorials created by the FF Mapping Community

=Lua=
* [[Lua:Getting_Started|Intro to Lua]] This guide shows how to use existing Lua code to create items such as player spawns, ammo bags, and flags. Great for mappers new to FF.
* [[Map_Templates|Templates for Game Types]] By using the included Lua scripts, you can set up common map types easily. Here's how.
* [[Lua:Map Location System|Map location system]] How to name areas of your map, and display those names on the player's screen.
* [[:Category:Lua]] A reference for Lua script writers.
** [[:Category:Lua_Commands|Basic Lua commands]] FF-specific Lua functions.
** [[:Category:Lua_Callbacks|Basic Lua callbacks]] Hooks into the FF code.
** [[Lua:Entity_typing|Entity typing in Lua]] How to handle entity types in Lua.
** [[Lua:Flags|Lua Flags]] Not the wavy things made of cloth. This is a useful reference to enumerations used in FF's Lua system.

[[Category:Mapping]]
|valign="top"|{{Infobox mapping}}
|valign="top"|{{Infobox manual}}
|}
{{Infobox manual/Footer}}

Map Template:BaseTeamplay

2015-02-06T21:43:57Z

R00Ki3:

{{Infobox manual/Header}}
{{Infobox_mapping}}
base_teamplay includes the basic team-oriented objects needed for most FF maps. To enable it, put this line into your map's Lua file.
<pre>IncludeScript("base_teamplay");</pre>
Note: Most gameplay scripts already include base_teamplay. If you have included one of those already, this step is not necessary.

Simply place the specified type of entity in your map, and give it the name in bold. The game will take care of the rest.

In the list below, substituting 'yellow' or 'green' will support yellow and green teams.
=Backpacks=
*healthkit (info_ff_script): Health kit containing 50 health
*armorkit (info_ff_script): Armor pack containing 200 armour
*ammobackpack (info_ff_script): Backpack containing 20 rpg rounds, 50 bullets, 50 nails, 100 shells, 15 rockets, and 70 cells
*grenbackpack (info_ff_script): Backpack containing 2 primary grenades and 2 secondary grenades
*bluehealthkit (info_ff_script): see above, for blue team
*bluearmorkit (info_ff_script): see above, for blue team
*blueammobackpack (info_ff_script): see above, for blue team
*bluegrenbackpack (info_ff_script): see above, for blue team
*redhealthkit (info_ff_script): see above, for red team
*redarmorkit (info_ff_script): see above, for red team
*redammobackpack (info_ff_script): see above, for red team
*redgrenbackpack (info_ff_script): see above, for red team

=Respawn Doors=
*blue_respawndoor (trigger_multiple): Trigger for blue respawn door
*red_respawndoor (trigger_multiple): Trigger for red respawn door

=Elevator Triggers=
*blue_elevator_trigger (trigger_multiple): Trigger for a blue-only lift
*red_elevator_trigger (trigger_multiple): Trigger for a red-only lift

=Spawn points=
*bluespawn (info_ff_teamspawn): Spawn point for blue player
*redspawn (info_ff_teamspawn): Spawn point for red player

=Detpack triggers=
*detpack_trigger (trigger_ff_script): Trigger that activates when any detpack explodes nearby
*blue_detpack_trigger (trigger_ff_script): Trigger that activates when a blue detpack explodes nearby
*red_detpack_trigger (trigger_ff_script): Trigger that activates when a red detpack explodes nearby
This entity has no effect by default. To cause walls to open, effects to fire, etc. Place a [http://developer.valvesoftware.com/wiki/Logic_relay logic_relay] in your map, and name it 'neutral_det_relay', 'blue_det_relay', 'red_det_relay', etc. Use the logic_relay's onTrigger output to fire events within the map.

=Spawn Protection=
*[[Lua:nobuild|nobuild]] (trigger_ff_script): No players will be allowed to build here
*[[Lua:nogrens|nogrens]] (trigger_ff_script): No grenades will explode here
*[[Lua:noannoyances|noannoyances]] (trigger_ff_script): Within this volume, no grenades will explode, nothing may be built, and players can't be infected by a medic.

=Clipping=
All clips use [[Entity:trigger ff clip|trigger_ff_clip]]
*'''clip_blue''' - clips everything except blue players (blue team "owns" the clip brush)
*'''clip_red''' - clips everything except red players (red team "owns" the clip brush)
*'''clip_yellow''' - clips everything except yellow players (yellow team "owns" the clip brush)
*'''clip_green''' - clips everything except green players (green team "owns" the clip brush)

*'''block_buildables''' - blocks buildables and buildable weapons
*'''block_buildablepathing''' - blocks buildables but not buildable weapons
*'''block_buildableweapons''' - blocks buildable weapons but not buildables
*'''block_spawnturrets''' - blocks spawnturrets (turrets can't see or shoot through this)
*'''block_nonplayers''' - blocks everything except players
*'''block_backpacks''' - blocks backpacks
*'''block_flags''' - blocks info_ff_script entities (flags are info_ff_scripts)

[[Category:Map Templates]] [[Category:Mapping]]
{{Infobox manual/Footer}}

Map Template:BaseTeamplay

2015-02-06T21:37:03Z

R00Ki3:

{{Infobox manual/Header}}
{{Infobox_mapping}}
base_teamplay includes the basic team-oriented objects needed for most FF maps. To enable it, put this line into your map's Lua file.
<pre>IncludeScript("base_teamplay");</pre>
Note: Most gameplay scripts already include base_teamplay. If you have included one of those already, this step is not necessary.

Simply place the specified type of entity in your map, and give it the name in bold. The game will take care of the rest.

In the list below, substituting 'yellow' or 'green' will support yellow and green teams.
=Backpacks=
*healthkit (info_ff_script): Health kit containing 50 health
*armorkit (info_ff_script): Armor pack containing 200 armour
*ammobackpack (info_ff_script): Backpack containing 20 rpg rounds, 50 bullets, 50 nails, 100 shells, 15 rockets, and 70 cells
*grenbackpack (info_ff_script): Backpack containing 2 primary grenades and 2 secondary grenades
*bluehealthkit (info_ff_script): see above, for blue team
*bluearmorkit (info_ff_script): see above, for blue team
*blueammobackpack (info_ff_script): see above, for blue team
*bluegrenbackpack (info_ff_script): see above, for blue team
*redhealthkit (info_ff_script): see above, for red team
*redarmorkit (info_ff_script): see above, for red team
*redammobackpack (info_ff_script): see above, for red team
*redgrenbackpack (info_ff_script): see above, for red team

=Respawn Doors=
*blue_respawndoor (trigger_multiple): Trigger for blue respawn door
*red_respawndoor (trigger_multiple): Trigger for red respawn door

=Elevator Triggers=
*blue_elevator_trigger (trigger_multiple): Trigger for a blue-only lift
*red_elevator_trigger (trigger_multiple): Trigger for a red-only lift

=Spawn points=
*bluespawn (info_ff_teamspawn): Spawn point for blue player
*redspawn (info_ff_teamspawn): Spawn point for red player

=Detpack triggers=
*detpack_trigger (trigger_ff_script): Trigger that activates when any detpack explodes nearby
*blue_detpack_trigger (trigger_ff_script): Trigger that activates when a blue detpack explodes nearby
*red_detpack_trigger (trigger_ff_script): Trigger that activates when a red detpack explodes nearby
This entity has no effect by default. To cause walls to open, effects to fire, etc. Place a [http://developer.valvesoftware.com/wiki/Logic_relay logic_relay] in your map, and name it 'neutral_det_relay', 'blue_det_relay', 'red_det_relay', etc. Use the logic_relay's onTrigger output to fire events within the map.

=Spawn Protection=
*[[Lua:nobuild|nobuild]] (trigger_ff_script): No players will be allowed to build here
*[[Lua:nogrens|nogrens]] (trigger_ff_script): No grenades will explode here
*[[Lua:noannoyances|noannoyances]] (trigger_ff_script): Within this volume, no grenades will explode, nothing may be built, and players can't be infected by a medic.

=Clipping=
*clip_blue (trigger_ff_clip): Clips everything but Blue players.
*clip_red (trigger_ff_clip): Clips everything but Red players.
*clip_yellow (trigger_ff_clip): Clips everything but Yellow players.
*clip_green (trigger_ff_clip): Clips everything but Green players.

[[Category:Map Templates]] [[Category:Mapping]]
{{Infobox manual/Footer}}

Lua:Flags

2015-02-06T21:20:48Z

R00Ki3:

{{Infobox manual/Header}}
{{Infobox mapping}}
{{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}}

Lua:Flags

2015-02-06T21:05:35Z

R00Ki3:

{{Infobox manual/Header}}
{{Infobox mapping}}
{{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 (HWGuy and Demoman)}}
{{Lua:Flag|Grenade.kMirvlet|The four mini-grenades that come out of the Mirv grenade (HWGuy and 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}}

Lua:Flags

2015-02-06T20:58:19Z

R00Ki3:

{{Infobox manual/Header}}
{{Infobox mapping}}
{{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 (HWGuy and Demoman)}}
{{Lua:Flag|Grenade.kMirvlet|The four mini-grenades that come out of the Mirv grenade (HWGuy and 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-- used for [[:Category:HUD_Items]]
|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|}}

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

Category:Player functions

2015-01-10T22:02:52Z

R00Ki3: /* 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) ||Gives the player health points. Negative numbers will hurt the player
|-
| 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'''()
|-
| boolean '''IsDucking'''()
|-
| boolean '''IsGrenade1Primed'''() || Player has a live frag grenade
|-
| boolean '''IsGrenade2Primed'''()
|-
| boolean '''IsGrenadePrimed'''()
|-
| 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
|-
| 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.
|}
[[Category:Lua]]
[[Category:Lua_Commands]]

Category:Global Callbacks

2015-01-10T09:15:41Z

R00Ki3: /* 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:Tick]]
*[[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_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:Utility functions

2015-01-10T08:28:09Z

R00Ki3:

{{Infobox manual/Header}}
{{Infobox mapping}}
These global functions are useful for getting your scripts working.
{| border="1" cellspacing="2" cellpadding="2"
! General Technical Functions !! Description
|-
| [[Lua:IncludeScript|IncludeScript]](string) || This function loads the contents of another lua file, located in FortresForever\maps\includes.
|-
| [[Lua:ConsoleToAll|ConsoleToAll]]( message ) || sends a message to server console. Inaccurately named--players will not see this.
|-
| [[Lua:PrecacheModel|PrecacheModel]]( modelfile ) || loads a given model into memory for use later.
|-
| [[Lua:PrecacheSound|PrecacheSound]]( soundfile ) || as above.
|-
| PrintBool , &FFLib::PrintBool ||
|-
| [[Lua:RandomFloat|RandomFloat]]( min, max ) || generates a random float.
|-
| [[Lua:RandomInt|RandomInt]]( min, max ) || generates a random integer
|-
| [[Lua:RemoveEntity|RemoveEntity]]( ent_id ) || removes entity.
|-
| [[Lua:OutputEvent|OutputEvent]]( entity, input, parameter, delay, x ) || Triggers any named entity in the map using Source's [http://developer.valvesoftware.com/wiki/Inputs_and_Outputs#Inputs I/O system].
|-
| [[Lua:SetConvar|SetConvar]]( player, var, value ) || sets a player's [http://developer.valvesoftware.com/wiki/Console_Command_List console variable] to a specified value.
|-
! Player information !!
|-
| [[Lua:GetPacketloss|GetPacketloss]]( playerentity ) || gets a player's packet loss. Woo?
|-
| [[Lua:GetPing|GetPing]]( playerentity ) ||
|-
| [[Lua:GetSteamID|GetSteamID]]( playerentity ) ||
|-
! Server Info !!
|-
| float [[Lua:GetServerTime|GetServerTime]]() || Returns the number of seconds the map has been running.
|-
| [[Lua:AreTeamsAllied|AreTeamsAllied]]( team1, team2 ) || Returns true if they are.
|-
| [[Lua:NumPlayers|NumPlayers]]() || gets the number of players.
|-
| [[Lua:GetConvar|GetConvar]]( cvar ) || returns the value of a [http://developer.valvesoftware.com/wiki/Console_Command_List console variable] on the server(cvar).
|-
! Server Effects !!
|-
| [[Lua:SetGameDescription|SetGameDescription]]( name ) || Changes what appears in the game column of the server browser (it is appended to "FF ")
For use in [[Lua:startup]]().
|-
| [[Lua:RespawnAllPlayers|RespawnAllPlayers]]( ) || Respawns everyone immediately.
|-
| [[Lua:KillAndRespawnAllPlayers|KillAndRespawnAllPlayers]]() || obvious!
|-
| [[Lua:GoToIntermission|GoToIntermission]]( ) || Sends all players to the info_intermission entity and shows them the scoreboard. Then, the map ends.
|-
| [[Lua:ResetMap|ResetMap]]() || resets map.
|-
| [[Lua:set_cvar|set_cvar]](cvar, value) || Sets a [http://developer.valvesoftware.com/wiki/Console_Command_List console variable] on the server
|-
| [[Lua:ApplyToAll|ApplyToAll]]( effect ) || pass this a list of [[Lua:Flags#AT | AT flags]] to apply global effects to the server.
|-
| [[Lua:ApplyToTeam|ApplyToTeam]]( effect, team ) || pass this a team id and a list of [[Lua:Flags#AT | AT flags]] to apply effects to players on a team.
|-
| [[Lua:ApplyToPlayer|ApplyToPlayer]]( effect, player ) || pass this a player id and a list of [[Lua:Flags#AT | AT flags]] to apply effects to a player.
|-
| [[Lua:HasGameStarted|HasGameStarted]]( ) || Returns false if the map is in prematch mode.
|-
| [[Lua:LogLuaEvent|LogLuaEvent]](int, int, string) || Sends a message to the servers logs.
|-
! Game Rules !!
|-
| [[Lua:SetGlobalRespawnDelay|SetGlobalRespawnDelay]]( time ) || enforces a respawn delay.
|-
| [[Lua:SetPlayerLimit|SetPlayerLimit]]( team , # ) || used to set player limit per team.
|-
| [[Lua:SetPlayerLimits|SetPlayerLimits]]( #, # ) ||
|-
| [[Lua:SmartClassLimits|SmartClassLimits]]( team, #scout, #sniper, #soldier, #demoman, #medic, #hwguy, #pyro, #spy, #engineer, #civilian ) || sets class limits for the entire team.
|-
| [[Lua:SetTeamAllies|SetTeamAllies]]( team , bits ) || used to ally one team to another.
|-
| [[Lua:SetTeamClassLimit|SetTeamClassLimit]]( team, class, limit ) ||
|-
| [[Lua:SetTeamName|SetTeamName]]( team, name ) || Set a custom name for a team: appears on the scoreboard and team selection screen.
|-
| [[Lua:SetTeamPlayerLimit|SetTeamPlayerLimit]]( team, limit ) ||
|}
[[Category:Lua]]
[[Category:Lua_Commands]]
{{Infobox manual/Footer}}

Category:Utility functions

2015-01-10T08:25:02Z

R00Ki3:

{{Infobox manual/Header}}
{{Infobox mapping}}
These global functions are useful for getting your scripts working.
{| border="1" cellspacing="2" cellpadding="2"
! General Technical Functions !! Description
|-
| [[Lua:IncludeScript|IncludeScript]](string) || This function loads the contents of another lua file, located in FortresForever\maps\includes.
|-
| [[Lua:ConsoleToAll|ConsoleToAll]]( message ) || sends a message to server console. Inaccurately named--players will not see this.
|-
| [[Lua:PrecacheModel|PrecacheModel]]( modelfile ) || loads a given model into memory for use later.
|-
| [[Lua:PrecacheSound|PrecacheSound]]( soundfile ) || as above.
|-
| PrintBool , &FFLib::PrintBool ||
|-
| [[Lua:RandomFloat|RandomFloat]]( min, max ) || generates a random float.
|-
| [[Lua:RandomInt|RandomInt]]( min, max ) || generates a random integer
|-
| [[Lua:RemoveEntity|RemoveEntity]]( ent_id ) || removes entity.
|-
| [[Lua:OutputEvent|OutputEvent]]( entity, input, parameter, delay, x ) || Triggers any named entity in the map using Source's [http://developer.valvesoftware.com/wiki/Inputs_and_Outputs#Inputs I/O system].
|-
| [[Lua:SetConvar|SetConvar]]( player, var, value ) || sets a player's [http://developer.valvesoftware.com/wiki/Console_Command_List console variable] to a specified value.
|-
! Player information !!
|-
| [[Lua:GetPacketloss|GetPacketloss]]( playerentity ) || gets a player's packet loss. Woo?
|-
| [[Lua:GetPing|GetPing]]( playerentity ) ||
|-
| [[Lua:GetSteamID|GetSteamID]]( playerentity ) ||
|-
! Server Info !!
|-
| float [[Lua:GetServerTime|GetServerTime]]() || Returns the number of seconds the map has been running.
|-
| [[Lua:AreTeamsAllied|AreTeamsAllied]]( team1, team2 ) || Returns true if they are.
|-
| [[Lua:NumPlayers|NumPlayers]]() || gets the number of players.
|-
| [[Lua:GetConvar|GetConvar]]( cvar ) || returns the value of a [http://developer.valvesoftware.com/wiki/Console_Command_List console variable] on the server(cvar).
|-
! Server Effects !!
|-
| [[Lua:SetGameDescription|SetGameDescription]]( name ) || Changes what appears in the game column of the server browser (it is appended to "FF ")
For use in [[Lua:startup]]().
|-
| [[Lua:RespawnAllPlayers|RespawnAllPlayers]]( ) || Respawns everyone immediately.
|-
| [[Lua:KillAndRespawnAllPlayers|KillAndRespawnAllPlayers]]() || obvious!
|-
| [[Lua:GoToIntermission|GoToIntermission]]( ) || Sends all players to the info_intermission entity and shows them the scoreboard. Then, the map ends.
|-
| [[Lua:ResetMap|ResetMap]]() || resets map.
|-
| [[Lua:set_cvar|set_cvar]](cvar, value) || Sets a [http://developer.valvesoftware.com/wiki/Console_Command_List console variable] on the server
|-
| [[Lua:ApplyToAll|ApplyToAll]]( effect ) || pass this a list of [[Lua:Flags#AT | AT flags]] to apply global effects to the server.
|-
| [[Lua:ApplyToTeam|ApplyToTeam]]( effect, team ) || pass this a team id and a list of [[Lua:Flags#AT | AT flags]] to apply effects to players on a team.
|-
| [[Lua:ApplyToPlayer|ApplyToPlayer]]( effect, player ) || pass this a player id and a list of [[Lua:Flags#AT | AT flags]] to apply effects to a player.
|-
| [[Lua:HasGameStarted|HasGameStarted]]( ) || Returns false if the map is in prematch mode.
|-
| [[Lua:LogLuaEvent|LogLuaEvent]](int, int, string) ||
|-
! Game Rules !!
|-
| [[Lua:SetGlobalRespawnDelay|SetGlobalRespawnDelay]]( time ) || enforces a respawn delay.
|-
| [[Lua:SetPlayerLimit|SetPlayerLimit]]( team , # ) || used to set player limit per team.
|-
| [[Lua:SetPlayerLimits|SetPlayerLimits]]( #, # ) ||
|-
| [[Lua:SmartClassLimits|SmartClassLimits]]( team, #scout, #sniper, #soldier, #demoman, #medic, #hwguy, #pyro, #spy, #engineer, #civilian ) || sets class limits for the entire team.
|-
| [[Lua:SetTeamAllies|SetTeamAllies]]( team , bits ) || used to ally one team to another.
|-
| [[Lua:SetTeamClassLimit|SetTeamClassLimit]]( team, class, limit ) ||
|-
| [[Lua:SetTeamName|SetTeamName]]( team, name ) || Set a custom name for a team: appears on the scoreboard and team selection screen.
|-
| [[Lua:SetTeamPlayerLimit|SetTeamPlayerLimit]]( team, limit ) ||
|}
[[Category:Lua]]
[[Category:Lua_Commands]]
{{Infobox manual/Footer}}

Category:Player functions

2014-11-20T20:03:26Z

R00Ki3:

{{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) ||Gives the player health points. Negative numbers will hurt the player
|-
| 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'''()
|-
| boolean '''IsDucking'''()
|-
| boolean '''IsGrenade1Primed'''() || Player has a live frag grenade
|-
| boolean '''IsGrenade2Primed'''()
|-
| boolean '''IsGrenadePrimed'''()
|-
| 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
|-
| 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.
|}
[[Category:Lua]]
[[Category:Lua_Commands]]

Category:Player functions

2014-11-20T19:42:08Z

R00Ki3:

{{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) ||Gives the player health points. Negative numbers will hurt the player
|-
| 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'''()
|-
| boolean '''IsDucking'''()
|-
| boolean '''IsGrenade1Primed'''() || Player has a live frag grenade
|-
| boolean '''IsGrenade2Primed'''()
|-
| boolean '''IsGrenadePrimed'''()
|-
| 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
|-
| 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.
|}
[[Category:Lua]]
[[Category:Lua_Commands]]

Category:Player functions

2014-11-20T19:41:24Z

R00Ki3:

{{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) ||Gives the player health points. Negative numbers will hurt the player
|-
| 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'''()
|-
| boolean '''IsDucking'''()
|-
| boolean '''IsGrenade1Primed'''() || Player has a live frag grenade
|-
| boolean '''IsGrenade2Primed'''()
|-
| boolean '''IsGrenadePrimed'''()
|-
| 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
|-
| 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.
|}
[[Category:Lua]]
[[Category:Lua_Commands]]

Category:Player functions

2014-11-20T19:32:51Z

R00Ki3:

{{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) ||Gives the player health points. Negative numbers will hurt the player
|-
| 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'''()
|-
| boolean '''IsDucking'''()
|-
| boolean '''IsGrenade1Primed'''() || Player has a live frag grenade
|-
| boolean '''IsGrenade2Primed'''()
|-
| boolean '''IsGrenadePrimed'''()
|-
| 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
|-
| 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.
|}
[[Category:Lua]]
[[Category:Lua_Commands]]

Category:Player functions

2014-11-19T22:14:31Z

R00Ki3:

{{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) ||Gives the player health points. Negative numbers will hurt the player
|-
| 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'''()
|-
| boolean '''IsDucking'''()
|-
| boolean '''IsGrenade1Primed'''() || Player has a live frag grenade
|-
| boolean '''IsGrenade2Primed'''()
|-
| boolean '''IsGrenadePrimed'''()
|-
| 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
|-
| 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.
|}
[[Category:Lua]]
[[Category:Lua_Commands]]

Lua:Entity typing

2014-11-19T22:14:28Z

R00Ki3:

{{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: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:Messages

2014-11-17T03:01:49Z

R00Ki3:

{{Infobox mapping}}
This group of Lua Commands deals with notifying players about events in the game.

NOTE: Since FF v2.3, the 'BroadCast' functions can also be used with 'Broadcast'.
{| border="1" cellspacing="0"
! LUA Command !! Description
|-
| [[Lua:BroadCastMessage|BroadCastMessage]]( message ) || broadcasts a given message to all players.
|-
| [[Lua:BroadCastMessageToPlayer|BroadCastMessageToPlayer]]( player, message ) || broadcasts message to one player.
|-
| [[Lua:SmartTeamMessage|SmartTeamMessage]] ||
|-
| [[Lua:SmartMessage|Smartmessage]] ||
|-
| [[Lua:BroadCastSound|BroadCastSound]]( sound ) || Plays a selected sound for players on the server
|-
| [[Lua:BroadCastSoundToPlayer|BroadCastSoundToPlayer]]( player, sound ) ||
|-
| [[Lua:SmartSound|SmartSound]] ||
|-
| [[Lua:SmartTeamSound|SmartTeamSound]] ||
|-
| [[Lua:SpeakAll|SpeakAll]] || Plays a vox sentence for everyone on the server
|-
| [[Lua:SpeakPlayer|SpeakPlayer]] ||
|-
| [[Lua:SmartSpeak|SmartSpeak]] ||
|-
| [[Lua:RandomFlagTouchSpeak|RandomFlagTouchSpeak]]() || Plays a predetermined set of flag touch announcements for the server.
|-
| [[Lua:ObjectiveNotice|ObjectiveNotice]]( player, string ) || Puts a notice in the kill notifications with the player's name, followed by the string. Use it when a player does something special.
|-
| ChatToAll(string) || Displays a message in chat
|-
| ChatToPlayer(player,string) || Displays a message in chat to just one player
|-
| [[Lua:DisplayMessage|DisplayMessage]]( player, message ) || Displays a message in the players hint box.
|}
[[Category:Lua_Commands]]

Category:Messages

2014-11-17T03:00:05Z

R00Ki3:

{{Infobox mapping}}
This group of Lua Commands deals with notifying players about events in the game.

NOTE: Since FF v2.3, the 'BroadCast' functions can also be used with 'Broadcast'.
{| border="1" cellspacing="0"
! LUA Command !! Description
|-
| [[Lua:BroadCastMessage|BroadCastMessage]]( message ) || broadcasts a given message to all players.
|-
| [[Lua:BroadCastMessageToPlayer|BroadCastMessageToPlayer]]( player, message ) || broadcasts message to one player.
|-
| [[Lua:SmartTeamMessage|SmartTeamMessage]] ||
|-
| [[Lua:SmartMessage|Smartmessage]] ||
|-
| [[Lua:BroadCastSound|BroadCastSound]]( sound ) || Plays a selected sound for players on the server
|-
| [[Lua:BroadCastSoundToPlayer|BroadCastSoundToPlayer]]( player, sound ) ||
|-
| [[Lua:SmartSound|SmartSound]] ||
|-
| [[Lua:SmartTeamSound|SmartTeamSound]] ||
|-
| [[Lua:SpeakAll|SpeakAll]] || Plays a vox sentence for everyone on the server
|-
| [[Lua:SpeakPlayer|SpeakPlayer]] ||
|-
| [[Lua:SmartSpeak|SmartSpeak]] ||
|-
| [[Lua:RandomFlagTouchSpeak|RandomFlagTouchSpeak]]() || Plays a predetermined set of flag touch announcements for the server.
|-
| [[Lua:ObjectiveNotice|ObjectiveNotice]]( player, string ) || Puts a notice in the kill notifications with the player's name, followed by the string. Use it when a player does something special.
|-
| ChatToAll(string) || Displays a message in chat
|-
| ChatToPlayer(player,string) || Displays a message in chat to just one player
|-
| DisplayMessage( player, message ) || Displays a message in the players hint box.
|}
[[Category:Lua_Commands]]

Category:Player functions

2014-11-11T16:58:23Z

R00Ki3:

{{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) ||Gives the player health points. Negative numbers will hurt the player
|-
| integer '''GetClass'''() ||Returns the class of the player as a number (0-9)
|-
| string '''GetClassName'''() ||Returns the class of the player as a string
|-
| 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'''()
|-
| boolean '''IsDucking'''()
|-
| boolean '''IsGrenade1Primed'''() || Player has a live frag grenade
|-
| boolean '''IsGrenade2Primed'''()
|-
| boolean '''IsGrenadePrimed'''()
|-
| 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
|-
| 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.
|}
[[Category:Lua]]
[[Category:Lua_Commands]]

Lua:buildable ondamage

2014-11-11T05:33:03Z

R00Ki3:

{{Infobox manual/Header}}
==buildable_ondamage(buildable, damageinfo)==
This function is called whenever a buildable takes damage.

===Example===
A player shooting nails at a buildable will do no damage.
<pre>
function buildable_ondamage(buildable, damageinfo)

local weapon = damageinfo:GetInflictor():GetClassName()
local attacking_player = damageinfo:GetAttacker()
local attacker = CastToPlayer( attacking_player )

-- Take no damage from Nail shooting weapons
if weapon == "ff_projectile_nail" then
damageinfo:SetDamage(0)
ChatToPlayer(attacker, "Nope!")
end
ConsoleToAll(attacker:GetName().." attacked with "..weapon)
end
</pre>

Lua:buildable ondamage

2014-11-11T05:30:08Z

R00Ki3: Created page with "===Example=== A player shooting nails at a buildable will do no damage. <pre> function buildable_ondamage(buildable, damageinfo) local weapon = damageinfo:GetInflictor():Get..."

===Example===
A player shooting nails at a buildable will do no damage.
<pre>
function buildable_ondamage(buildable, damageinfo)

local weapon = damageinfo:GetInflictor():GetClassName()
local attacking_player = damageinfo:GetAttacker()
local attacker = CastToPlayer( attacking_player )

-- Take no damage from Nail shooting weapons
if weapon == "ff_projectile_nail" then
damageinfo:SetDamage(0)
ChatToPlayer(attacker, "Nope!")
end
ConsoleToAll(attacker:GetName().." attacked with "..weapon)
end
</pre>

Category:Damageinfo functions

2014-11-11T04:57:25Z

R00Ki3:

{{Infobox manual/Header}}
{{Infobox_mapping}}
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 [[Lua:player_ondamage|player_ondamage]], [[Lua:buildable_ondamage|buildable_ondamage]] and [[Lua:player_killed|player_killed]].

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

===Example===
<pre>function player_ondamage( player, damageinfo )

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

local attacker = damageinfo:GetAttacker()
local inflictor = damageinfo:GetInflictor()

-- hunted has body armor on and only takes damage from certain things
if player:GetTeamId() == Team.kBlue then
local weapon = damageinfo:GetInflictor():GetClassName()
local attacker_is_buildable = false

if IsSentrygun(attacker) or IsDispenser(attacker) or IsSentrygun(inflictor) or IsDispenser(inflictor) then
attacker_is_buildable = true
end
if attacker_is_buildable ~= true and weapon ~= "ff_weapon_sniperrifle" and
weapon ~= "ff_weapon_crowbar" and weapon ~= "ff_projectile_dart" and weapon ~= "ff_weapon_knife" then
damageinfo:ScaleDamage(0)
else
end

-- hunted also has quad damage
else
if IsPlayer( attacker ) then
attacker = CastToPlayer( attacker )
if attacker:GetTeamId() == Team.kBlue and player:GetTeamId() ~= HUNTED_ALLIES_TEAM then
damageinfo:ScaleDamage(4)
attacker:AddFortPoints( POINTS_PER_HUNTED_ATTACK * 10, "Hunted Attack" )
ConsoleToAll( "The Hunted, " .. attacker:GetName() .. ", dealt quad damage to" .. player:GetName() .. "!" )
end
end
end
end
</pre>

===Functions===
{| border="1" cellspacing="2" cellpadding="5"
! Command !! Description
|-
|entity GetAttacker() || Returns the entity that did damage. May be a player or buildable.
|-
|GetInflictor() || Returns the object that caused the damage. May be a weapon, projectile, or grenade.
|-
|GetDamage() || Returns the current damage being dealt.
|-
|Vector GetDamageForce() || Returns the push force being dealt as a vector.
|-
|GetDamagePosition() || REturns the position of the damage event as a vector?
|-
|GetDamageType()
|-
|GetAmmoType()
|-
|ScaleDamage(float) || Multiply the damage done by this number.
|-
|SetDamage(float) || Do this amount of damage
|-
|SetDamageForce( Vector(0,0,0) ) || Sets a new force vector to push the player that is being damaged.
|}

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

Category:Player functions

2014-11-11T04:52:59Z

R00Ki3: /* 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) ||Gives the player health points. Negative numbers will hurt the player
|-
| integer '''GetClass'''() ||Returns the class of the player as a number (0-9)
|-
| string '''GetClassName'''() ||Returns the class of the player as a string
|-
| 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'''()
|-
| boolean '''IsDucking'''()
|-
| boolean '''IsGrenade1Primed'''() || Player has a live frag grenade
|-
| boolean '''IsGrenade2Primed'''()
|-
| boolean '''IsGrenadePrimed'''()
|-
| integer '''GetAmmoInClip'''()
|-
| integer '''GetAmmoInClip'''( weaponname )
|-
| '''SetAmmoInClip'''( num )
|-
| '''SetAmmoInClip'''( weaponname, num )
|-
| integer '''GetAmmoCount'''( ammotype )
|-
| '''ReloadClips'''() || magic reload!
|-
| boolean '''IsBot'''()
|-
| '''MarkRadioTag'''() || No uses found
|-
| '''AddAmmo'''([[Lua:Flags#Ammo]], integer) || Gives ammunition to the player
|-
| '''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
|-
| 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.
|}
[[Category:Lua]]
[[Category:Lua_Commands]]