As used by Objective HUD. This is a tool for scripters, Objective HUD is an example of its use. There is an alternative interface for ObjectiveTrak: VéKTöRHud. ObjectiveTrak isn't limited to HUDs, there could be many uses for it, check it out.
Description
Scripting tool that tracks the status of the objectives in missions. The script can track objectives in any of the missions, either base or custom including CTF, C&H, D&D, F&R, Balanced, Open Call and Multiple Team. Take a look at the new events and functions ObjectiveTrak defines listed below. For an example of the use of the script check out my Objective HUD.
The script has the ability to learn about objectives from the messages sent to the client you see in the chat box. The script also loads information about missions from the files created using ObjectiveExtract.exe. There is no other way to find out about the objectives from a script, rather than 20 scripts all having to do this hard work ObjectiveTrak does it all for you.
The current implemetation assigns each objective an unique ID. The ID is an interger which is in the range from zero to one less than the number of objectives (see ObjectiveTrak_notes.txt).
The script patches TeamTrak to bring it up to date. It lets TeamTrak know about the team names as soon as you are connected. Flag tracking has been extended to work with multiple teams. The interface for TeamTrak has not been changed in any way.
The zip file has everything you need for ObjectiveTrak. ObjectiveTrak.cs has all the documentation you need to use it in your own scripts. Read the Readme_ObjectiveTrak.txt for installation instructions. Read the ObjectiveTrak_notes.txt for notes on how to use the ObjectiveTrak in your own scripts.
Changes in v3.3
Autoloading volume.
Uses Writers support pack.
Updated the TAC mission info files for TAC v1.3.
Changes in v3.2.1
Fixed problem with F&R timer going negative. Thanks (RSV)MassMedia for spotting it.
Changes in v3.2
Gets the winning score from BWAdmin mod v4.2 properly.
Parses server message to get the start value of the F&R flag timer.
Fixed double CTF flag return problem, the flag status is only changed once now.
Added new functions:
Objective::GetFlagName()
Objective::GetFlagID()
Objective::GetTeamNameAbbreviated()
Objective::GetFandRTimer()
Objective::GetLocationX()
Objective::GetLocationY()
Changes in v3.1
Complete Team Aerial Combat score support.
Changes in v3.0
Files are stored in Tribes\base\missions. No files are saved to the config dir now!
Supports the latest BW Admin mod. If you join a server running the latest BW Admin mod the script will know the scores and the exact status of all the objectives on any mission! Woohoo :).
ObjectiveExtract.exe, which can extract mission info from any mission files the user has.
The guts have been rewritten to be lean and mean. It is more efficient and should be easier to find any potential bugs.
Multiple team support, up to 8 teams if you wanted!
Patches TeamTrak to support multiple team missions and updates TeamTrak to know the team names as soon as you join the server or an admin changes the name.
Uses mission type to cut down on message parsing. Works out what type of mission a balanced or open call mission is from the objective list.
Extended status and type functions: Objective::GetStatusExt() and Objective::GetTypeExt().
Moved the docs to ObjectiveTrak_notes.txt, also updated the docs.
New functions (see ObjectiveTrak_notes.txt):
Objective::GetMissionType()
Objective::IsBWAdmin()
Objective::IsMatchStarted()
Objective::GetTeamNum()
Objective::GetStatusExt()
Objective::GetTypeExt()
Objective::GetTypeNum()
Objective::ConvertType()
Removed key binding.
Changes in v2.0 beta 7:
Moved eventObjectiveLoaded so that scripts can avoid having to use eventObjectiveMadeNeutral as well. These events were very close together and so could cause problems.
Changes in v2.0 beta 6:
Added support for scores in the mission info files.
Added score code to Objective::Set() and the plugins.
Added support functions:
Objective::GetTeamScore()
Objective::GetScore()
Objective::GetDeltaScore()
Objective::GetTime()
Objective::GetTimeScore()
Objective::GetWinScore()
Changed F&R tracking to work with Tribes v1.6's new 180sec timelimit for conveying a flag.
Objective::InsertTeamName() returns the team name (if known) instead of "Enemy ..." when observing.
Changes in v2.0 beta 5:
Client message parser didn't check to see if the message was from the server. D'oh :)
Changes in v2.0 beta 4:
Added new events:
eventObjectiveTaken
eventObjectiveLost
eventObjectiveFlagTaken
eventObjectiveFlagDropped
eventObjectiveFlagReturned
eventObjectiveFlagCaptured
eventObjectiveFlagHolds
CTF flags support!
Added support function Objective::InsertTeamSymbol().
Support function Objective::GetId() optimised. Now executes in constant rather than linear time.
Flag (F&R and CTF) carry state was being stored fixed, now changes correctly if you change teams.
Changes in v2.0 beta 3:
Fixed another CTF / F&R flag clash.
Fixed bug where abbreviated names for new objectives weren't being stripped.
Moved abbreviations to the MissionInfo Pack.
Changes in v2.0 beta 2:
Added support function Objective::GetNameAbbreviated(%id). Abbreviations are stored in a table for efficiency.
Had to add toggle key to distinguish between CTF and F&R flags, $ServerMissionType isn't always set.
Changes in v2.0 beta:
Compelete rewrite. Generalised the script so that it could track any objective.
Beta version released to get bug reports as testing is difficult.
Used the logic and messages from scripts.vol to derive the messages and parsing functions.
Changes in v1.0.1:
Fixed bug where Objective::GetNameStripped(%id) would return a null value if there was no "the" at the start of the name (don't rename variables ;).
What happend to v1.0?
I first wrote the script to track C&H mission objectives but Presto pointed out it could be generalised to track any objective. Thanks for the idea Presto :)
