Difference between revisions of "Lua:Flags"

From Fortress Forever Wiki
Jump to navigationJump to search
Line 143: Line 143:
  
 
player:AddEffect( EF.kSpeedlua1, EFFECT_DURATION, ICON_DURATION, SPEED_MULTIPLIER )
 
player:AddEffect( EF.kSpeedlua1, EFFECT_DURATION, ICON_DURATION, SPEED_MULTIPLIER )
 +
</pre></code>
 +
}}
 +
 +
{{Lua:FlagType
 +
|prefix=AT
 +
|usage=Returns a specific "apply to" ID; Applies various commands to players, or to the entire server. Use with [[ApplyToAll]](ApplyToFlags), [[ApplyToTeam]](team, ApplyToFlags), or [[ApplyToPlayer]](player, ApplyToFlags) (not all flags are suitable for all functions).
 +
|flags=
 +
{{Lua:Flag|AT.kKillPlayers|}}
 +
{{Lua:Flag|AT.kRespawnPlayers|}}
 +
{{Lua:Flag|AT.kDropItems|}}
 +
{{Lua:Flag|AT.kForceDropItems|}}
 +
{{Lua:Flag|AT.kThrowItems|}}
 +
{{Lua:Flag|AT.kForceThrowItems|}}
 +
{{Lua:Flag|AT.kReturnCarriedItems|}}
 +
{{Lua:Flag|AT.kReturnDroppedItems|}}
 +
{{Lua:Flag|AT.kRemoveRagdolls|}}
 +
{{Lua:Flag|AT.kRemovePacks|}}
 +
{{Lua:Flag|AT.kRemoveProjectiles|}}
 +
{{Lua:Flag|AT.kRemoveBuildables|}}
 +
{{Lua:Flag|AT.kRemoveDecals|}}
 +
{{Lua:Flag|AT.kEndMap|}}
 +
{{Lua:Flag|AT.kReloadClips|}}
 +
{{Lua:Flag|AT.kAllowRespawn|}}
 +
{{Lua:Flag|AT.kDisallowRespawn|}}
 +
 +
{{Lua:Flag|AT.kChangeClassScout|}} 
 +
{{Lua:Flag|AT.kChangeClassSniper|}}
 +
{{Lua:Flag|AT.kChangeClassSoldier|}}
 +
{{Lua:Flag|AT.kChangeClassDemoman|}}
 +
{{Lua:Flag|AT.kChangeClassMedic|}} 
 +
{{Lua:Flag|AT.kChangeClassHWGuy|}}
 +
{{Lua:Flag|AT.kChangeClassPyro|}} 
 +
{{Lua:Flag|AT.kChangeClassSpy|}}
 +
{{Lua:Flag|AT.kChangeClassEngineer|}}
 +
{{Lua:Flag|AT.kChangeClassCivilian|}}
 +
{{Lua:Flag|AT.kChangeClassRandom|}}
 +
 +
{{Lua:Flag|AT.kChangeTeamBlue|}}
 +
{{Lua:Flag|AT.kChangeTeamRed|}}
 +
{{Lua:Flag|AT.kChangeTeamYellow|}}
 +
{{Lua:Flag|AT.kChangeTeamGreen|}}
 +
{{Lua:Flag|AT.kChangeTeamSpectator|}}
 +
 +
{{Lua:Flag|AT.kStopPrimedGrens|}}
 +
 +
|example=
 +
<code><pre>
 +
ApplyToAll({ AT.kRemovePacks, AT.kRemoveProjectiles, AT.kRespawnPlayers, AT.kRemoveBuildables, AT.kRemoveRagdolls, AT.kStopPrimedGrens, AT.kReloadClips })
 
</pre></code>
 
</pre></code>
 
}}
 
}}
  
 
[[Category:Lua]]
 
[[Category:Lua]]

Revision as of 20:45, 11 May 2009

Team

Returns a specific team's ID

Flag Description
Team.kUnassigned The Unassigned team consists of players that have not picked a team)
Team.kSpectator Spectators
Team.kRed The Red team
Team.kBlue The Blue team
Team.kYellow The Yellow team
Team.kGreen The Green team

Example

local player = CastToPlayer( touch_entity ) 
if player:GetTeamId() == Team.kRed then
  ...
end

Grenade

Returns a specific grenade's ID

Flag Description
Grenade.kNormal Frag grenade (All classes except Scout and Civilian)
Grenade.kCaltrop Caltrop grenades are no longer in the game
Grenade.kNail Nail Grenade (Soldier)
Grenade.kMirv Mirv grenade (HWGuy and Demoman)
Grenade.kMirvlet The four mini-grenades that come out of the Mirv grenade (HWGuy and Demoman)
Grenade.kConc Concussion grenade (Scout and Medic)
Grenade.kNapalm Napalm grenade (Pyro)
Grenade.kGas Gas grenade (Spy)
Grenade.kEmp EMP grenade (Engineer)

Example

local grenade = CastToGrenade( explode_entity ) 
if grenade:Type() == Grenade.kNormal then
  ...
end

Damage

Returns a specific damage type's ID; predominately used to detect fall damage

Flag Description
Damage.kGeneric Generic damage
Damage.kCrush Crushing damage (as in by an elevator or door)
Damage.kBullet Bullet damage
Damage.kSlash Unknown
Damage.kBurn Burn damage (maybe by pyro, maybe by trigger_hurt)
Damage.kVehicle Vehicle damage
Damage.kFall Fall damage
Damage.kBlast Blast damage
Damage.kClub Unknown
Damage.kShock Shock damage
Damage.kSonic Unknown
Damage.kEnergyBeam Unknown
Damage.kPreventPhysForce Unknown
Damage.kNeverGib Unknown
Damage.kAlwaysGib Unknown
Damage.kDrown Drowning damage
Damage.kTimeBased Unknown
Damage.kParalyze Unknown
Damage.kNerveGas Unknown
Damage.kPoison Unknown
Damage.kRadiation Unknown
Damage.kDrownRecover Unknown
Damage.kAcid Unknown
Damage.kSlowBurn Unknown
Damage.kRemoveNoRagdoll Unknown
Damage.kPhysgun Unknown; likely not applicable
Damage.kPlasma Unknown
Damage.kAirboat Likely not applicable
Damage.kDissolve Can be dealt by a trigger_hurt
Damage.kBlastSurface Unknown
Damage.kDirect Unknown
Damage.kBuckshot Unknown
Damage.kGibCorpse Unknown
Damage.kShownHud Unknown
Damage.kNoPhysForce Unknown

Example

local damagetype = damageinfo:GetDamageType()
if damagetype == Damage.kFall then
  ...
end

Ammo

Returns a specific ammo type's ID; predominately used to add or remove ammo from a player

Flag Description
Ammo.kShells Shell ammo type
Ammo.kCells Cell ammo type
Ammo.kNails Nail ammo type
Ammo.kRockets Rocket ammo type
Ammo.kDetpack Detpack ammo type
Ammo.kManCannon Jump Pad ammo type
Ammo.kGren1 Primary grenade ammo type
Ammo.kGren2 Secondary grenade ammo type
Ammo.kInvalid Unknown

Example

local player = CastToPlayer( player_entity )

player:AddAmmo( Ammo.kNails, 400 )
player:AddAmmo( Ammo.kShells, 400 )
player:AddAmmo( Ammo.kRockets, 400 )
player:AddAmmo( Ammo.kCells, 400 )
player:AddAmmo( Ammo.kDetpack, 1 )
player:AddAmmo( Ammo.kManCannon, 1 )

EF

Returns a specific status effect's ID

Flag Description
EF.kOnfire On Fire status effect
EF.kConc Concussed status effect
EF.kGas Hallucinati ons status effect
EF.kInfect Infected status effect
EF.kRadiotag Transmitting status effect
EF.kHeadshot Headshot status effect
EF.kLegshot Crippled status effect
EF.kTranq Tranquilized status effect
EF.kCaltrop Defunct
EF.kACSpinup Assault Cannon spinup status effect
EF.kSniperrifle Unknown
EF.kSpeedlua1 Custom speed effect 1
EF.kSpeedlua2 Custom speed effect 2
EF.kSpeedlua3 Custom speed effect 3
... ...
EF.kSpeedlua10 Custom speed effect 10

Example

local player = CastToPlayer( player_entity )

SPEED_MULTIPLIER = 2.0
EFFECT_DURATION = -1 -- Infinite duration
ICON_DURATION = 0

player:AddEffect( EF.kSpeedlua1, EFFECT_DURATION, ICON_DURATION, SPEED_MULTIPLIER )

AT

Returns a specific "apply to" ID; Applies various commands to players, or to the entire server. Use with ApplyToAll(ApplyToFlags), ApplyToTeam(team, ApplyToFlags), or ApplyToPlayer(player, ApplyToFlags) (not all flags are suitable for all functions).

Flag Description
AT.kKillPlayers
AT.kRespawnPlayers
AT.kDropItems
AT.kForceDropItems
AT.kThrowItems
AT.kForceThrowItems
AT.kReturnCarriedItems
AT.kReturnDroppedItems
AT.kRemoveRagdolls
AT.kRemovePacks
AT.kRemoveProjectiles
AT.kRemoveBuildables
AT.kRemoveDecals
AT.kEndMap
AT.kReloadClips
AT.kAllowRespawn
AT.kDisallowRespawn
AT.kChangeClassScout
AT.kChangeClassSniper
AT.kChangeClassSoldier
AT.kChangeClassDemoman
AT.kChangeClassMedic
AT.kChangeClassHWGuy
AT.kChangeClassPyro
AT.kChangeClassSpy
AT.kChangeClassEngineer
AT.kChangeClassCivilian
AT.kChangeClassRandom
AT.kChangeTeamBlue
AT.kChangeTeamRed
AT.kChangeTeamYellow
AT.kChangeTeamGreen
AT.kChangeTeamSpectator
AT.kStopPrimedGrens

Example

ApplyToAll({ AT.kRemovePacks, AT.kRemoveProjectiles, AT.kRespawnPlayers, AT.kRemoveBuildables, AT.kRemoveRagdolls, AT.kStopPrimedGrens, AT.kReloadClips })