From ac20f70b98535e28a7152e2a06a450d8034aeebb Mon Sep 17 00:00:00 2001 From: ChocoTaco Date: Fri, 13 Sep 2019 15:34:03 -0400 Subject: [PATCH] Annotations update --- Classic/scripts/autoexec/AntiCloak.cs | 10 ++- Classic/scripts/autoexec/AntiTurret.cs | 4 ++ Classic/scripts/autoexec/GetRandomMaps.cs | 67 +++++++++++--------- Classic/scripts/autoexec/NoBaseRapeNotify.cs | 22 ++++--- Classic/scripts/autoexec/ObserverCooldown.cs | 6 +- Classic/scripts/autoexec/TacoOverrides.cs | 4 +- Classic/scripts/autoexec/TimedServerReset.cs | 12 ++-- Classic/scripts/autoexec/VoteOverTime.cs | 6 +- Classic/scripts/autoexec/VoteSound.cs | 12 ++-- 9 files changed, 87 insertions(+), 56 deletions(-) diff --git a/Classic/scripts/autoexec/AntiCloak.cs b/Classic/scripts/autoexec/AntiCloak.cs index 4ae1e72..b2979bc 100644 --- a/Classic/scripts/autoexec/AntiCloak.cs +++ b/Classic/scripts/autoexec/AntiCloak.cs @@ -1,7 +1,13 @@ -// Amount of players needed on server for CloakPack to be banned/unbanned +// AntiCloak Script // +// Amount of players needed on server for CloakPack to be banned/unbanned +// This is useful for low numbers +// +// Enable/Disable the feature // $Host::AntiCloakEnable = 1; +// When you would like for it to deactivate // $Host::AntiCloakPlayerCount = 6; +// // Called in GetCounts.cs function ActivateAntiCloak( %game ) @@ -54,7 +60,7 @@ function ActivateAntiCloak( %game ) } } -//So if the player is able to get a cloakpack, he cant use it +// So if the player is able to get a cloakpack, he cant use it package DisableCloakPack { diff --git a/Classic/scripts/autoexec/AntiTurret.cs b/Classic/scripts/autoexec/AntiTurret.cs index 63fae63..e26c8d7 100644 --- a/Classic/scripts/autoexec/AntiTurret.cs +++ b/Classic/scripts/autoexec/AntiTurret.cs @@ -1,3 +1,7 @@ +// AntiTurret Script +// +// Turrets are disabled until threshold is reached +// // Amount of players on a team to enable turrets // $Host::EnableTurretPlayerCount = 10; // diff --git a/Classic/scripts/autoexec/GetRandomMaps.cs b/Classic/scripts/autoexec/GetRandomMaps.cs index 82071d5..ebe2787 100644 --- a/Classic/scripts/autoexec/GetRandomMaps.cs +++ b/Classic/scripts/autoexec/GetRandomMaps.cs @@ -1,67 +1,72 @@ -//Random Set Next Mission maps -//Runs for SetNextMisssion (Random) and Map Repetition Checker +// Get Random Maps Script +// +// Used by the Set Next Mission feature +// +// Random Set Next Mission maps +// Runs for SetNextMisssion (Random) and Map Repetition Checker +// Randomizes the maps available in the admin menu // -//This file is present +// This file is present $GetRandomMapsLoaded = true; -//Map pool +// Map pool // -//CTF +// CTF // -//1-5 +// 1-5 $RandomMapPick1 = "SmallCrossing"; $RandomMapPick2 = "OasisIntensity"; $RandomMapPick3 = "Blink"; $RandomMapPick4 = "SmallTimeCTF"; $RandomMapPick5 = "ArenaDome"; -//6-10 +// 6-10 $RandomMapPick6 = "HighOctane"; $RandomMapPick7 = "S5_Damnation"; $RandomMapPick8 = "TWL_Feign"; $RandomMapPick9 = "TWL2_Skylight"; $RandomMapPick10 = "Prismatic"; -//11-15 +// 11-15 $RandomMapPick11 = "Dire"; $RandomMapPick12 = "TWL2_JaggedClaw"; $RandomMapPick13 = "TWL2_Hildebrand"; $RandomMapPick14 = "TWL_WilderZone"; $RandomMapPick15 = "TWL_Stonehenge"; -//16-20 +// 16-20 $RandomMapPick16 = "TWL2_Ocular"; $RandomMapPick17 = "S8_Opus"; $RandomMapPick18 = "Mirage"; $RandomMapPick19 = "DangerousCrossing_nef"; $RandomMapPick20 = "S5_Massive"; -//21-25 +// 21-25 $RandomMapPick21 = "TheFray"; $RandomMapPick22 = "RoundTheMountain"; $RandomMapPick23 = "S5_Mordacity"; $RandomMapPick24 = "TWL2_CanyonCrusadeDeluxe"; $RandomMapPick25 = "Signal"; -//26-30 +// 26-30 $RandomMapPick26 = "S8_Cardiac"; $RandomMapPick27 = "CirclesEdge"; $RandomMapPick28 = "S5_Icedance"; $RandomMapPick29 = "Bulwark"; $RandomMapPick30 = "Discord"; -//31-35 +// 31-35 $RandomMapPick31 = "MoonDance"; $RandomMapPick32 = "Rollercoaster_nef"; $RandomMapPick33 = "Logans_Run"; $RandomMapPick34 = "TWL_BeachBlitz"; $RandomMapPick35 = "TWL2_FrozenGlory"; -//36-40 +// 36-40 $RandomMapPick36 = "CircleofStones"; $RandomMapPick37 = "TitanV"; $RandomMapPick38 = "TWL_Katabatic"; $RandomMapPick39 = "TWL2_Magnum"; $RandomMapPick40 = "Fenix"; // -//LakRabbit +// LakRabbit // -//1-3 +// 1-3 $LakRandomMapPick1 = "VaubanLak"; $LakRandomMapPick2 = "MiniSunDried"; $LakRandomMapPick3 = "TitaniaLak"; -//4-6 +// 4-6 $LakRandomMapPick4 = "DesertofDeathLak"; $LakRandomMapPick5 = "Sundance"; $LakRandomMapPick6 = "SunDriedLak"; -//7-9 +// 7-9 $LakRandomMapPick7 = "SkinnyDipLak"; $LakRandomMapPick8 = "LushLak"; $LakRandomMapPick9 = "InfernusLak"; -//10-12 +// 10-12 $LakRandomMapPick10 = "Arrakis"; $LakRandomMapPick11 = "BoxLak"; $LakRandomMapPick12 = "TreasureIslandLak"; -//13-15 +// 13-15 $LakRandomMapPick13 = "Raindance_nefLak"; $LakRandomMapPick14 = "SaddiesHill"; $LakRandomMapPick15 = "TWL_BeachBlitzLak"; -//16-18 +// 16-18 $LakRandomMapPick16 = "PhasmaDustLak"; $LakRandomMapPick17 = "TibbawLak"; $LakRandomMapPick18 = "HavenLak"; -//19-21 +// 19-21 $LakRandomMapPick19 = "Crater71Lak"; $LakRandomMapPick20 = "SolsDescentLak"; $LakRandomMapPick21 = "FrozenFuryLak"; -//22-24 +// 22-24 $LakRandomMapPick22 = "CankerLak"; $LakRandomMapPick23 = "S8_GeothermalLak"; $LakRandomMapPick24 = "DustRunLak"; // -//LCTF +// LCTF // -//1-5 +// 1-5 $LCTFRandomMapPick1 = "BastardForgeLT"; $LCTFRandomMapPick2 = "FirestormLT"; $LCTFRandomMapPick3 = "DangerousCrossingLT"; $LCTFRandomMapPick4 = "S5_DamnationLT"; $LCTFRandomMapPick5 = "TenebrousCTF"; -//6-10 +// 6-10 $LCTFRandomMapPick6 = "SmallCrossingLT"; $LCTFRandomMapPick7 = "CirclesEdgeLT"; $LCTFRandomMapPick8 = "TheFray"; $LCTFRandomMapPick9 = "SignalLT"; $LCTFRandomMapPick10 = "StarFallLT"; -//11-15 +// 11-15 $LCTFRandomMapPick11 = "DireLT"; $LCTFRandomMapPick12 = "S5_Icedance"; $LCTFRandomMapPick13 = "TWL2_HildebrandLT"; $LCTFRandomMapPick14 = "TWL2_CanyonCrusadeDeluxeLT"; $LCTFRandomMapPick15 = "TWL2_FrozenHopeLT"; -//16-20 +// 16-20 $LCTFRandomMapPick16 = "RoundTheMountainLT"; $LCTFRandomMapPick17 = "Blink"; $LCTFRandomMapPick18 = "TWL2_SkylightLT"; $LCTFRandomMapPick19 = "TWL_BeachBlitzLT"; $LCTFRandomMapPick20 = "S5_MassiveLT"; -//21-25 +// 21-25 $LCTFRandomMapPick21 = "S5_Mimicry"; $LCTFRandomMapPick22 = "S5_SilenusLT"; $LCTFRandomMapPick23 = "S5_Mordacity"; $LCTFRandomMapPick24 = "S5_Woodymyrk"; $LCTFRandomMapPick25 = "S8_Cardiac"; -//26-30 +// 26-30 $LCTFRandomMapPick26 = "S8_Opus"; $LCTFRandomMapPick27 = "TWL2_Celerity"; $LCTFRandomMapPick28 = "TWL2_Crevice"; $LCTFRandomMapPick29 = "S5_HawkingHeat"; $LCTFRandomMapPick30 = "TWL2_MidnightMayhemDeluxe"; -//31-35 +// 31-35 $LCTFRandomMapPick31 = "Discord"; $LCTFRandomMapPick32 = "Bulwark"; $LCTFRandomMapPick33 = "ArenaDome"; $LCTFRandomMapPick34 = "SmallTimeLT"; $LCTFRandomMapPick35 = "RaindanceLT"; -//36-40 +// 36-40 $LCTFRandomMapPick36 = "TWL_OsIris"; $LCTFRandomMapPick37 = "TWL_Damnation"; $LCTFRandomMapPick38 = "Headstone"; $LCTFRandomMapPick39 = "BeggarsRunLT"; $LCTFRandomMapPick40 = "Berlard"; diff --git a/Classic/scripts/autoexec/NoBaseRapeNotify.cs b/Classic/scripts/autoexec/NoBaseRapeNotify.cs index 215478a..6a5e1c8 100644 --- a/Classic/scripts/autoexec/NoBaseRapeNotify.cs +++ b/Classic/scripts/autoexec/NoBaseRapeNotify.cs @@ -1,8 +1,12 @@ -//Enable or Disable -//$Host::EnableNoBaseRapeNotify = 1; +// No Base Rape Notify Script +// +// Notifys clients if NoBase rape is on or off. +// +// Enable or Disable +// $Host::EnableNoBaseRapeNotify = 1; // -//Notifys the user if NoBase rape is on or off. +// Called in GetTeamCounts.cs function NBRStatusNotify( %game ) { if( $CurrentMissionType $= "CTF" && $Host::EnableNoBaseRapeNotify && !$Host::TournamentMode && $Host::EvoNoBaseRapeEnabled ) @@ -28,16 +32,16 @@ function NBRStatusNotify( %game ) } } -//This function is at DefaultGame::gameOver(%game) CTFGame.cs -//Resets the client NotifyCount when the mission ends +// This function is at DefaultGame::gameOver(%game) CTFGame.cs +// Resets the client NotifyCount when the mission ends function ResetNBRNotify() { $NoBaseRapeNotifyCount = -1; } -//This function is at StaticShapeData::damageObject(%data, %targetObject, %sourceObject, %position, %amount, %damageType) -//In the staticshape.ovl in evoClassic.vl2 -//Plays a sound when a player hits a protected asset +// This function is at StaticShapeData::damageObject(%data, %targetObject, %sourceObject, %position, %amount, %damageType) +// In the staticshape.ovl in evoClassic.vl2 +// Plays a sound when a player hits a protected asset function NBRAssetSound( %game, %sourceObject ) { %client = %sourceObject; @@ -51,7 +55,7 @@ function NBRAssetSound( %game, %sourceObject ) } } -//Cool down between messeges +// Cool down between messages function ResetNBRAssetSound( %client ) { %client.NBRAssetSoundMsgPlayed = false; diff --git a/Classic/scripts/autoexec/ObserverCooldown.cs b/Classic/scripts/autoexec/ObserverCooldown.cs index 1a69562..1769ede 100644 --- a/Classic/scripts/autoexec/ObserverCooldown.cs +++ b/Classic/scripts/autoexec/ObserverCooldown.cs @@ -1,5 +1,7 @@ -// Made as a preventitive measure to ensure no rapid observer/spawning -// +// Observer Cooldown Script +// +// Made as a preventative measure to ensure no rapid observer/spawning +// Limits how fast a client can spawn and go to observer // package ObserverTimeout diff --git a/Classic/scripts/autoexec/TacoOverrides.cs b/Classic/scripts/autoexec/TacoOverrides.cs index 7ccc89d..b480c24 100644 --- a/Classic/scripts/autoexec/TacoOverrides.cs +++ b/Classic/scripts/autoexec/TacoOverrides.cs @@ -1,4 +1,6 @@ -//Various Overrides +// Taco Overrides Script +// +// Various Overrides // package TacoOverrides diff --git a/Classic/scripts/autoexec/TimedServerReset.cs b/Classic/scripts/autoexec/TimedServerReset.cs index 5f8814d..54126d0 100644 --- a/Classic/scripts/autoexec/TimedServerReset.cs +++ b/Classic/scripts/autoexec/TimedServerReset.cs @@ -1,12 +1,14 @@ -//Timed Server reset -//Reset Server after a certain time +// Timed Server Reset Script // -//Time in Minutes +// Reset Server after a certain time +// after the last client leaves +// +// Time in Minutes // $Host::EmptyServerResetTime = 120; -//To control whether the server auto resets when empty +// To control whether the server auto resets when empty // $Host::EmptyServerReset = 1; -//Changed in evo Server.ovl +// Changed in evo Server.ovl // //function GameConnection::onDrop(%client, %reason) //{ diff --git a/Classic/scripts/autoexec/VoteOverTime.cs b/Classic/scripts/autoexec/VoteOverTime.cs index 942cac8..ee83c71 100644 --- a/Classic/scripts/autoexec/VoteOverTime.cs +++ b/Classic/scripts/autoexec/VoteOverTime.cs @@ -1,6 +1,10 @@ +// Vote OverTime Script +// +// Dont allow the match to end if a time vote is pending + + //Changes were also made in the Evo Admin.ovl and DefaultGame.ovl //DefaultGame::voteChangeMission, DefaultGame::voteChangeTimeLimit, serverCmdStartNewVote - package VoteOverTime { diff --git a/Classic/scripts/autoexec/VoteSound.cs b/Classic/scripts/autoexec/VoteSound.cs index 859fcad..d4fc129 100644 --- a/Classic/scripts/autoexec/VoteSound.cs +++ b/Classic/scripts/autoexec/VoteSound.cs @@ -1,10 +1,12 @@ -//Make a sound every so seconds to make sure everyone votes +// VoteSound Script // -//Enable or Disable VoteSound -//$Host::EnableVoteSound = 1; +// Make a sound every so seconds to make sure everyone votes // -//%VotesoundRandom must match $VoteSoundRandom to prevent duplicate messages -//$VoteSoundRandom is generated everytime a vote starts and if it doesnt match an ongoing schedule does not play. +// Enable or Disable VoteSound +// $Host::EnableVoteSound = 1; +// +// %VotesoundRandom must match $VoteSoundRandom to prevent duplicate messages +// $VoteSoundRandom is generated everytime a vote starts and if it doesnt match an ongoing schedule does not play. function VoteSound( %game, %typename, %arg1, %arg2, %VoteSoundRandom ) {