Fortress Forever Wiki - User contributions [en]

Lua:info ff script mulch

2006-07-19T01:55:53Z

Mulchman MM:

==Introduction==
An info_ff_script is a point-based scriptable entity. If you are familiar with TFC's entities, this entity is ''somewhat'' similiar to [http://tf.valve-erc.com/kbase.php?id=1 info_tfgoals] and [http://tf.valve-erc.com/kbase.php?id=2 item_tfgoals]; however, the scriptability behind this entity makes it a great deal more flexibile.

info_ff_script entities represent items that can affect, and be affected by players. Such items might be the flags in a CTF map, or the armor, health and ammo packs in a respawn room.

==Using info_ff_script's==
info_ff_script's are placed in a map through Hammer just like placing any point-based entity. If you are unfamiliar with this process, [http://www.whitehouse.gov suck a dick].

It is important that any info_ff_script have a name. You can give it a name in Hammer. The name you choose for the entity is what is used in your map's LUA file to tie the info_ff_script entity to an actual useable object in-game.

Example info_ff_script names are: "red_flag", "resup_pack", "blue_armor", "yellow_healthkit", etc.

==The Flexibility - The Confusion==
Because info_ff_script's can be used for such a wide array of purposes, the amount of ways to interact and retrieve information from them can be overwhelming.

Alright... going to bed for the night.

Lua:info ff script mulch

2006-07-19T01:47:56Z

Mulchman MM:

Lua:info ff script mulch

2006-07-19T01:40:20Z

Mulchman MM:

2006-06-19T19:55:02Z

Mulchman MM:

Lua:nobuild

2006-06-19T19:54:44Z

Mulchman MM:

==No Build Areas - "nobuild"==

A "nobuild" area is defined as an area where a player is not allowed to build a dispenser or sentrygun - hence "nobuild". To create a "nobuild" area in your map all you need to do is create a brush, click "tie to entity", choose trigger_ff_script, and then name it "nobuild". Then, in your map's .LUA file be sure to include base_teamplay.lua as such:

<pre>-- Map's LUA file

-- Include nogrens functionality
IncludeScript( "base_teamplay" )</pre>

===How It Works===
The way a "nobuild" area works is that when the player tries to build the game checks to see just exactly what entities the player is touching. It then asks those entity if it the player can build. If any of the entities respond back with "false" then the player cannot build. The LUA function that answers the question if the player can build is "canbuild" (as seen in the example) so if you want to override default "canbuild" behavior then your custom "nobuild" lua object will need to have a "canbuild" function.

===Example===
If you wanted red team to be able to build in an area but blue team not be allowed to do that then you can do that. There are really only two changes you would need to make. First, name your "nobuild" area (in hammer) to something else - like "blue_nobuild". Then, modify your map's lua file thusly:

<pre>-- Map's LUA file

-- Define "blue_nobuild"
blue_nobuild = trigger_ff_script({})

-- Let red team build but not blud team
-- here we define the "canbuild" function
function blue_nobuild:canbuild( ent_id )
if IsPlayer( ent_id ) then
-- Allow red team
if ( GetPlayerTeam( ent_id ) == RED_TEAM ) then
return true
else -- Disallow every other team
return false
end
end

-- Return normally for anything else
return true
end</pre>

[[Category:LUA]]

Lua:nobuild

2006-06-19T19:53:09Z

Mulchman MM:

==No Build Areas - "nobuild"==

A "nobuild" area is defined as an area where a player is not allowed to build a dispenser or sentrygun - hence "nobuild". To create a "nobuild" area in your map all you need to do is create a brush, click "tie to entity", choose trigger_ff_script, and then name it "nobuild". Then, in your map's .LUA file be sure to include base_teamplay.lua as such:

<pre>-- Map's LUA file

-- Include nogrens functionality
IncludeScript( "base_teamplay" )</pre>

===How It Works===
The way a "nobuild" area works is that when the player tries to build the game checks to see just exactly what entities the player is touching. It then asks those entity if it the player can build. If any of the entities respond back with "false" then the player cannot build. The LUA function that answers the question if the player can build is "canbuild" (as seen in the example) so if you want to override default "canbuild" behavior then your custom "nobuild" lua object will need to have a "canbuild" function.

===Example===
If you wanted red team to be able to throw grenades in an area (and have them explode) but blue team not be allowed to do that then you can do that. There are really only two changes you would need to make. First, name your "nogrens" area (in hammer) to something else - like "blue_nogrens". Then, modify your map's lua file thusly:

<pre>-- Map's LUA file

-- Define "blue_nogrens"
blue_nogrens = trigger_ff_script({})

-- Let red team's grenades explode but not blue team's
-- here we define the "canexplode" function
function blue_nogrens:canexplode( ent_id )
if IsGrenade( ent_id ) then
-- Allow red team
if ( GetObjectsTeam( ent_id ) == RED_TEAM ) then
return true
else -- Disallow everyone other team
return false
end
end

-- Return normally for anything not a grenade
return true
end</pre>

[[Category:LUA]]

Lua:nogrens

2006-06-19T19:45:50Z

Mulchman MM:

==No Grenade Areas - "nogrens"==

A "nogrens" area is defined as an area where grenades will not explode - hence "nogrens". To create a "nogrens" area in your map all you need to do is create a brush, click "tie to entity", choose trigger_ff_script, and then name it "nogrens". Then, in your map's .LUA file be sure to include base_teamplay.lua as such:

<pre>-- Map's LUA file

-- Include nogrens functionality
IncludeScript( "base_teamplay" )</pre>

===How It Works===
The way a "nogrens" area works is that before the grenade goes to explode it checks to see just exactly what entities it is touching. It then asks those entity if it can explode. If any of the entities respond back with "false" then the grenade can not explode. The LUA function that answers the question if the grenade can explode is "canexplode" (as seen in the example) so if you want to override default "nogrens" behavior then your custom "nogrens" lua object will need to have a "canexplode" function.

===Example===
If you wanted red team to be able to throw grenades in an area (and have them explode) but blue team not be allowed to do that then you can do that. There are really only two changes you would need to make. First, name your "nogrens" area (in hammer) to something else - like "blue_nogrens". Then, modify your map's lua file thusly:

<pre>-- Map's LUA file

-- Define "blue_nogrens"
blue_nogrens = trigger_ff_script({})

-- Let red team's grenades explode but not blue team's
-- here we define the "canexplode" function
function blue_nogrens:canexplode( ent_id )
if IsGrenade( ent_id ) then
-- Allow red team
if ( GetObjectsTeam( ent_id ) == RED_TEAM ) then
return true
else -- Disallow everyone other team
return false
end
end

-- Return normally for anything not a grenade
return true
end</pre>

[[Category:LUA]]

Lua:nobuild

2006-06-19T19:43:55Z

Mulchman MM:

==No Build Areas - "nogrens"==

A "nogrens" area is defined as an area where grenades will not explode - hence "nogrens". To create a "nogrens" area in your map all you need to do is create a brush, click "tie to entity", choose trigger_ff_script, and then name it "nogrens". Then, in your map's .LUA file be sure to include base_teamplay.lua as such:

<pre>-- Map's LUA file

-- Include nogrens functionality
IncludeScript( "base_teamplay" )</pre>

===How It Works===
The way a "nogrens" area works is that before the grenade goes to explode it checks to see just exactly what entities it is touching. It then asks those entity if it can explode. If any of the entities respond back with "false" then the grenade can not explode. The LUA function that answers the question if the grenade can explode is "canexplode" (as seen in the example) so if you want to override default "nogrens" behavior then your custom "nogrens" lua object will need to have a "canexplode" function.

===Example===
If you wanted red team to be able to throw grenades in an area (and have them explode) but blue team not be allowed to do that then you can do that. There are really only two changes you would need to make. First, name your "nogrens" area (in hammer) to something else - like "blue_nogrens". Then, modify your map's lua file thusly:

<pre>-- Map's LUA file

-- Define "blue_nogrens"
blue_nogrens = trigger_ff_script({})

-- Let red team's grenades explode but not blue team's
-- here we define the "canexplode" function
function blue_nogrens:canexplode( ent_id )
if IsGrenade( ent_id ) then
-- Allow red team
if ( GetObjectsTeam( ent_id ) == RED_TEAM ) then
return true
else -- Disallow everyone other team
return false
end
end

-- Return normally for anything not a grenade
return true
end</pre>

[[Category:LUA]]

Lua:nobuild

2006-06-19T19:43:22Z

Mulchman MM:

Lua:nobuild

2006-06-19T19:42:59Z

Mulchman MM: /* No Build Areas - "nogrens" */

==No Build Areas - "nogrens"==

A "nogrens" area is defined as an area where grenades will not explode - hence "nogrens". To create a "nogrens" area in your map all you need to do is create a brush, click "tie to entity", choose trigger_ff_script, and then name it "nogrens". Then, in your map's .LUA file be sure to include base_teamplay.lua as such:

<pre>-- Map's LUA file

-- Include nogrens functionality
IncludeScript( "base_teamplay" )</pre>

===How It Works===
The way a "nogrens" area works is that before the grenade goes to explode it checks to see just exactly what entities it is touching. It then asks those entity if it can explode. If any of the entities respond back with "false" then the grenade can not explode. The LUA function that answers the question if the grenade can explode is "canexplode" (as seen in the example) so if you want to override default "nogrens" behavior then your custom "nogrens" lua object will need to have a "canexplode" function.

===Example===
If you wanted red team to be able to throw grenades in an area (and have them explode) but blue team not be allowed to do that then you can do that. There are really only two changes you would need to make. First, name your "nogrens" area (in hammer) to something else - like "blue_nogrens". Then, modify your map's lua file thusly:

<pre>
-- Map's LUA file

-- Define "blue_nogrens"
blue_nogrens = trigger_ff_script({})

-- Let red team's grenades explode but not blue team's
-- here we define the "canexplode" function
function blue_nogrens:canexplode( ent_id )
if IsGrenade( ent_id ) then
-- Allow red team
if ( GetObjectsTeam( ent_id ) == RED_TEAM ) then
return true
else -- Disallow everyone other team
return false
end
end

-- Return normally for anything not a grenade
return true
end

[[Category:LUA]]

</pre>

2006-06-19T18:21:12Z

Mulchman MM: /* Manipulating Players */

=Introduction=
LUA Commands are functions LUA can use to call into game code to do something and usually return a result. These are also referred to as "entry points".

==Communicating with player==
*BroadCastMessage
*BroadCastMessageToPlayer
*BroadCastSound
*BroadCastSoundToPlayer
*ConsoleToAll
*EmitSound
*SmartMessage
*SmartSound
*SmartTeamMessage
*SmartTeamSound

==Interfacing with map entities==
*CloseDoor
*FireOutput
*LockButton
*LockDoor
*OpenDoor
*PressButton
*ToggleDoor
*SpawnEntityAtPlayer
*UnlockButton
*UnlockDoor
*UseEntity

==Finding Information about the Players==
*GetPlayer
*GetPlayerClass
*GetPlayerOnTeam
*GetPlayerName
*GetPlayerTeam
*NumPlayers
*NumPlayersOnTeam

==Manipulating Players==
*AddAmmo
*AddFrags
*AddHealth
*AddArmor
*IsPlayer
*IsPlayerFeetDeepInWater
*IsPlayerUnderWater
*IsPlayerWaistDeepInWater
*MarkRadioTag
*RemoveAmmo
*RespawnAllPlayers
*RespawnPlayer
*SetPlayerDisguisable
*SetPlayerRespawnDelay

''Dealing with locations:''
*SetPlayerLocation
*RemoveLocation

''Dealing with nobuild areas:''
*IsPlayerInNoBuild

==Manipulating Teams==
*AddTeamScore
*IsTeam1AlliedToTeam2
*[[LUA:SetTeamAllies|SetTeamAllies]]
*[[LUA:SetTeamClassLimit|SetTeamClassLimit]]
*SetTeamPlayerLimit
*[[LUA:SmartClassLimits|SmartClassLimits]]

==Manipulating Grenades==
*[[LUA:IsGrenade|IsGrenade]]

''Dealing with nogren areas:''
*[[LUA:IsGrenInNoGren|IsGrenInNoGren]]
*[[LUA:SetGrenNoGren|SetGrenNoGren]]
*[[LUA:RemoveGrenNoGren|RemoveGrenNoGren]]

==Item/Flag related==
*DropItem
*Pickup
*PlayerHasItem
*RemoveItem
*Respawn
*ReturnItem

==Misc==
*GetObjectsTeam
*IncludeScript
*IsDispenser
*IsObjectsOriginInWater
*IsObjectsOriginInSlime
*IsSentrygun
*PrecacheModel
*PrecacheSound
*Random / rand
*SetGlobalRespawnDelay
*SetModel

==Map Location System==
*[[LUA:Map Location System|Map Location System]]

[[Category:LUA]]

Lua:IsGrenInNoGren

2006-06-18T14:58:44Z

Mulchman MM:

Lua:IsGrenInNoGren

2006-06-18T14:40:56Z

Mulchman MM:

==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]]

2006-06-18T14:30:33Z

Mulchman MM: