Difference between revisions of "Category:Utility functions"

From Fortress Forever Wiki
Jump to navigationJump to search
m
m
Line 50: Line 50:
 
| [[Lua:SetConvar|SetConvar]]( player, var, value ) || sets a players console variable to set value
 
| [[Lua:SetConvar|SetConvar]]( player, var, value ) || sets a players console variable to set value
 
|-
 
|-
−
| [[Lua:ApplyToAll|ApplyToAll]]( effect ) ||  
+
| [[Lua:ApplyToAll|ApplyToAll]]( effect ) || pass this a list of [[Lua:Flags#AT | AT flags]] to apply global effects to the server.
 
|-
 
|-
−
| [[Lua:ApplyToTeam|ApplyToTeam]]( effect, team ) ||  
+
| [[Lua:ApplyToTeam|ApplyToTeam]]( effect, team ) || pass this a team id and a list of [[Lua:Flags#AT | AT flags]] to apply effects to players on a team.
 
|-
 
|-
−
| [[Lua:ApplyToPlayer|ApplyToPlayer]]( effect, player ) ||  
+
| [[Lua:ApplyToPlayer|ApplyToPlayer]]( effect, player ) || pass this a player id and a list of [[Lua:Flags#AT | AT flags]] to apply effects to a player.
 
|-
 
|-
 
| [[Lua:HasGameStarted|HasGameStarted]]( ) || Returns false if the map is in prematch mode.
 
| [[Lua:HasGameStarted|HasGameStarted]]( ) || Returns false if the map is in prematch mode.
Line 74: Line 74:
 
| [[Lua:SetTeamClassLimit|SetTeamClassLimit]]( team, class, limit ) ||  
 
| [[Lua:SetTeamClassLimit|SetTeamClassLimit]]( team, class, limit ) ||  
 
|-
 
|-
−
| [[Lua:SetTeamName|SetTeamName]]( team, name ) ||  
+
| [[Lua:SetTeamName|SetTeamName]]( team, name ) || Set a custom name for a team: appears on the scoreboard and team selection screen.
 
|-
 
|-
 
| [[Lua:SetTeamPlayerLimit|SetTeamPlayerLimit]]( team, limit ) ||
 
| [[Lua:SetTeamPlayerLimit|SetTeamPlayerLimit]]( team, limit ) ||
 
|}
 
|}
 
{{Infobox manual/Footer}}
 
{{Infobox manual/Footer}}

Revision as of 11:12, 5 May 2010


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

These global functions are useful for getting your scripts working.

General Technical Functions Description
ConsoleToAll( message ) sends a message to server console. Inaccurately named--players will not see this.
PrecacheModel( modelfile ) loads a given model into memory for use later.
PrecacheSound( soundfile ) as above.
PrintBool , &FFLib::PrintBool
RandomFloat( min, max ) generates a random float.
RandomInt( min, max ) generates a random integer
RemoveEntity( ent_id ) removes entity.
Player information
GetPacketloss( playerentity ) gets a player's packet loss. Woo?
GetPing( playerentity )
GetSteamID( playerentity )
Server Info
GetServerTime()
AreTeamsAllied( team1, team2 ) Returns true if they are.
NumPlayers() gets the number of players.
Server Effects
SetGameDescription( name ) Changes what appears in the game column of the server browser (it is appended to "FF ")

For use in startup().

RespawnAllPlayers( ) Respawns everyone immediately.
KillAndRespawnAllPlayers() obvious!
GoToIntermission( ) Sends all players to the info_intermission entity and shows them the scoreboard. Then, the map ends.
ResetMap() resets map.
SetConvar( player, var, value ) sets a players console variable to set value
ApplyToAll( effect ) pass this a list of AT flags to apply global effects to the server.
ApplyToTeam( effect, team ) pass this a team id and a list of AT flags to apply effects to players on a team.
ApplyToPlayer( effect, player ) pass this a player id and a list of AT flags to apply effects to a player.
HasGameStarted( ) Returns false if the map is in prematch mode.
GetConvar( cvar ) checks the value of a console variable (cvar)
Game Rules
SetGlobalRespawnDelay( time ) enforces a respawn delay.
SetPlayerLimit( team , # ) used to set player limit per team.
SetPlayerLimits( #, # )
SmartClassLimits( team, #scout, #sniper, #soldier, #demoman, #medic, #hwguy, #pyro, #spy, #engineer, #civilian ) sets class limits for the entire team.
SetTeamAllies( team , bits ) used to ally one team to another.
SetTeamClassLimit( team, class, limit )
SetTeamName( team, name ) Set a custom name for a team: appears on the scoreboard and team selection screen.
SetTeamPlayerLimit( team, limit )

Pages in category "Utility functions"

The following 7 pages are in this category, out of 7 total.

L

Retrieved from "https://www.fortress-forever.com/wiki/index.php?title=Category:Utility_functions&oldid=9524"