Fortress Forever Wiki - User contributions [en]

Lua:IsPlayerInNoBuild

2007-12-20T01:48:40Z

Stevenm64-10860: fixed links

==IsPlayerInNoBuild==

IsPlayerInNoBuild is used to see if a player is in a "[[:lua:nobuild|nobuild]]" area. By default, a trigger_ff_script named "[[:lua:nobuild|nobuild]]" will not allow players to build while the player is touching the "nobuild" trigger_ff_script entity.

===Usage===
<pre>IsPlayerInNoBuild( ent_id )</pre>

===Input===
The ent_id passed in is simply an integer index that refers to an entities game code ENTINDEX().

===Output===
The output is true or false depending if ent_id is a player and then if the player is in a "[[:lua:nobuild|nobuild]]" area or not.

[[Category:Lua_Commands]]

Lua:IsGrenInNoGren

2007-12-20T01:47:18Z

Stevenm64-10860: Fixed grenade links.

==IsGrenInNoGren==

IsGrenInNoGren is used to see if a grenade is in a "[[:lua:nogrens|nogrens]]" area. By default, a trigger_ff_script named "[[:lua:nogrens|nogrens]]" will not allow grenades to explode while the grenade is touching the "nogrens" trigger_ff_script entity.

===Usage===
<pre>IsGrenInNoGren( ent_id )</pre>

===Input===
The ent_id passed in is simply an integer index that refers to an entities game code ENTINDEX().

===Output===
The output is true or false depending if ent_id is a grenade and then if the grenade is in a "[[:lua:nogrens|nogrens]]" area or not. A list of grenades can be found [[:Category:Grenades|here]].

==Important Note==
'''If you want trigger's to react to grenades you MUST 'check'/'tick' the "everything" option on the flags tab of the entity in Hammer.'''

[[image:tick-everything.JPG]]

[[Category:Lua_Commands]]

Lua:IsGrenInNoGren

2007-12-20T01:45:10Z

Stevenm64-10860: relinked img external link to local uploaded file.

==IsGrenInNoGren==

IsGrenInNoGren is used to see if a grenade is in a "[[:LUA:nogrens|nogrens]]" area. By default, a trigger_ff_script named "[[:LUA:nogrens|nogrens]]" will not allow grenades to explode while the grenade is touching the "nogrens" trigger_ff_script entity.

===Usage===
<pre>IsGrenInNoGren( ent_id )</pre>

===Input===
The ent_id passed in is simply an integer index that refers to an entities game code ENTINDEX().

===Output===
The output is true or false depending if ent_id is a grenade and then if the grenade is in a "[[:LUA:nogrens|nogrens]]" area or not. A list of grenades can be found [[:Category:Grenades|here]].

==Important Note==
'''If you want trigger's to react to grenades you MUST 'check'/'tick' the "everything" option on the flags tab of the entity in Hammer.'''

[[image:tick-everything.JPG]]

[[Category:Lua_Commands]]

File:Tick-everything.JPG

2007-12-20T01:43:29Z

Stevenm64-10860: relinked external link to local uploaded file. http://mulchman.trepid.net/tick-everything.JPG

relinked external link to local uploaded file.
http://mulchman.trepid.net/tick-everything.JPG

Lua:Player spawn

2007-12-14T14:55:26Z

Stevenm64-10860: Lua:Player spawn moved to Lua:player spawn

#REDIRECT [[Lua:player spawn]]

Lua:player spawn

2007-12-14T14:55:26Z

Stevenm64-10860: Lua:Player spawn moved to Lua:player spawn

This function is called whenever a player spawns in the map.

Here is an example of giving the player full health, full armor, full rockets, full shells, and 1 grenade upon spawning (player_id is the player this event is called on and must be passed in to the functions used as shown in the example):
<pre>
function player_spawn( player_id )
-- 400 for overkill. of course the values
-- get clamped in game code
AddHealth( player_id, 400 )
AddArmor( player_id, 400 )

AddAmmo( player_id, "AMMO_NAILS", -400 )
AddAmmo( player_id, "AMMO_SHELLS", 400 )
AddAmmo( player_id, "AMMO_ROCKETS", 400 )
AddAmmo( player_id, "AMMO_CELLS", -400 )
AddAmmo( player_id, "AMMO_DETPACK", -1 )
AddAmmo( player_id, "AMMO_RADIOTAG", -400 )
AddAmmo( player_id, "AMMO_GREN1", -4 )
AddAmmo( player_id, "AMMO_GREN2", -4 )

-- Players get 1 gren1
AddAmmo( player_id, "AMMO_GREN1", 1 )
end
</pre>

[[Category:Lua Commands]]

Lua:Player ondamage

2007-12-14T14:51:51Z

Stevenm64-10860: Lua:Player ondamage moved to Lua:player ondamage

#REDIRECT [[Lua:player ondamage]]

Lua:player ondamage

2007-12-14T14:51:51Z

Stevenm64-10860: Lua:Player ondamage moved to Lua:player ondamage

This function is called whenever a player takes damage. The following variables are set in the global lua namespace before this function is called:
*info_damage: The amount of damage that the player will recieve.
*info_attacker: The player that fired the attack.
*info_classname: The classname of the weapon that hit the player. Note that this may be the classname of the projectile for projectile weapons, or the classname of the weapon for non-projectile weapons.
This function may modify the info_damage global variable in the global scope. If it does, the damage the player takes will be changed. This means that the script for a map can make players recieve more or less damage through scripting. Here is an example script that makes the player take no damage from the super shotgun.
<pre>
function player_ondamage(player_id)
ConsoleToAll(GetPlayerName(info_attacker).." shot "..GetPlayerName(player_id).." with a "..info_classname.." for "..info_damage.." damage")
if info_classname == "ff_weapon_supershotgun" then
ConsoleToAll("Take no damage from supershotty")
info_damage = 0
end
end
</pre>

Here's another example in case you wanted to not take damage from your own rockets:
<pre>
function player_ondamage( player_id )

-- Don't take rocket damage from ourselves
if ( player_id == info_attacker ) then
if ( info_classname == "rocket" ) then
info_damage = 0
end
end
end
</pre>

[[Category:Lua Commands]]

Lua:Player killed

2007-12-14T14:49:46Z

Stevenm64-10860: Lua:Player killed moved to Lua:player killed

#REDIRECT [[Lua:player killed]]

Lua:player killed

2007-12-14T14:49:46Z

Stevenm64-10860: Lua:Player killed moved to Lua:player killed

This function is called whenever a player dies. The global variable "killer" will be set, which contains the player that killed this player.

Here's an example if you wanted to give your team a point when you killed someone not on your team:
<pre>
function player_killed( player_id )
-- If you kill someone, give your team a point
if GetPlayerTeam( killer ) then
if not ( GetPlayerTeam( player_id ) == GetPlayerTeam( killer ) ) then
AddTeamScore( GetPlayerTeam( killer ), 1 )
end
end
end
</pre>

[[Category:Lua Commands]]

Lua Commands

2007-12-14T14:32:07Z

Stevenm64-10860: Redirecting to Category:Lua Commands

#REDIRECT [[Category:Lua_Commands]]

[[Category:LUA]]

Lua Commands

2007-12-14T14:30:07Z

Stevenm64-10860: Undo revision 4262 by Mirvinmonkey-3 (Talk) Pointless, only one list of the commands will need to be kept on the category page.

#REDIRECT [[Category:LUA_Commands]]

[[Category:LUA]]

Lua:Startup

2007-12-13T05:36:40Z

Stevenm64-10860: New page: This function is called when the map starts, after all the entities have been initialized. The main purpose of this function is to set properties of entities or teams, as well as initializ...

This function is called when the map starts, after all the entities have been initialized. The main purpose of this function is to set properties of entities or teams, as well as initialize lua variables. Note that lua variables may be initialized outside this function however.

[[Category:LUA Commands]]

Lua:Precache

2007-12-13T05:35:39Z

Stevenm64-10860: New page: This function is called when the map starts, before entities have been initialized. The main purpose of this is to precache all resources for the map. Category:LUA Commands

This function is called when the map starts, before entities have been initialized. The main purpose of this is to precache all resources for the map.

[[Category:LUA Commands]]

Lua:Tick

2007-12-13T05:34:35Z

Stevenm64-10860: New page: This function is called every second by the engine. Note that this function is in use by base.lua, so should not be declared again. To interface with this command, it must be hooked. ...

This function is called every second by the engine. Note that this function is in use by base.lua, so should not be declared again. To interface with this command, it must be [[hooked]]. A better method would be to use the scheduling interface may be found in the scheduling section of the API.

[[Category:LUA Commands]]

Lua:player ondamage

2007-12-13T05:18:45Z

Stevenm64-10860: New page: This function is called whenever a player takes damage. The following variables are set in the global lua namespace before this function is called: *info_damage: The amount of damage that ...

Lua:player killed

2007-12-13T05:13:16Z

Stevenm64-10860: New page: This function is called whenever a player dies. The global variable "killer" will be set, which contains the player that killed this player. Here's an example if you wanted to give your ...

Lua:player spawn

2007-12-13T05:11:30Z

Stevenm64-10860: New page: This function is called whenever a player spawns in the map. Here is an example of giving the player full health, full armor, full rockets, full shells, and 1 grenade upon spawning (playe...

Talk:Lua:Interaction

2007-12-13T05:07:52Z

Stevenm64-10860: New page: It would be nice to also Move these descriptions of the commands into their own pages (listed within: :Category:LUA Commands ) as well, i may start doing that myself soon. --~~~~

It would be nice to also Move these descriptions of the commands into their own pages (listed within: [[:Category:LUA Commands]] ) as well, i may start doing that myself soon.
--[[User:Stevenm64-10860|Stevenm64-10860]] 23:07, 12 December 2007 (CST)

Lua:Getting Started

2007-12-13T04:59:14Z

Stevenm64-10860:

Alright, because of the spotty knowledge about lua and how to get everything working correctly, I have put together this thread. It is divided into 4 parts:

1. Setting up basic entities (spawns, resupply bags, etc.)
2. Setting up spawn turrets
3. Setting up locations
4. Setting up your gametype (teamplay or CTF)

I am also assuming you have set up Hammer for FF (you can use FF textures, entities, etc).

Before starting, you need to have two things:

* your map, open in Hammer,
* and a lua file, opened through a text editor.

If you don't have a Lua file, create it with a text editor as ''mapname.lua'' (for example, ''ff_well.lua''). This file should be in the same directory your BSP will be in (for the FF beta, it is ''SteamApps\SourceMods\ff_beta\maps\'' )

----

== '''1. Basic Entities''' ==

You will probably want some basic FF entities for your map. These include Spawns, Resupply Bags, Armor, Health Kits and Grenade Bags. This section will teach you how to get all of these working in your map.

''1. Spawns.''
To get spawn points working correctly, place info_ff_teamspawn point-based entities where you would like players to spawn.
Once you have these entities, enter a name for each one on each team. For example, all of the spawn points you want the Green team to spawn at would be named greenspawn. Spawn points for red would each be named redspawn, for blue bluespawn and for yellow yellowspawn.
It is important that when you name your entities, you make sure they are all lowercase. Hammer will try to automatically make the first letter uppercase, but the entities won't work right. However you do it, make sure the text is all lowercase.

''2. Resupply Goodies''
For the next four items (Resupply bags, Armor, Health, and Grenades) you start the same way: create a point-based info_ff_script entity. Place it where you want the goodie to be. Change its name to one of the following things to get it to become what you want. Again, it is important that when you name your entities, you make sure they are all lowercase.

'' a. Resupply bags'' - For the basic resupply bags, name them color_ammobackpack. For example, if I wanted resupply bags that only the Green team could use, I would name each one green_ammobackpack. The same rule applies for all of the other colors. If you want a pack anyone can use, name it ammobackpack.

'' b. Armor Kits'' - For armor, name them color_armorkit. For example, if I wanted armor kits that only the Green team could use, I would name each one green_armorkit. The same rule applies for all four colors. If you want armor anyone can use, name it armorkit.

'' c. Health Kits'' - For health kits, name them color_healthkit. For example, if I wanted health kits only the Green team could use, I would name each one green_healthkit. The same rule applies for all four colors. If you want a health kit anyone can use, name it healthkit.

'' d. Grenade Packs'' - For back packs containing grenades, name them color_grenadebackpack. For example, if I wanted a grenade pack only the Green team could use, I would name them each green_grenadebackpack. This rule applies to all four colors. If you want a grenade pack anyone can use, name it grenadebackpack

'' e. Big Packs'' - For back packs containing everything but grenades, name them color_bigpack. For example, if I wanted a big pack only the Green team could use, I would name them each green_bigpack. This rule applies to all four colors. If you want a big pack anyone can use, name it bigpack

== '''2. Spawn Turrets''' ==

Spawn turrets are those pesky turrets that pop down when an enemy enters your spawn and kills them. They can only be on the ceiling. To get these to work, create a point-based ff_miniturret entity.
Depending on the team you want it to defend for, name it respawnturret_color. For example, if I want to put spawn turrets in the Green team's spawn to shoot red, blue, or yellow team members who enter the green spawn, I would name them each respawnturret_green. The same rule applies for all four colors. Remember, it is important that when you name your entities, you make sure they are all lowercase.

Next, you open your map's lua file (the second of the two files you need open), and enter this line of text on a blank line at the top:
IncludeScript("base_respawnturret");
This makes the turrets you created in Hammer work. Save your map's lua file.

== '''3. Locations''' ==

Locations are those areas that appear on the bottom left of your screen, showing you where you are. When you build your map, you customize these locations by creating brush-based entities wherever players enter or exit each area. For example, if I have a map that is just two rooms with a doorway connecting them, I would want players who pass through the doorway to see that they are either in "North Room" or "South Room".
I will teach you how to do this using this simple example, but the rule is the same for whether you have 1 entrance to your room, or 12 entrances.

''1. First,'' create a brush, and texture it with the orange trigger texture. Make sure it is large enough to completely cover the entrance to your location.

''2. Second,'' turn that brush into a trigger_ff_script entity. Name it location_roomname. For example, if the name of the location I was identifying was "North Room", I would name the trigger_ff_script location_northroom.

''3. Do the above'' two steps for each entrance to your room. Make sure they all have the same name, and be sure that when you name your entities, you they are all lowercase.

''4. Now, open up'' your lua file again. Enter the following text on a new line near the top:
IncludeScript("base_location");
But we aren't finished yet. Scroll down to the bottom of your lua file. We are going to enter new text.

''5. On a new line,'' we are going to tell FF the name we want the player to see for our location. Enter the following text:
location_northroom = location_info:new({ text = "North Room", team = Team.kGreen })
Of course replace location_northroom with the name you gave your trigger_ff_script entities and replace "North Room" with whatever name you want players to see for your room. The last piece you need to check is at the end, where it says team = Team.kGreen. This is here because on my map, the north room belongs to the Green team. For your map, change this to correspond to whichever team controls the location (kRed, kYellow, or kBlue instead of kGreen). If it is neutral territory, change it to say team = NO_TEAM

''6. Do the above'' steps for each of your locations, and it should work in game!

== '''4. Setting Up Your Gametype''' ==

Thanks to the FF team implementing lua, there are nearly limitless gametypes we can create as mappers for FF. These instructions, however, will only show you how to set up two basic game types: teamplay and CTF.

The setup for teamplay is relatively simple: At the top of your map's lua file, add the following text:
IncludeScript("base_teamplay");
Wala! there you go. Save your lua file and you can do team deathmatch or what have you!

For CTF, the set up takes a little more. It begins similarly, however.
''1. At the top'' of your map's lua file, add the following text:
IncludeScript("base_ctf");

''2. Next, you have to create'' the flag. Find the location where you want the flag, and create a point-based info_ff_script entity. Name it color_flag. For example, since the flag I am creating is for the Green team, I would name it green_flag. Again, be sure that when you name your entities, you they are all lowercase. The entity's base will be the bottom point of the flag pole.

''3. Finally, we create'' the capture point. Find where you want the capture point to be, and create a brush that the player can walk into to capture the flag. Texture it with the orange trigger texture, and turn it into a trigger_ff_script entity. Now, name it color_cap, with the color corresponding to the team which captures the flag at that point. For example, I am creating a capture point where the green team brings enemy flags to score points. I would name my entity green_cap.

And that is all! Save your map's lua file, compile your map and load it up. All of the above features should work.

[[Category:Mapping]]
[[Category:LUA]]

Category talk:LUA

2007-12-13T04:57:36Z

Stevenm64-10860: Moved misplaced article into its own page.

Moved a page posted here into: [[FF Lua Getting Started]]
Talk pages are meant to be areas for people to discuss and talk about the attached pages not for posting articles/pages within. --[[User:Stevenm64-10860|Stevenm64-10860]] 22:57, 12 December 2007 (CST)

Lua:Getting Started

2007-12-13T04:53:59Z

Stevenm64-10860: Moved misplaced article to here (article originally by User: Imbrifer)

Lua Commands

2007-12-13T04:22:20Z

Stevenm64-10860: Redirecting to Category:LUA Commands

#REDIRECT [[Category:LUA_Commands]]

[[Category:LUA]]

Lua:SetTeamName

2007-12-02T11:26:36Z

Stevenm64-10860: another misnamed item

==SetTeamName==

SetTeamName is used to set the name of a team in game (instead of just "Red Team", or "Blue Team"). It must be placed in your map's startup() function and gets passed 2 parameters:
<pre>SetTeamName( team, name )</pre>

<pre>
team - team to set limits on
name - [a string] the name of the team (like "Attackers")
</pre>

In this example, we will make red team be called "Flag Hoppers":

===Example .LUA startup() function===
<pre>
function startup()
-- Make red team's name be "Flag Hoppers"
SetTeamName( RED_TEAM, "Flag Hoppers" )
end
</pre>

[[Category:LUA_Commands]]

Lua:SetTeamName

2007-12-02T11:25:48Z

Stevenm64-10860: Misnamed item

==SetTeamName==

SetTeamClassName is used to set the name of a team in game (instead of just "Red Team", or "Blue Team"). It must be placed in your map's startup() function and gets passed 2 parameters:
<pre>SetTeamName( team, name )</pre>

<pre>
team - team to set limits on
name - [a string] the name of the team (like "Attackers")
</pre>

In this example, we will make red team be called "Flag Hoppers":

===Example .LUA startup() function===
<pre>
function startup()
-- Make red team's name be "Flag Hoppers"
SetTeamName( RED_TEAM, "Flag Hoppers" )
end
</pre>

[[Category:LUA_Commands]]

Lua:IsGrenInNoGren

2007-12-02T11:16:40Z

Stevenm64-10860: LUA:IsGrenInNoGren moved to IsGrenInNoGren

==IsGrenInNoGren==

IsGrenInNoGren is used to see if a grenade is in a "[[:LUA:nogrens|nogrens]]" area. By default, a trigger_ff_script named "[[:LUA:nogrens|nogrens]]" will not allow grenades to explode while the grenade is touching the "nogrens" trigger_ff_script entity.

===Usage===
<pre>IsGrenInNoGren( ent_id )</pre>

===Input===
The ent_id passed in is simply an integer index that refers to an entities game code ENTINDEX().

===Output===
The output is true or false depending if ent_id is a grenade and then if the grenade is in a "[[:LUA:nogrens|nogrens]]" area or not. A list of grenades can be found [[:Category:Grenades|here]].

==Important Note==
'''If you want trigger's to react to grenades you MUST 'check'/'tick' the "everything" option on the flags tab of the entity in Hammer.'''

http://mulchman.trepid.net/tick-everything.JPG

[[Category:LUA_Commands]]

Lua:IsPlayer

2007-12-02T11:16:25Z

Stevenm64-10860: LUA:IsPlayer moved to IsPlayer: LUA: prefix not needed.

==IsPlayer==

IsPlayer is used to see if an entity index being passed into a function is a player or not.

===Usage===
<pre>IsPlayer( ent_id )</pre>

===Input===
The ent_id passed in is simply an integer index that refers to an entities game code ENTINDEX().

===Output===
The output is true or false depending if ent_id is a player or not.

===Example===
Here's an example of seeing if someone touching a trigger_ff_script named "red_goal" is a player or not and then giving that players team a point:

<pre>-- In the map's .LUA file...

-- Define red_goal trigger_ff_script
red_goal = trigger_ff_script:new({})

-- When we're touched by a player, do something
function red_goal:ontouch( ent_id )
if IsPlayer( ent_id ) then
-- Add 1 point to the players team
AddTeamScore( GetPlayerTeam( ent_id ), 1 )
end
end</pre>

[[Category:LUA_Commands]]

Lua:SetTeamName

2007-12-02T11:14:46Z

Stevenm64-10860: LUA:SetTeamName moved to SetTeamName: LUA: prefix not needed.

==SetTeamName==

SetTeamClassName is used to set the name of a team in game (instead of just "Red Team", or "Blue Team"). It must be placed in your map's startup() function and gets passed 2 parameters:
<pre>SetTeamClassLimit( team, name )</pre>

<pre>
team - team to set limits on
name - [a string] the name of the team (like "Attackers")
</pre>

In this example, we will make red team be called "Flag Hoppers":

===Example .LUA startup() function===
<pre>
function startup()
-- Make red team's name be "Flag Hoppers"
SetTeamName( RED_TEAM, "Flag Hoppers" )
end
</pre>

[[Category:LUA_Commands]]

Lua:SmartClassLimits

2007-12-02T11:14:34Z

Stevenm64-10860: LUA:SmartClassLimits moved to SmartClassLimits: LUA: prefix not needed.

==SmartClassLimits==

SmartClassLimits is a way of simplifying SetTeamClassLimits. It must be placed in your map's startup() function and gets passed 11 parameters:
<pre>SmartClassLimits( team, scout, sniper, soldier, demoman, medic, hwguy, pyro, spy, engineer, civilian )</pre>

<pre>
team - team to set limits on
scout - number of scouts allowed
sniper - number of snipers allowed
soldier - number of soldiers allowed
demoman - number of demomen allowed
medic - number of medics allowed
hwguy - number of hwguys allowed
pyro - number of pyros allowed
spy - number of spies allowed
engineer - number of engineers allowed
civilian - number of civilians allowed
</pre>

In this example, we will make red only have 2 snipers and blue not have any soldiers, plus eliminate the ability to have civilians on any team:

===Example .LUA startup() function===
<pre>
function startup()
-- Limit red to 2 snipers (and eliminate red civilians)
SmartClassLimits( RED_TEAM, 0, 2, 0, 0, 0, 0, 0, 0, 0, -1 )

-- Remove soldiers from blue team (and eliminate blue civilians)
SmartClassLimits( BLUE_TEAM, 0, 0, -1, 0, 0, 0, 0, 0, 0, -1 )

-- Remove yellow civilians
SmartClassLimits( YELLOW_TEAM, 0, 0, 0, 0, 0, 0, 0, 0, 0, -1 )

-- Remove green civilians
SmartClassLimits( GREEN_TEAM, 0, 0, 0, 0, 0, 0, 0, 0, 0, -1 )
end
</pre>

[[Category:LUA_Commands]]

Lua:SetTeamPlayerLimit

2007-12-02T11:14:29Z

Stevenm64-10860: LUA:SetTeamPlayerLimit moved to SetTeamPlayerLimit: LUA: prefix not needed.

==SetTeamPlayerLimit==

SetTeamPlayerLimit is used to set what teams are allowed. It must be placed in your map's startup() function and gets passed 2 parameters:
<pre>SetTeamPlayerLimit( team, limit )</pre>

<pre>
team - team to set limits on
limit - allowed or not (0 = allowed, -1 = not allowed)
</pre>

In this example, we will make red and blue be the only allowed teams:

===Example .LUA startup() function===
<pre>
function startup()
-- set up team limits (only red & blue)
SetTeamPlayerLimit( BLUE_TEAM, 0 )
SetTeamPlayerLimit( RED_TEAM, 0 )
SetTeamPlayerLimit( YELLOW_TEAM, -1 )
SetTeamPlayerLimit( GREEN_TEAM, -1 )
end
</pre>

[[Category:LUA_Commands]]

Lua:SetTeamClassLimit

2007-12-02T11:13:28Z

Stevenm64-10860: LUA:SetTeamClassLimit moved to SetTeamClassLimit: LUA: prefix not needed.

==SetTeamClassLimit==

SetTeamClassLimit is used to set the class limits for a team. This means telling a team which classes are allowed as well as the number of that class allowed. It must be placed in your map's startup() function and gets passed 3 parameters:
<pre>SetTeamClassLimit( team, class, limit )</pre>

<pre>
team - team to set limits on
class - class to set a limit on
limit - how many are allowed (0 = infinite, -1 = none)
</pre>

In this example, we will make red only have 2 snipers and blue not have any soldiers:

===Example .LUA startup() function===
<pre>
function startup()
-- Limit red to 2 snipers
SetTeamClassLimit( RED_TEAM, CLASS_SNIPER, 2 )

-- Remove soldiers from blue team
SetTeamClassLimit( BLUE_TEAM, CLASS_SOLDIER, -1 )
end
</pre>

Every other class will be allowed an infinite number of players.

[[Category:LUA_Commands]]

Lua:SetTeamAllies

2007-12-02T11:13:02Z

Stevenm64-10860: LUA:SetTeamAllies moved to SetTeamAllies: LUA: prefix not needed.

==SetTeamAllies==

SetTeamAllies is used to ally one team to another.

The SetTeamAllies function only works within a .lua files startup() section. This startup() function
can be added to any .lua file but there should be only one within a .lua file.

===Example .LUA startup() function===
<pre>
function startup()
SetTeamAllies( BLUE_TEAM, 16 );
SetTeamAllies( YELLOW_TEAM, 4 );
end
</pre>

Now, the first parameter in SetTeamAllies is the team that's going to be given an ally. The second command is (for now) a bit field of the team who is going to be the ally.

===Setting blue team to have an ally of yellow team===
<pre>SetTeamAllies( BLUE_TEAM, 16 );</pre>
This tells BLUE TEAM to have an ally of YELLOW TEAM.

===Setting yellow team to have an ally of blue team===
<pre>SetTeamAllies( YELLOW_TEAM, 4 );</pre>
Similarly, this tells YELLOW TEAM to have an ally of BLUE TEAM.

Listing of teams as their 'bitfield' value:
===Team 'bitfield' values===
<pre>
blue team: 4
red team: 8
yellow team: 16
green team: 32
</pre>

[[Category:LUA_Commands]]

Lua:IsPlayerInNoBuild

2007-12-02T11:12:36Z

Stevenm64-10860: LUA:IsPlayerInNoBuild moved to IsPlayerInNoBuild: LUA: prefix not needed.

==IsPlayerInNoBuild==

IsPlayerInNoBuild is used to see if a player is in a "[[:LUA:nobuild|nobuild]]" area. By default, a trigger_ff_script named "[[:LUA:nobuild|nobuild]]" will not allow players to build while the player is touching the "nobuild" trigger_ff_script entity.

===Usage===
<pre>IsPlayerInNoBuild( ent_id )</pre>

===Input===
The ent_id passed in is simply an integer index that refers to an entities game code ENTINDEX().

===Output===
The output is true or false depending if ent_id is a player and then if the player is in a "[[:LUA:nobuild|nobuild]]" area or not.

[[Category:LUA_Commands]]

Lua:IsGrenade

2007-12-02T11:12:19Z

Stevenm64-10860: LUA:IsGrenade moved to IsGrenade: LUA: prefix not needed.

==IsGrenade==

IsGrenade is used to see if an entity index being passed into a function is a grenade or not.

===Usage===
<pre>IsGrenade( ent_id )</pre>

===Input===
The ent_id passed in is simply an integer index that refers to an entities game code ENTINDEX().

===Output===
The output is true or false depending if ent_id is a grenade or not. A list of grenades can be found [[:Category:Grenades|here]].

===Example===
Here's an example of giving a team a point whenever a grenade touches a trigger_ff_script named "red_goal":

<pre>-- In the map's .LUA file...

-- Define red_goal trigger_ff_script
red_goal = trigger_ff_script:new({})

-- When we're touched by a grenade, give the grenade owners team a point
function red_goal:ontouch( ent_id )
if IsGrenade( ent_id ) then
-- Add 1 point to the grenade owners team
AddTeamScore( GetObjectsTeam( ent_id ), 1 )
end
end</pre>

==Important Note==
'''If you want trigger's to react to grenades you MUST 'check'/'tick' the "everything" option on the flags tab of the entity in Hammer.'''

http://mulchman.trepid.net/tick-everything.JPG

[[Category:LUA_Commands]]