Skip to content

API: Gamemode Properties

Robert A Fraser edited this page Sep 24, 2020 · 1 revision

Basic Properties

Variable Default Value Purpose
GM.Name N/A The nice name of the gamemode.
GM.Author N/A Author of the gamemode.
GM.HelpText N/A A multi-line string with a brief explanation of how to play the gamemode.

Round Properties

Variable Default Value Purpose
GM.TeamBased false Is the gamemode team based, or is it FFA?
GM.Elimination false Should players stay dead?
GM.WinBySurvival false If this is an elimination gamemode, does the last surviving player/team automatically win?
GM.RoundNumber 5 How many rounds?
GM.RoundTime 90 How long should each round go for?
GM.RoundCoolDown 5 How long between each round?
GM.RoundType 'default' What system should be used for game logic? Further explanation below this table.
GM.GameTime 600 If not using rounds, how long should the game go for?
GM.EndOnTimeOut false For certain game types, should this cut off mid-round?
GM.TeamSurvival false Is this a Hunter vs Hunted gametype?
GM.SurvivorTeam TEAM_BLUE Survivor team. Only for TeamSurvival gamemodes.
GM.HunterTeam TEAM_RED Hunter team. Only for TeamSurvival gamemodes.

Spawning Properties

Variable Default Value Purpose
GM.DeathLingerTime 3 How long should players linger on their corpse before becoming ghosts?
GM.RespawnTime 2 How long do players need to wait before respawning? Only applies if GM.Elimination is false.
GM.AutoRespawn true Should players automatically respawn? Only applies if GM.Elimination is false.
GM.DeathSounds true Should voicelines play on player death?
GM.KillValue 1 How many points should be awarded for a kill? Possibly broken.
GM.SpawnProtection false Should players have brief spawn protection?
GM.CanSuicide true Should players be able to leave this world behind at will? :(

Other Properties

Variable Default Value Purpose
GM.ThirdPersonEnabled false Is thirdperson allowed?