Merge pull request #882 from NoxxFlame/taskmaster

Taskmaster

Author: Malivil

.luacheckrc

@@ -897,6 +897,7 @@ globals = {
     "EVENT_VINDICATORFAIL",
     "EVENT_VINDICATORSUCCESS",
     "EVENT_ZOMBIFIED",
+    "FEET_PER_METER",
     "GLITCH_CHAT_NONE",
     "GLITCH_CHAT_BLOCK_ALWAYS",
     "GLITCH_CHAT_BLOCK_WHILE_ALIVE",
@@ -1052,6 +1053,10 @@ globals = {
     "SPECIAL_DETECTIVE_HIDE_NONE",
     "SPONGE_ALL_PLAYERS",
     "SPONGE_ATTACKER_AND_VICTIM",
+    "TASKMASTER_TF_TARGETID_PLAYERICON",
+    "TASKMASTER_TF_TARGETID_PLAYERTEXT",
+    "TASKMASTER_TF_PROGRESSBAR",
+    "TASKMASTER_TF_PARTICLERADIUS",
     "TRACKRADAR",
     "TRAITOR_BUTTON_ROLES",
     "TRAITOR_ROLES",
@@ -1078,6 +1083,7 @@ globals = {
     "WIN_PLAGUEMASTER",
     "WIN_SHADOW",
     "WIN_SPONGE",
+    "WIN_TASKMASTER",
     "WIN_TIMELIMIT",
     "WIN_TRAITOR",
     "WIN_VAMPIRE",
@@ -1145,6 +1151,7 @@ globals = {
     "ROLE_SPONGE",
     "ROLE_SPY",
     "ROLE_SWAPPER",
+    "ROLE_TASKMASTER",
     "ROLE_TRACKER",
     "ROLE_TRICKSTER",
     "ROLE_TURNCOAT",
@@ -1213,6 +1220,7 @@ globals = {
     "CRHUD",
     "DEATHRADAR",
     "SYNC",
+    "TASKMASTER",
 
     -- TTTPAP Namespaces
     "TTTPAP",

API/HOOKS.md

@@ -199,6 +199,15 @@ Called before the name and role of a player's killer is shown to the victim. Use
 - *killerName* - The new killerName value to use or the original passed into the hook
 - *role* - The new role value to use or the original passed into the hook. Use `ROLE_NONE` to hide the attacker's role from the victim
 
+### TTTDetectiveCalledToBody(ply, owner, rag)
+Called when a player calls a detective to a player ragdoll.\
+*Realm:* Server\
+*Added in:* 2.3.5\
+*Parameters:*
+- *ply* - The player who is calling for a detective
+- *owner* - The player who owns the corpse the detective is being called to
+- *rag* - The ragdoll representing the corpse being called to
+
 ### TTTDetectiveLikePromoted(ply)
 Called when a detective-like (deputy, impersonator, etc.) player is promoted.\
 *Realm:* Server\

CONVARS.md

@@ -116,6 +116,7 @@ ttt_shadow_enabled                             0       // Whether or not the Sha
 ttt_arsonist_enabled                           0       // Whether or not the Arsonist should spawn
 ttt_hivemind_enabled                           0       // Whether or not the Hive Mind should spawn
 ttt_plaguemaster_enabled                       0       // Whether or not the Plaguemaster should spawn
+ttt_taskmaster_enabled                         0       // Whether or not the Taskmaster should spawn
 
 // Individual Role Spawn Weights
 ttt_hypnotist_spawn_weight                     1       // The weight assigned to spawning the Hypnotist
@@ -165,6 +166,7 @@ ttt_shadow_spawn_weight                        1       // The weight assigned to
 ttt_arsonist_spawn_weight                      1       // The weight assigned to spawning the Arsonist
 ttt_hivemind_spawn_weight                      1       // The weight assigned to spawning the Hive Mind
 ttt_plaguemaster_spawn_weight                  1       // The weight assigned to spawning the Plaguemaster
+ttt_taskmaster_spawn_weight                    1       // The weight assigned to spawning the Taskmaster
 
 // (Note: Each role is limited to one player per round.)
 
@@ -216,6 +218,7 @@ ttt_shadow_min_players                         0       // The minimum number of
 ttt_arsonist_min_players                       0       // The minimum number of players required to spawn the Arsonist
 ttt_hivemind_min_players                       0       // The minimum number of players required to spawn the Hive Mind
 ttt_plaguemaster_min_players                   0       // The minimum number of players required to spawn the Plaguemaster
+ttt_taskmaster_min_players                     0       // The minimum number of players required to spawn the Taskmaster
 
 // Grouped Role Spawn Settings
 ttt_twins_enabled                              0       // Whether or not the Twins should spawn
@@ -967,7 +970,88 @@ ttt_plaguemaster_dart_replace_timer            0       // How long (in seconds)
 ttt_plaguemaster_body_search_mode              1       // Whether dead bodies reveal if they had the plague when searched. 0 - Don't show. 1 - Show if died from plague. 2 - Show if Infected with plague.
 ttt_plaguemaster_can_see_jesters               0       // Whether jesters are revealed (via head icons, color/icon on the scoreboard, etc.) to the Plaguemaster
 ttt_plaguemaster_update_scoreboard             1       // Whether the Plaguemaster shows dead players as missing in action
-    
+
+// Taskmaster
+ttt_taskmaster_blocks_team_wins                1       // Whether the Taskmaster should block teams (innocent, traitor, monster) from winning if they are alive and haven't finished their tasks.
+ttt_taskmaster_is_passive                      0       // Whether the Taskmaster should count as a 'passive' role for roles that need to kill other players, allowing them to win while the Taskmaster is still alive (if 'ttt_taskmaster_wins_with_others' is enabled)
+ttt_taskmaster_kill_tasks                      1       // The number of kill tasks assigned to the Taskmaster
+ttt_taskmaster_misc_tasks                      2       // The number of miscellaneous tasks assigned to the Taskmaster
+ttt_taskmaster_repeat_rerolls                  1       // Whether the Taskmaster can be assigned tasks they previously rerolled away from
+ttt_taskmaster_win_block_length                60      // How long (in seconds) the Taskmaster should block teams (innocent, traitor, monster) from winning for (if 'ttt_taskmaster_blocks_team_wins' is enabled). Set to 0 to block until time runs out
+ttt_taskmaster_wins_with_others                1       // If the Taskmaster should be allowed to win alongside other teams/players
+
+// Taskmaster tasks
+ttt_taskmaster_calldetective_enabled           1       // Whether the 'Call a Detective to a Body' task should be enabled
+ttt_taskmaster_carrycorpse_enabled             1       // Whether the 'Carry a Corpse for X Seconds' task should be enabled
+ttt_taskmaster_carrycorpse_time                60      // The time (in seconds) a player must carry a player corpse to complete the 'Carry Corpse' task
+ttt_taskmaster_chat_enabled                    1       // Whether the 'Send X Messages' task should be enabled
+ttt_taskmaster_chat_times                      25      // The number of text messages a player must sent to complete the 'Send X Messages' task
+ttt_taskmaster_completion_bonus                1       // How many credits the Taskmaster should get whenever they complete a task
+ttt_taskmaster_crouch_enabled                  1       // Whether the 'Crouch for X Seconds' task should be enabled
+ttt_taskmaster_crouch_time                     40      // The time (in seconds) a player must stay crouched to complete the 'Crouch' task
+ttt_taskmaster_crouchnearbody_enabled          1       // Whether the 'Crouch Near a Body' task should be enabled
+ttt_taskmaster_crouchnearbody_range            1       // The distance (in meters) away a player must stay within to count for the 'Crouch Near Body' task
+ttt_taskmaster_crouchnearbody_time             20      // The time (in seconds) a player must stay near a body to count for the 'Crouch Near Body' task
+ttt_taskmaster_crowbar_enabled                 1       // Whether the 'Swing a Crowbar 50 Times' task should be enabled
+ttt_taskmaster_crowbar_times                   50      // The number of times a player must use their crowbar to complete the 'Swing Crowbar' task
+ttt_taskmaster_damageeveryone_enabled          1       // Whether the 'Damage Everyone Else' task should be enabled
+ttt_taskmaster_dodamage_amount                 200     // The amount of damage a player must do to complete the 'Deal X Damage' task
+ttt_taskmaster_dodamage_enabled                1       // Whether the 'Deal X Damage' task should be enabled
+ttt_taskmaster_firebullets_enabled             1       // Whether the 'Fire X Bullets' task should be enabled
+ttt_taskmaster_firebullets_times               100     // The jump of times a player must fire a bullet to complete the 'Fire X Bullets' task
+ttt_taskmaster_getplayerkilled_enabled         1       // Whether the 'Get Target Killed' task should be enabled
+ttt_taskmaster_getplayertokill_enabled         1       // Whether the 'Get Target to Kill' task should be enabled
+ttt_taskmaster_healthunder_amount              15      // The amount of health a player must stay under to complete the 'Health Under' task
+ttt_taskmaster_healthunder_enabled             1       // Whether the 'Survive Under X Health' task should be enabled
+ttt_taskmaster_healthunder_time                60      // The time (in seconds) a player must stay under the target health to complete the 'Health Under' task
+ttt_taskmaster_holstered_enabled               1       // Whether the 'Stay Holstered for X Seconds' task should be enabled
+ttt_taskmaster_holstered_time                  60      // The time (in seconds) a player must stay holstered to complete the 'Holstered' task
+ttt_taskmaster_jump_enabled                    1       // Whether the 'Jump x Times' task should be enabled
+ttt_taskmaster_jump_times                      100     // The jump of times a player must jump to complete the 'Jump X Times' task
+ttt_taskmaster_kill360_enabled                 1       // Whether the 'Kill a Player After a 360' task should be enabled
+ttt_taskmaster_kill360_time                    3       // The time (in seconds) a player has after completing a 360 to kill a player for the 'Kill a Player After a 360' task
+ttt_taskmaster_killaiming_enabled              1       // Whether the 'Kill a Player While Aiming' task should be enabled
+ttt_taskmaster_killairborne_enabled            1       // Whether the 'Kill an Airborne Player' task should be enabled
+ttt_taskmaster_killbehind_enabled              1       // Whether the 'Kill a Player From Behind' task should be enabled
+ttt_taskmaster_killbehind_view_angle           75      // The angle (in degrees) from a player's eye angle within which the Taskmaster is 'spotted' for the 'Kill a Player From Behind' task
+ttt_taskmaster_killcrowbar_enabled             1       // Whether the 'Kill a Player With a Crowbar' task should be enabled
+ttt_taskmaster_killdistant_enabled             1       // Whether the 'Kill a Distant Player' task should be enabled
+ttt_taskmaster_killdistant_range               25      // The minimum distance (in meters) away a player can be to count for the 'Kill a Distant Player' task
+ttt_taskmaster_killdouble_enabled              1       // Whether the 'Get a Double Kill' task should be enabled
+ttt_taskmaster_killdouble_time                 5       // The time (in seconds) the taskmaster has between kills to complete the 'Get a Double Kill' task
+ttt_taskmaster_killheadshot_enabled            1       // Whether the 'Kill a Player With a Headshot' task should be enabled
+ttt_taskmaster_killlastbullet_enabled          1       // Whether the 'Kill a Player With Your Last Bullet' task should be enabled
+ttt_taskmaster_killmidair_enabled              1       // Whether the 'Kill a Player While Midair' task should be enabled
+ttt_taskmaster_killnearby_enabled              1       // Whether the 'Kill a Nearby Player' task should be enabled
+ttt_taskmaster_killnearby_range                5       // The maximum distance (in meters) away a player can be to count for the 'Kill a Nearby Player' task
+ttt_taskmaster_killonehit_enabled              1       // Whether the 'Kill a Player in One Hit' task should be enabled
+ttt_taskmaster_killpistol_enabled              1       // Whether the 'Kill a Player With a Pistol' task should be enabled
+ttt_taskmaster_killretaliate_enabled           1       // Whether the 'Kill a Player That Attacked First' task should be enabled
+ttt_taskmaster_killtarget_enabled              1       // Whether the 'Kill Target' task should be enabled
+ttt_taskmaster_killweapon_enabled              1       // Whether the 'Kill a Player With a Specific Weapon' task should be enabled
+ttt_taskmaster_lookatplayer_enabled            1       // Whether the 'Look at Target' task should be enabled
+ttt_taskmaster_lookatplayer_time               30      // The time (in seconds) a player must look at their target to complete for the 'Look at Player' task
+ttt_taskmaster_pickupshopitem_enabled          1       // Whether the 'Pick up a Shop Item' task should be enabled
+ttt_taskmaster_standonplayer_enabled           1       // Whether the 'Stand on a Player for X Seconds' task should be enabled
+ttt_taskmaster_standonplayer_time              15      // The time (in seconds) a player must stay stand on top of another player to complete the 'Stand On Player' task
+ttt_taskmaster_stayhidden_enabled              1       // Whether the 'Stay Hidden for X Seconds' task should be enabled
+ttt_taskmaster_stayhidden_time                 30      // The time (in seconds) a player must hide to complete for the 'Stay Hidden' task
+ttt_taskmaster_stayhigher_enabled              1       // Whether the 'Be Highest for X Seconds' task should be enabled
+ttt_taskmaster_stayhigher_time                 30      // The time (in seconds) a player must stay higher up to complete the 'Highest Player' task
+ttt_taskmaster_stayinarea_enabled              1       // Whether the 'Stay in Area for X Seconds' task should be enabled
+ttt_taskmaster_stayinarea_range                5       // The distance (in meters) away from the location that a player must stay within to count for the 'Stay in Area' task
+ttt_taskmaster_stayinarea_time                 30      // The time (in seconds) a player must stay inside the target area to count for the 'Stay in Area' task
+ttt_taskmaster_staylower_enabled               1       // Whether the 'Be Lowest for X Seconds' task should be enabled
+ttt_taskmaster_staylower_time                  30      // The time (in seconds) a player must stay lower down to complete the 'Lowest Player' task
+ttt_taskmaster_stayneartarget_enabled          1       // Whether the 'Stay Near Target' task should be enabled
+ttt_taskmaster_stayneartarget_range            5       // The distance (in meters) away a player must stay within to count for the 'Stay Near Target' task
+ttt_taskmaster_stayneartarget_time             30      // The time (in seconds) a player must stay near their target to count for the 'Stay Near Target' task
+ttt_taskmaster_survive_enabled                 1       // Whether the 'Survive' task should be enabled
+ttt_taskmaster_takedamage_enabled              1       // Whether the 'Take Damage and Survive' task should be enabled
+ttt_taskmaster_takedamage_time                 60      // The time (in seconds) a player must survive without taking further damage to complete the 'Take Damage' task
+ttt_taskmaster_weaponpickups_count             20      // The number of unique weapons a player must pick up to complete the 'Pick Up Weapons' task
+ttt_taskmaster_weaponpickups_enabled           1       // Whether the 'Pick up X Weapons' task should be enabled
+
 // ----------------------------------------
 
 // GROUPED ROLE SETTINGS
@@ -1145,6 +1229,7 @@ ttt_shadow_starting_health                     100     // The amount of health t
 ttt_arsonist_starting_health                   100     // The amount of health the Arsonist starts with
 ttt_hivemind_starting_health                   100     // The amount of health the Hive Mind starts with
 ttt_plaguemaster_starting_health               100     // The amount of health the Plaguemaster starts with
+ttt_taskmaster_starting_health                 100     // The amount of health the Taskmaster starts with
 
 // Individual Role Max Health. Set to 0 or -1 to use the game's default maximum health.
 ttt_traitor_max_health                         100     // The maximum amount of health a Traitor can have
@@ -1199,6 +1284,7 @@ ttt_shadow_max_health                          100     // The maximum amount of
 ttt_arsonist_max_health                        100     // The maximum amount of health the Arsonist can have
 ttt_hivemind_max_health                        100     // The maximum amount of health the Hive Mind can have
 ttt_plaguemaster_max_health                    100     // The maximum amount of health the Plaguemaster can have
+ttt_taskmaster_max_health                      100     // The maximum amount of health the Taskmaster can have
 
 // Round Time
 ttt_roundtime_win_draw                         0       // Whether a round that ends because the round time limit has passed counts as a draw. If it is not a draw, the traitor team loses

RELEASE.md

@@ -3,15 +3,16 @@
 ## 2.3.5 (Beta)
 **Released:**
 
-### Changes
-- Updated weapon switch and pickup HUD elements to use the same logic for getting weapon names
-  - Fixes very rare cases where they would say different things
-
 ### Additions
+- Added new independent role: Taskmaster
 - Added ability to control whether the mercenary gets body armor as part of their loadout (defaults to `true`)
 - Added ability to change vampire's fang drain overheal to overheal (default), increase max health, or do both
 - Added ability to disable automatically confirming a players death when searching their body (disabled by default)
 
+### Changes
+- Updated weapon switch and pickup HUD elements to use the same logic for getting weapon names
+  - Fixes very rare cases where they would say different things
+
 ### Fixes
 - Fixed illusionist not blocking traitor team voice chat
 - Fixed promoted impersonator and deputy who are searched by a detective not always showing their true role on the scoreboard
@@ -20,6 +21,8 @@
 - Added `state` parameter to `TTTTeamVoiceChatTargets` hook
 - Added `table.GetFirstItemWithPropertyValue` static method
 - Added `maxchange` parameter to `TTTVampireBodyEaten` hook
+- Added `TTTDetectiveCalledToBody` hook which is called when a player calls a detective to a body
+- Changed `SYNC` methods to not clear values that are already `nil`
 
 ## 2.3.4 (Beta)
 **Released: August 9th, 2025**

docs/api/hooks.html

@@ -308,6 +308,19 @@ <h3><a id="tttdeathnotifyoverridevictim-inflictor-attacker-reason-killername-rol
             <li><em>role</em> - The new role value to use or the original passed into the hook. Use <code>ROLE_NONE</code> to hide the attacker's role from the victim</li>
         </ul>
 
+        <h3><a id="tttdetectivecalledtobodyply-owner-rag" href="#tttdetectivecalledtobodyply-owner-rag">TTTDetectiveCalledToBody(ply, owner, rag)</a> <span data-text="Beta Only" class="betaonly betaicon tooltip">&nbsp;</span></h3>
+        <p>
+            Called when a player calls a detective to a player ragdoll.<br>
+            <em>Realm:</em> Server<br>
+            <em>Added in:</em> 2.3.5<br>
+            <em>Parameters:</em>
+        </p>
+        <ul>
+            <li><em>ply</em> - The player who is calling for a detective</li>
+            <li><em>owner</em> - The player who owns the corpse the detective is being called to</li>
+            <li><em>rag</em> - The ragdoll representing the corpse being called to</li>
+        </ul>
+
         <h3><a id="tttdetectivelikepromotedply" href="#tttdetectivelikepromotedply">TTTDetectiveLikePromoted(ply)</a></h3>
         <p>
             Called when a detective-like (deputy, impersonator, etc.) player is promoted.<br>