Fortress Forever Wiki - User contributions [en]

Lua:SetTeamAllies

2006-06-03T04:30:02Z

FryGuy:

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

This function is deprecated

===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:Interaction

2006-06-03T04:26:53Z

FryGuy:

== Introduction ==
For all of the following events, the first parameter to the function will be the player that caused the event, where applicable. The '''entid''' global variable will be set which contains the entity that fired the event. Additionally, more global variables may be set and read by the engine depending on the event.

Whenever an event is called, the engine will run the lua command '''<entity name>:<event name>()'''. This means that if you have an info_ff_script entity named '''red_flag''' and the event '''touch''' is being called, then '''red_flag:touch(12)''' may be called, if the player with id 12 touches the flag.

The following is a good way to define entities:
<pre>
red_flag = info_ff_script:new({})
function red_flag:touch(player_id)
if GetPlayerTeam(player_id) == TEAM_BLUE then
Pickup( entid, player_id )
end
end
</pre>
Note that the way objects are created in lua is slightly confusing, so reading [http://www.lua.org/pil Programming in Lua] may be helpful.

== Global Events ==
These are functions that are called by the engine that do not belong inside any class. Simply declare them as globals in the lua namespace by doing something like the following:
<pre>
function precache()
--stuff here
end
</pre>

=== tick() ===
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.

=== precache() ===
This function is called when the map starts, before entities have been initialized. The main purpose of this is to precache all sound elements that

=== startup() ===
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.

=== player_spawn() ===
This function is called whenever a player spawns in this map.

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

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

=== flaginfo() ===

== info_ff_script entity ==
To create scripting for info_ff_script entities, simply extend the base info_ff_script class that is defined in base.lua and add functionality. Alternatively, you may extend the predefined classes [[#genericbackpack]] for respawning items or [[#baseflag]] for items the player may carry.

=== precache() ===
This function is called when the entity has started to spawn and needs to precache any models that this entity needs.

=== spawn() ===
This function is called when the entity has finished spawning so that the model for it can be set as well as initialize any variables for this script.

=== touch() ===
This function is called when this entity is touched by a player.

=== ownerdie() ===
This function is called when the player carrying this item (if it is attached to a player) dies.

=== materialize() ===
This function is called when this item has finished waiting to respawn and has respawned.

=== ondrop() ===
This function is called whenever the player dies or drops the item.

=== onloseitem() ===
This function is called whenever the player loses this item for any reason (drops it, or is captured).

=== onreturn() ===
This function is called when the item has been unattached to a player for the specified amount of time and it returns to its starting point.

=== dropitemcmd() ===
This function is called when the player that has this item presses the [[Command:dropitems|dropitems command]].

== info_ff_teamspawn ==
This entity is used to control where players spawn at. The engine will choose a spawn point where the player can spawn it and call the validspawn() function (see below). If it returns true then the player will spawn at this entity's location. Otherwise, the engine will attempt to spawn the player at the next spawn point. If no spawn points are valid, then it will pick a random one and spawn the player there.

=== validspawn() ===
This function is called whenever a player attempts to spawn at this location. Return true if the player can spawn here, otherwise return false.

== func_button ==

=== ondamage() ===
See [[#player_ondamage]] for parameter information. Additionally, if info_damage is set to 0 by the script, or the function returns false, the button will not be fired by this press. An example of allowing only spanners to hit a button:
<pre>
bob = func_button:new({})
function bob:ondamage()
ConsoleToAll(GetPlayerName(info_attacker).." shot button with a "..info_classname.." for "..info_damage.." damage")
if info_classname == "ff_weapon_spanner" then
PressButton(entname)
end
end
</pre>

=== allowed() ===
This function will be called whenever this button is attempted to be pressed. If it returns true, then the button will fire, otherwise it will not.

== trigger_ff_script and trigger_multiple ==
These entities are exactly the same. Most of these functions will also work with the other trigger_* entities.

=== allowed() ===
Called when the engine needs to know if the player in the first parameter of this function is allowed to trigger this entity. Return true from this function if the trigger is allowed, otherwise return false.

=== onfailtouch() ===
Called when allowed() returns false.

=== ontouch() ===
Called when a player starts touching this entity.

=== onendtouch() ===
Called when a player stops touching this entity.

=== ontrigger() ===
Called when this entity is triggered. Note that this takes into account the wait time of this trigger, whereas ontouch() does not.

[[Category:LUA]]

Main Page

2006-01-22T19:13:22Z

FryGuy: /* Stats System & Global Awards */

This is just a temp page. I'm trying to get a feel for the way these things are done. I'll flesh this out when I get back later, then create all the pages as blanks etc. - Def

=Contents=

==Gameplay==
*[[Classes]]
*[[Armour Types]]
*[[Weapons]]
*[[Grenades]]
*[[Buildables]]
*[[Status Effects]]
*[[Ammo Types]]
*[[Movement System]]
*[[Game Types]]

==Fortress Forever Commands==
*[[FF Commands]]

==Personal Scoring and Gameplay Awards==
*[[Personal Scoring]]
*[[Gameplay Awards]]

==Stats System & Global Awards==
*[[Stats System]]
*[[Global Awards]]
*[[Stats coding]]

==Accessibility==
*[[Hints]]
*[[Map Helpers]]
*[[Training System]]

==Bots==
*[[Bots]]

==GUI==
*[[Menu System]]
*[[HUD]]

==Mapping==
*[[Entity Set]]
*[[Interacting with Lua]]
*[[Lua Commands]]
*[[Map Templates]]

==Miscellaneous==
*[[Demo Features]]
*[[Substitute System]]
*[[Animation]]

Class Ability:Disguise

2006-01-22T17:52:30Z

FryGuy: /* Class Identification */

=Content=

The [[Class:Spy|Spy's]] special ability opens the disguise menu.

==Disguise Menu==
From the disguise menu, players can choose the team colour and class to disguise as.

On maps featuring two teams, there are two options: Enemy or Friendly. Choosing one of these options then opens the class menu where the player can complete their selection.

E.g. Enemy->Spy. Friendly->Scout. Enemy->HWGuy.

On maps featuring more than two teams, there are n colour options, where n is the number of teams. After choosing a team colour, the class disguise menu opens allowing the player to choose their complete disguise.

E.g. Blue->Soldier. Red->Scout. Green->Spy. Yellow->Sniper

On regular maps, spies should not be allowed to disguise as civilians. We could add this functionality in for non-regular maps where the civilian class is used for something and spies are also permitted (for example, a assassination map where the prez has a decoy). If maps feature class restrictions (e.g. no demos), then the spy disguise options should reflect those restrictions as disguising as a class that is disabled is basically useless. This isn't hugely important, but it should be added at some point.

==Friendly Indicators==
When a disguised allied spy is viewed by a teammate, a visual indicator should be displayed. This could simply be something like a team coloured "F" sprite being placed over the spy's head (so blue spies would have a blue F and so forth, regardless of the disguise currently employed). If a spy cumulatively receives 50 or more damage from a teammate, warning text and an audible "Ceasefire, I'm on your team!" sound effect should play to further reinforce the fact that the player is a teammate.

==Player Identification==
When placed under an enemy's crosshair, the spy's name should show up as one the team members found on the team the spy is masquerading as. The name should preferably never correspond to that of the person who's looking at the spy and trying to identify him unless no other option is available (i.e. the disguise team has one member, so no other options exist). The health value should always be positive, and the armour value sensible. E.g. a scout with 10 health will generally always have 0 armour, as the scout's armour depletes faster than his health. Believable armour values could be calculated by applying the [[Armour_Types|Armour]] absorption ratios relative to the class' remaining health values and associated armour type.

==Class Identification==
When spies are disguised, they should display the relevant weapon in the third person view. TFC's spy was inflexible, as they could only equip one weapon in third person mode, making them very easy to spot in many instances.

The spy possesses four weapon slots (1,2,3 and 4), so there's enough choice to assign each slot a corresponding weapons slot with the disguised class (excluding the demoman's detpack and the engineer's buildables, as those are special cases).

For example, when disguised as the soldier:

Actual weapon / Weapon shown in 3rd person
*Slot1: Knife / Crowbar
*Slot2: Tranq / Single-barrelled Shotgun
*Slot3: Double-barrelled Shotgun / Double-barrelled Shotgun
*Slot4: Nailgun / RPG

This allows the spy to blend in more easily. The only thing left to decide on is how we approach the first person visual effects. See the [[Talk:Class_Ability:Disguise|discussion]] page.

==Speed Toggle==
The player should be able to toggle between disguised speed and full speed using a bound key or a cvar. The HUD should indicate whether disguise speed or full speed is activated. Firing or losing disguise should obviously be a condition for the disguised speed to become reset to full speed regardless of the user's settings, as there is no advantage to running slowly when stripped of the disguise. If activated, the disguised speed should also be applied when disguised as a friendly class, as it is sometimes preferable to make the enemy think you're playing as another class. The disguised speed should obviously only apply when disguised as classes slower than the spy, as disguising as a scout shouldn't make you run faster than default.

Talk:Class Ability:Disguise

2006-01-22T17:51:34Z

FryGuy: /* Considerations */

=Stuff=
The only real thing left to resolve is the viewmodel effects when disguised as another class. A few ideas:

==Ideas==
*A: ETF style translucent weapons. The weapon actually equipped shimmers and changes into the weapon people see you carrying in 3rd person mode.
*B: Display the corresponding viewmodel as held by the class you're disguised as. Forget the spy's weapons.
*C: Display the spy's viewmodel. Forget the disguise weapons.
*D: Same as B or C, but instead of just forgetting the spy or disguise weapon, use some kind of HUD element to indicate which weapon you're holding.

==Advantages / Disadvantages of each:==
*A: Cool, good blend of both worlds / Harder to implement. Probably requires more resources to do (both time, effort and computer resources [lower framerate etc]). Requires weapon models to be activated to be of any use.
*B: It's easy to remember which weapon you've got selected as spy anyway, pretty easy solution / Requires weapon models to be activated, will probably require more memory as you will potentially be displaying more viewmodels.
*C: Simple, no hassle, no extra resources required. Newbies probably won't care about the intracacies of holding the correct weapon anyway. The veterans can learn the combinations anyway / Not as easy as it could be. No wow factor.
*D: All the advantages of either B or C, but with the extra functionality if people need it. Doesn't require viewmodels to be on. Could be turned off if a player finds it annoying / No wow factor.

==Considerations==
The main thing I'm (Defrag) wondering about is memory. If you play as a certain class, then does the game cache only the viewmodels & viewmodel textures for the class? If so, then playing as spy (with solutions A, B or D) would potentially cause all of the class viewmodels to be cached because as spy you can potentially disguise as any class and hold any weapon.

If all viewmodels are cached regardless, then it's not an issue. However, if models are selectively cached, then it could be a problem. Could we simply load the non-cached files on the fly when the player starts to disguise? (e.g. if they start to disguise as soldier, then ensure the RPG, Crowbar and Single Shotgun are already in memory, and if not, load them). I need a techie dude to tell me how much of a consideration this is and, indeed, whether I should be concerned about it at all.

I'm leaning towards D at the moment. The only downside with that approach is we'd need icons for every weapon, and the icons to be easily distinguishable.

Thoughts?

---
Perhaps having a spinning w_model in a hud element?

Map Template:BaseTeamplay

2005-12-27T11:44:33Z

FryGuy: /* Backpacks */

=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): Validator for blue respawn door
*red_respawndoor (trigger_multiple): Validator for red respawn door

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

Map Template:BaseTeamplay

2005-12-27T11:44:09Z

FryGuy:

=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 red team
*bluearmorkit (info_ff_script): see above, for red team
*blueammobackpack (info_ff_script): see above, for red team
*bluegrenbackpack (info_ff_script): see above, for red 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): Validator for blue respawn door
*red_respawndoor (trigger_multiple): Validator for red respawn door

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

Map Template:CTF

2005-12-27T11:36:46Z

FryGuy: /* Entities */

=Introduction=
This is your standard run-of-the-mill Capture the Flag map. All of the [[MapTemplate:BaseTeamplay|Basic Teamplay]] entities are supported.

=Entities=
*redflag (info_ff_script): Location for the red flag
*blueflag (info_ff_script): Location for the blue flag
*redcap (trigger_ff_script): Location for the red capture point (to capture the blue flag)
*bluecap (trigger_ff_script): Location for the blue capture point (to capture the red flag)

=Lua Script=
<pre>POINTS_PER_CAPTURE = 10;
FLAG_RETURN_TIME = 15

IncludeScript("base_ctf");</pre>

Map Template:CTF

2005-12-04T23:26:57Z

FryGuy:

=Introduction=
This is your standard run-of-the-mill Capture the Flag map. All of the [[MapTemplate:BaseTeamplay|Basic Teamplay]] entities are supported.

=Entities=
*redflag (info_ff_script): Location for the red flag
*blueflag (info_ff_script): Location for the blue flag
*redcap (func_ff_script): Location for the red capture point (to capture the blue flag)
*bluecap (func_ff_script): Location for the blue capture point (to capture the red flag)

=Lua Script=
<pre>POINTS_PER_CAPTURE = 10;
FLAG_RETURN_TIME = 15

IncludeScript("base_ctf");</pre>

Map Template:CTF

2005-12-04T23:20:36Z

FryGuy:

=Introduction=
This is your standard run-of-the-mill Capture the Flag map. All of the [[MapTemplate:BaseTeamplay|Basic Teamplay]] entities are supported.

=Entities=
[b]redflag[/b] (info_ff_script): Location for the red flag
[b]blueflag[/b] (info_ff_script): Location for the blue flag
[b]redcap[/b] (func_ff_script): Location for the red capture point (to capture the blue flag)
[b]bluecap[/b] (func_ff_script): Location for the blue capture point (to capture the red flag)

=Lua Script=
[code]POINTS_PER_CAPTURE = 10;
FLAG_RETURN_TIME = 15

IncludeScript("base_ctf");[/code]

Main Page

2005-12-04T22:50:12Z

FryGuy: /* Mapping */

This is just a temp page. I'm trying to get a feel for the way these things are done. I'll flesh this out when I get back later, then create all the pages as blanks etc. - Def

=Contents=

==Gameplay==
*[[Classes]]
*[[Armour Types]]
*[[Weapons]]
*[[Grenades]]
*[[Buildables]]
*[[Status Effects]]
*[[Ammo Types]]
*[[Movement System]]
*[[Game Types]]

==Fortress Forever Commands==
*[[FF Commands]]

==Personal Scoring and Gameplay Awards==
*[[Personal Scoring]]
*[[Gameplay Awards]]

==Stats System & Global Awards==
*[[Stats System]]
*[[Global Awards]]

==Accessibility==
*[[Hints]]
*[[Map Helpers]]
*[[Training System]]

==Bots==
*[[Bots]]

==GUI==
*[[Menu System]]
*[[HUD]]

==Mapping==
*[[Entity Set]]
*[[Interacting with Lua]]
*[[Lua Commands]]
*[[Map Templates]]

==Miscellaneous==
*[[Demo Features]]
*[[Substitute System]]

Lua:Interaction

2005-10-20T08:10:11Z

FryGuy:

Stub

Main Page

2005-10-20T08:09:50Z

FryGuy:

This is just a temp page. I'm trying to get a feel for the way these things are done. I'll flesh this out when I get back later, then create all the pages as blanks etc. - Def

=Contents=

==Gameplay==
*[[Classes]]
*[[Armour Types]]
*[[Weapons]]
*[[Grenades]]
*[[Buildables]]
*[[Status Effects]]
*[[Ammo Types]]
*[[Movement System]]
*[[Game Types]]

==Fortress Forever Commands==
*[[FF Commands]]

==Personal Scoring and Gameplay Awards==
*[[Personal Scoring]]
*[[Gameplay Awards]]

==Stats System & Global Awards==
*[[Stats System]]
*[[Global Awards]]

==Accessibility==
*[[Hints]]
*[[Map Helpers]]
*[[Training System]]

==Bots==
*[[Bots]]

==GUI==
*[[Menu System]]
*[[HUD]]

==Mapping==
*[[Entity Set]]
*[[Interacting with Lua]]
*[[Lua Commands]]

==Miscellaneous==
*[[Demo Features]]
*[[Substitute System]]

Lua Commands

2005-10-20T08:07:08Z

FryGuy:

=Introduction=
Words words words words words words words words words words words words words

=Communicating with player=
*BroadCastMessage
*BroadCastMessageToPlayer
*BroadCastSound
*BroadCastSoundToPlayer
*ConsoleToAll

=Interfacing with map entities=
*SpawnEntityAtPlayer
*FireOutput

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

=Manipulating Players=
*AddAmmo
*RemoveAmmo
*AddArmor
*AddHealth
*AddFrags
*MarkRadioTag

=Manipulating Teams=
*AddTeamScore
*SetTeamAllies
*SetTeamClassLimit

=Item/Flag related=
*PlayerHasItem
*RemoveItem
*ReturnItem

=Misc=
*IncludeScript
*Random / rand
*RespawnAllPlayers

Lua Commands

2005-10-20T08:05:35Z

FryGuy:

**Communicating with player:
*BroadCastMessage
*BroadCastMessageToPlayer
*BroadCastSound
*BroadCastSoundToPlayer
*ConsoleToAll

**Interfacing with map entities
*SpawnEntityAtPlayer
*FireOutput

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

**Manipulating Players
*AddAmmo
*RemoveAmmo
*AddArmor
*AddHealth
*AddFrags
*MarkRadioTag

**Manipulating Teams
*AddTeamScore
*SetTeamAllies
*SetTeamClassLimit

**Item/Flag related
*PlayerHasItem
*RemoveItem
*ReturnItem

**Misc
*IncludeScript
*Random / rand
*RespawnAllPlayers

Main Page

2005-10-20T08:00:11Z

FryGuy:

This is just a temp page. I'm trying to get a feel for the way these things are done. I'll flesh this out when I get back later, then create all the pages as blanks etc. - Def

=Contents=

==Gameplay==
*[[Classes]]
*[[Armour Types]]
*[[Weapons]]
*[[Grenades]]
*[[Buildables]]
*[[Status Effects]]
*[[Ammo Types]]
*[[Movement System]]
*[[Game Types]]

==Fortress Forever Commands==
*[[FF Commands]]

==Personal Scoring and Gameplay Awards==
*[[Personal Scoring]]
*[[Gameplay Awards]]
==Stats System & Global Awards==
*[[Stats System]]
*[[Global Awards]]

==Accessibility==
*[[Hints]]
*[[Map Helpers]]
*[[Training System]]

==Bots==
*[[Bots]]

==GUI==
*[[Menu System]]
*[[HUD]]

==Miscellaneous==
*[[Demo Features]]
*[[Substitute System]]

==Mapping==
*[[Lua Commands]]