Difference between revisions of "Category:Lua Commands"

From Fortress Forever Wiki
Jump to navigationJump to search
m (2.42)
 
(7 intermediate revisions by the same user not shown)
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.
 
LUA commands that are specific for Fortress Forever. This list is incomplete and will be replaced eventually, and everything put into categories.
  
−
== Casting Commands ==
+
=Global Functions=
−
These functions cast game objects into different data types. See [[Lua:Entity_typing]]
+
Global functions are not confined to any object type. They can be called alone, from just about anywhere in the script.
  
−
{| border="1" cellspacing="0"
+
'''Example:'''
−
! LUA Command !! Description
+
local player = CastToPlayer( player_entity )
−
|-
+
AddHudTimer(player, "timer", 300, -1, 0, 70, 4)
−
| [[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.
+
This global function is not a player function, though it takes a player object as a parameter.
−
|-
+
==[[Lua:Entity_typing#Casting_Commands|Casting Commands]]==
−
| [[Lua:CastToPlayer|CastToPlayer]]( ent_id ) || used to cast the passed in entity to a player, often used for touch commands.
+
These functions cast game objects into different data types. See [[Lua:Entity_typing]].
−
|-
 
−
| [[Lua:CastToInfoScript|CastToInfoScript]]( ent_id ) ||
 
−
|-
 
−
| [[Lua:CastToTriggerScript|CastToTriggerScript]]( ent_id ) ||
 
−
|-
 
−
| [[Lua:CastToTriggerClip|CastToTriggerClip]]( ent_id ) ||
 
−
|-
 
−
| [[Lua:CastToGrenade|CastToGrenade]]( ent_id ) ||
 
−
|-
 
−
| [[Lua:CastToDispenser|CastToDispenser]]( ent_id ) ||
 
−
|-
 
−
| [[Lua:CastToSentrygun|CastToSentrygun]]( ent_id ) ||
 
−
|-
 
−
| [[Lua:CastToDetpack|CastToDetpack]]( ent_id ) ||
 
−
|}
 
  
−
==Entity Checks==
+
==[[Lua:Entity_typing#Entity_Checking|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. See [[Lua:Entity_typing]].
  
−
{| border="1" cellspacing="0"
+
==[[:Category:Messages | Player messaging and sounds]]==
−
! LUA Command !! Description
+
These are used to send text messages and sounds to players.
−
|-
 
−
| [[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 ) ||
 
−
|}
 
  
−
==Player messaging and sounds==
+
==[[:Category:Schedules | Schedules]]==
−
these are used to send text messages and sounds to players.
 
−
 
 
−
{| 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 ) ||
 
−
|-
 
−
| [[Lua:BroadCastSoundToPlayer|BroadCastSoundToPlayer]]( player, sound ) ||
 
−
|-
 
−
| [[Lua:SmartSound|SmartSound]] ||
 
−
|-
 
−
| [[Lua:SmartTeamSound|SmartTeamSound]] ||
 
−
|-
 
−
| [[Lua:SpeakAll|SpeakAll]] ||
 
−
|-
 
−
| [[Lua:SpeakPlayer|SpeakPlayer]] ||
 
−
|-
 
−
| [[Lua:SpeakTeam|SpeakTeam]] ||
 
−
|}
 
−
 
 
−
 
 
−
==Schedules==
 
 
Schedules are a way to delay the effects of a script for a specific length of time.
 
Schedules are a way to delay the effects of a script for a specific length of time.
  
−
{| border="1" cellspacing="0"
+
==[[:Category:HUD_Items | HUD Items]]==
−
! LUA Command !! Description
+
Through Lua, a map can display information on a player's screen.
−
|-
 
−
| [[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:AddScheduleRepeatingNotInfinitely|AddScheduleRepeatingNotInfinitely]]("name", time, function, counts[, param1 ... param4]) || Adds a schedule that repeats (function) (counts) times every (time) seconds.
 
−
|-
 
−
| [[Lua:DeleteSchedule|DeleteSchedule]]( schedulename ) || deletes an existing schedule.
 
−
|-
 
−
| [[Lua:RemoveSchedule|RemoveSchedule]]( schedulename ) || same as delete.
 
−
|}
 
  
−
==HUD Items==
+
==[[:Category:Objective Icons | Objective Icons]]==
−
Through Lua, a map can display information on a player's screen.
+
Objective icons help guide the player to where they are supposed to be.
−
{| border="1" cellspacing="0"
 
−
! LUA Command !! Description
 
−
|-
 
−
| [[Lua:AddHudIcon|AddHudIcon]]( player, HudIconType, NameOfHudIcon, X, Y, Width, Height, Align ) || adds HUD icon to given player of given type. Name is generally taken from the flag entity to apply the right kind. X, Y, W, H, and A are all standard.
 
−
|-
 
−
| [[Lua:AddHudIconToAll|AddHudIconToAll]]( HudIconType, NameOfHudUcon, X, Y, W, H, A ) || adds HUD icon to all players like those used for flag info.
 
−
|-
 
−
| [[Lua:AddHudText|AddHudText]] ||
 
−
|-
 
−
| [[Lua:AddHudTextToAll|AddHudTextToAll]] ||
 
−
|-
 
−
| [[Lua:AddHudTimer|AddHudTimer]] ||
 
−
|-
 
−
| [[Lua:AddHudTimerToAll|AddHudTimerToAll]] ||
 
−
|-
 
−
| [[Lua:RemoveHudItem|RemoveHudItem]] ||
 
−
|-
 
−
| [[Lua:RemoveHudItemFromAll|RemoveHudItemFromAll]] ||
 
−
|}
 
  
−
==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.
  
−
{| border="1" cellspacing="0"
+
=Object functions=
−
! LUA Command !! Description
+
Each class of entity will have its own set of functions. These are listed in the links below:
−
|-
+
* [[:Category:Damageinfo functions|Damageinfo]]-- An object that is created every time someone/something gets hurt in the game.
−
| [[Lua:ConsoleToAll|ConsoleToAll]]( message ) || sends a message to server console. Inaccurately named--players will not see this.
+
* [[:Category:Entity_Functions|Entity]] --A generic game entity from which all of the below are derived.
−
|-
+
* [[:Category:Buildable_functions|Buildable]] -- Sentries, dispensers, etc.
−
| [[Lua:GetConvar|GetConvar]]( cvar ) || checks the value of a console variable (cvar)
+
* [[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.
−
| [[Lua:GetEntity|GetEntity]]( index ) || gets an entity by its index.
+
* [[:Category:Team functions|Team]] -- A team is a group of folks who don't like other groups of folks.
−
|-
 
−
| [[Lua:GetEntityByName|GetEntityByName]]( name ) || obvious?
 
−
|-
 
−
| [[Lua:GetInfoScriptById|GetInfoScriptById]]( id ) || gets an info_ff_script's information by its id.
 
−
|-
 
−
| [[Lua:GetInfoScriptByName|GetInfoScriptByName]]( name ) || obvious?
 
−
|-
 
−
| [[Lua:GetGrenade|GetGrenade]]() || ??
 
−
|-
 
−
| [[Lua:GetPacketloss|GetPacketloss]]( playerentity ) || gets a player's packet loss. Woo?
 
−
|-
 
−
| [[Lua:GetPing|GetPing]]( playerentity ) ||
 
−
|-
 
−
| [[Lua:GetPlayer|GetPlayer]]( playerentity ) ||
 
−
|-
 
−
| [[Lua:GetPlayerByID|GetPlayerByID]]( id ) ||
 
−
|-
 
−
| [[Lua:GetServerTime|GetServerTime]]()  ||
 
−
|-
 
−
| [[Lua:GetSteamID|GetSteamID]]( playerentity ) ||
 
−
|-
 
−
| [[Lua:GetTeam|GetTeam]]( playerentity ) ||
 
−
|-
 
−
| [[Lua:GetTriggerScriptByName|GetTriggerScriptByName]]( name ) ||
 
−
|-
 
−
| [[Lua:GoToIntermission|GoToIntermission]]( ) || ???
 
−
|-
 
−
| [[Lua:IncludeScript|IncludeScript]]( luafile ) || used to include Lua files found in /includes/ such as base_teamplay or base_ctf.
 
−
|-
 
−
| [[Lua:ApplyToAll|ApplyToAll]]( effect ) ||
 
−
|-
 
−
| [[Lua:ApplyToTeam|ApplyToTeam]]( effect, team ) ||
 
−
|-
 
−
| [[Lua:ApplyToPlayer|ApplyToPlayer]]( effect, player ) ||
 
−
|-
 
−
| [[Lua:AreTeamsAllied|AreTeamsAllied]]( team1, team2 ) || obvious?
 
−
|-
 
−
| [[Lua:KillAndRespawnAllPlayers|KillAndRespawnAllPlayers]]() || obvious!
 
−
|-
 
−
| [[Lua:NumPlayers|NumPlayers]]() || gets the number of players.
 
−
|-
 
−
| [[Lua:OutputEvent|OutputEvent]]( event, ent_id[, param1, param2, etc.] ) || tells an entity to fire the given output.
 
−
|-
 
−
| OutputEvent , void * const char* , const char* , const char* , float , unsigned int &FFLib::FireOutput  ||
 
−
|-
 
−
| [[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:RespawnAllPlayers|RespawnAllPlayers]]( ) || respawns everyone.
 
−
|-
 
−
| [[Lua:ResetMap|ResetMap]]() || resets map.
 
−
|-
 
−
| [[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 smart class limits instead of using individual commands.
 
−
|-
 
−
| [[Lua:SetConvar|SetConvar]]( player, var, value ) || sets a players cvar to set value
 
−
|-
 
−
| [[Lua:SetTeamAllies|SetTeamAllies]]( team , bits ) || used to ally one team to another.
 
−
|-
 
−
| [[Lua:SetTeamClassLimit|SetTeamClassLimit]]( team, class, limit ) ||
 
−
|-
 
−
| [[Lua:SetTeamName|SetTeamName]]( team, name ) ||
 
−
|-
 
−
| [[Lua:SetTeamPlayerLimit|SetTeamPlayerLimit]]( team, limit ) ||
 
−
|-
 
−
| [[Lua:SetTeamPlayerLimit|SetTeamPlayerLimit]]( team, limit ) ||
 
−
|}
 
  
 
[[Category:Lua]]
 
[[Category:Lua]]
 
{{Infobox manual/Footer}}
 
{{Infobox manual/Footer}}

Latest revision as of 21:06, 25 June 2011


Mapping for FF
The Basics

Setting up Hammer
Getting Started With Lua
Releasing a map

FF-specific Entities

Lua location system

Map Templates
FF Lua Documentation

Entity Typing
Entity Collections

Commands
Callbacks

LUA commands that are specific for Fortress Forever. This list is incomplete and will be replaced eventually, and everything put into categories.

Global Functions

Global functions are not confined to any object type. They can be called alone, from just about anywhere in the script.

Example: 

local player = CastToPlayer( player_entity )
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

These functions cast game objects into different data types. See Lua:Entity_typing.

Entity Checks

These commands are used to check if the specified entity is a game entity of a specific type. See Lua:Entity_typing.

Player messaging and sounds

These are used to send text messages and sounds to players.

Schedules

Schedules are a way to delay the effects of a script for a specific length of time.

HUD Items

Through Lua, a map can display information on a player's screen.

Objective Icons

Objective icons help guide the player to where they are supposed to be.

Utility

These lua functions are useful for getting your scripts working.

Object functions

Each class of entity will have its own set of functions. These are listed in the links below:

  • Damageinfo-- An object that is created every time someone/something gets hurt in the game.
  • Entity --A generic game entity from which all of the below are derived.
  • Buildable -- Sentries, dispensers, etc.
  • info_ff_script -- A FF game object. These are most often used as flags or other objectives.
  • Player -- Anyone that's connected to a server.
  • Team -- A team is a group of folks who don't like other groups of folks.
Retrieved from "https://www.fortress-forever.com/wiki/index.php?title=Category:Lua_Commands&oldid=9768"