Category:Lua Commands - Revision history

Crazycarl: 2.42

2011-06-26T05:06:23Z

2.42

Crazycarl: Moved all functions into categories

2010-05-05T18:41:09Z

Moved all functions into categories

Crazycarl at 18:21, 5 May 2010

2010-05-05T18:21:59Z

Crazycarl at 18:03, 5 May 2010

2010-05-05T18:03:24Z

Crazycarl at 07:02, 2 May 2010

2010-05-02T07:02:16Z

Crazycarl at 06:46, 2 May 2010

2010-05-02T06:46:50Z

Crazycarl at 07:02, 16 February 2010

2010-02-16T07:02:19Z

Crazycarl at 02:16, 11 July 2009

2009-07-11T02:16:50Z

Crazycarl at 01:32, 11 July 2009

2009-07-11T01:32:35Z

Crazycarl at 04:04, 12 May 2009

2009-05-12T04:04:15Z

@@ Line 33: / Line 33: @@
 =Object functions=
 Each class of entity will have its own set of functions. These are listed in the links below:
 * [[:Category:Buildable_functions|Buildable]] -- Sentries, dispensers, etc.
-* [[:Category:Damageinfo functions|Damageinfo]]-- An object that is created every time someone/something gets hurt in the game.
+* [[Lua:info_ff_script|info_ff_script]] -- A FF game object. These are most often used as flags or other objectives.
 * [[:Category:Player functions|Player]] -- Anyone that's connected to a server.
 * [[:Category:Team functions|Team]] -- A team is a group of folks who don't like other groups of folks.

@@ Line 28: / Line 28: @@
 Objective icons help guide the player to where they are supposed to be.
-==Other Commands==
+==[[:Category:Utility functions | Utility]]==
-Other misc commands not lumped into any group as of yet.
+These lua functions are useful for getting your scripts working.
 =Object functions=

@@ Line 42: / Line 42: @@
 |-
 | [[Lua:GetConvar|GetConvar]]( cvar ) || checks the value of a console variable (cvar)
 |-
 | [[Lua:GetPacketloss|GetPacketloss]]( playerentity ) || gets a player's packet loss. Woo?
@@ Line 64: / Line 54: @@
 |-
 | [[Lua:GetSteamID|GetSteamID]]( playerentity ) ||
 |-
 | [[Lua:GoToIntermission|GoToIntermission]]( ) || Sends all players to the info_intermission entity and shows them the scoreboard. Then, the map ends.
 |-
 | [[Lua:ApplyToAll|ApplyToAll]]( effect ) ||
@@ Line 84: / Line 68: @@
 |-
 | [[Lua:NumPlayers|NumPlayers]]() || gets the number of players.
 |-
 | [[Lua:PrecacheModel|PrecacheModel]]( modelfile ) || loads a given model into memory for use later.

@@ Line 69: / Line 69: @@
 | [[Lua:GetTriggerScriptByName|GetTriggerScriptByName]]( name ) ||
 |-
-| [[Lua:GoToIntermission|GoToIntermission]]( ) || ???
+| [[Lua:GoToIntermission|GoToIntermission]]( ) || Sends all players to the info_intermission entity and shows them the scoreboard. Then, the map ends.
 |-
 | [[Lua:IncludeScript|IncludeScript]]( luafile ) || used to include Lua files found in /includes/ such as base_teamplay or base_ctf.
@@ Line 79: / Line 79: @@
 | [[Lua:ApplyToPlayer|ApplyToPlayer]]( effect, player ) ||
 |-
-| [[Lua:AreTeamsAllied|AreTeamsAllied]]( team1, team2 ) || obvious?
+| [[Lua:AreTeamsAllied|AreTeamsAllied]]( team1, team2 ) || Returns true if they are.
 |-
 | [[Lua:KillAndRespawnAllPlayers|KillAndRespawnAllPlayers]]() || obvious!

@@ Line 10: / Line 10: @@
   AddHudTimer(player, "timer", 300, -1, 0, 70, 4)
 This global function is not a player function, though it takes a player object as a parameter.
-== Casting Commands ==
+==[[Lua:Entity_typing#Casting_Commands|Casting Commands]]==
-These functions cast game objects into different data types. See [[Lua:Entity_typing]]
+These functions cast game objects into different data types. See [[Lua:Entity_typing]].
-{| border="1" cellspacing="0"
+==[[Lua:Entity_typing#Entity_Checking|Entity Checks]]==
-! LUA Command !! Description
+These commands are used to check if the specified entity is a game entity of a specific type. See [[Lua:Entity_typing]].
 ==[[:Category:Messages | Player messaging and sounds]]==

@@ Line 3: / Line 3: @@
 LUA commands that are specific for Fortress Forever. This list is incomplete and will be replaced eventually, and everything put into categories.
 == Casting Commands ==
 These functions cast game objects into different data types. See [[Lua:Entity_typing]]
@@ Line 29: / Line 36: @@
 ==Entity Checks==
-These commands are used to check if a passed in entity is a game entity of a specific type
+These commands are used to check if the specified entity is a game entity of a specific type.
 {| border="1" cellspacing="0"
@@ Line 75: / Line 82: @@
 | [[Lua:SpeakTeam|SpeakTeam]] ||
 |}
 ==Schedules==
@@ Line 103: / Line 109: @@
 | [[Lua:AddHudIconToAll|AddHudIconToAll]]( HudIconType, NameOfHudUcon, X, Y, W, H, A ) || adds HUD icon to all players like those used for flag info.
 |-
-| [[Lua:AddHudText|AddHudText]] ||
+| [[Lua:AddHudText|AddHudText]] || Puts a bit of text on the screen.
 |-
 | [[Lua:AddHudTextToAll|AddHudTextToAll]] ||
 |-
-| [[Lua:AddHudTimer|AddHudTimer]] ||
+| [[Lua:AddHudTimer|AddHudTimer]] || Puts a countdown timer on the screen.
 |-
 | [[Lua:AddHudTimerToAll|AddHudTimerToAll]] ||
@@ Line 114: / Line 120: @@
 |-
 | [[Lua:RemoveHudItemFromAll|RemoveHudItemFromAll]] ||
 |}
@@ Line 208: / Line 225: @@
 | [[Lua:SetTeamPlayerLimit|SetTeamPlayerLimit]]( team, limit ) ||
 |}
 [[Category:Lua]]
 {{Infobox manual/Footer}}

@@ Line 1: / Line 1: @@
 {{Infobox manual/Header}}
-LUA commands that require further explanation. This list is incomplete and will be replaced eventually, and everything put into categories.
+{{Infobox mapping}}
 == Casting Commands ==
@@ Line 27: / Line 28: @@
 |}
-= Entity Checks =
+==Entity Checks==
-these commands are used to Check if a passed in entity is a game entity of a specific type
+These commands are used to check if a passed in entity is a game entity of a specific type
 {| border="1" cellspacing="0"
@@ Line 46: / Line 47: @@
 |}
-= Player messaging and sounds =
+==Player messaging and sounds==
 these are used to send text messages and sounds to players.
@@ Line 55: / Line 56: @@
 |-
 | [[Lua:BroadCastMessageToPlayer|BroadCastMessageToPlayer]]( player, message ) || broadcasts message to one player.
 |-
 | [[Lua:BroadCastSound|BroadCastSound]]( sound ) ||
@@ Line 60: / Line 65: @@
 | [[Lua:BroadCastSoundToPlayer|BroadCastSoundToPlayer]]( player, sound ) ||
 |-
-| [[Lua:ConsoleToAll|ConsoleToAll]]( message ) || sends a message to server console. Inaccurately named.
+| [[Lua:SmartSound|SmartSound]] ||
 |}
-= Other Commands =
-other misc commands not lumped into any group as of yet.
+==Schedules==
 {| border="1" cellspacing="0"
 ! LUA Command !! Description
 |-
-| [[Lua:AddSchedule|AddSchedule]]("name", time, function[, param1 ... param4]) || Schedules function to go off with time second delay. Optional parameters are applied to the function.
+| [[Lua:AddSchedule|AddSchedule]]("name", time, function[, param1 ... param4]) || Schedules function to go off with (time) second delay. Optional parameters are applied to the function.
 |-
-| [[Lua:AddScheduleRepeating|AddScheduleRepeating]]("name", time, function[, param1 ... param4]) || Adds a schedule that repeats function constantly every time seconds.
+| [[Lua:AddScheduleRepeating|AddScheduleRepeating]]("name", time, function[, param1 ... param4]) || Adds a schedule that repeats (function) constantly every (time) seconds.
 |-
-| [[Lua:AddScheduleRepeatingNotInfinitely|AddScheduleRepeatingNotInfinitely]]("name", time, function, counts[, param1 ... param4]) || Adds a schedule that repeats function counts times every time seconds.
+| [[Lua:AddScheduleRepeatingNotInfinitely|AddScheduleRepeatingNotInfinitely]]("name", time, function, counts[, param1 ... param4]) || Adds a schedule that repeats (function) (counts) times every (time) seconds.
 |-
 | [[Lua:AddHudIcon|AddHudIcon]]( player, HudIconType, NameOfHudIcon, X, Y, Width, Height, Align ) || adds HUD icon to given player of given type. Name is generally taken from the flag entity to apply the right kind. X, Y, W, H, and A are all standard.
@@ Line 79: / Line 103: @@
 | [[Lua:AddHudIconToAll|AddHudIconToAll]]( HudIconType, NameOfHudUcon, X, Y, W, H, A ) || adds HUD icon to all players like those used for flag info.
 |-
-| [[Lua:DeleteSchedule|DeleteSchedule]]( schedulename ) || deletes an existing schedule.
+| [[Lua:AddHudText|AddHudText]] ||
 |-
-| [[Lua:RemoveSchedule|RemoveSchedule]]( schedulename ) || same as delete.
+| [[Lua:ConsoleToAll|ConsoleToAll]]( message ) || sends a message to server console. Inaccurately named--players will not see this.
 |-
 | [[Lua:GetConvar|GetConvar]]( cvar ) || checks the value of a console variable (cvar)
@@ Line 142: / Line 183: @@
 |-
 | [[Lua:RemoveEntity|RemoveEntity]]( ent_id ) || removes entity.
 |-
 | [[Lua:RespawnAllPlayers|RespawnAllPlayers]]( ) || respawns everyone.
@@ Line 170: / Line 207: @@
 |-
 | [[Lua:SetTeamPlayerLimit|SetTeamPlayerLimit]]( team, limit ) ||
 |}
 [[Category:Lua]]
 {{Infobox manual/Footer}}