ObjectiveTrak v3.3

ObjectiveTrak v3.3
==================
27th June 2000

Written by |HH|Crunchy (Jonathan Slark)
Web page: http://www.planetstarsiege.com/crunchy/
Email: [email redacted]

*** Requires the Presto Pack v0.93 or later ***  http://www.planetstarsiege.com/presto/
*** Requires Writer's Support Pack v4.0.4 BETA or later *** http://www.planetstarsiege.com/lorne/
*** Supports Poker's BWAdmin mod ***  http:www.pokerspockets.freeserve.co.uk/


Removing the MissionInfo pack
-----------------------------

The MissionInfo pack is no more, it is being replaced by ObjectiveExtract.exe.

Remove the folder Tribes\config\missions.  If you do not do this ObjectiveTrak will
not work!

Also remove any mission info files in your Tribes\config directory, from now on
files are only saved to the Tribes\base\missions directory so this will not happen
again.  Mission info files are called <mission name>.cs.  eg: Broadside.cs, Anthill.cs
etc.


Removing previous versions of ObjectiveTrak
-------------------------------------------

Remove the following files:
config\Crunchy\Events.cs
config\Crunchy\ObjectiveTrak.cs


Installation
------------

1. Unzip the files into the Tribes\config\ dir.

2. Move ObjectiveExtract.exe to your Tribes\base\missions dir.

2. [Optional] Run ObjectiveExtract.exe by double clicking it.  It builds the mission info files
   the script uses.  Note you could skip this step but the HUD will have to learn about
   the objectives as it goes along.

3. [Optional] Unzip the TAC.zip to the Tribes\ directory.  It contains mission info files for
   the TAC mod.  These mission info files must be in Tribes\TAC\missions.


Disclaimer
----------

I can't be held responsible if ObjectiveExtract.exe does or does not do harm to your
computer.  Do not use ObjectiveExtract.exe in life threatening situations or in medical
equipment.  Do not use ObjectiveExtract.exe in Air Traffic Control software. Do not
immerse ObjectiveExtract.exe in water.  Use a lint free cloth to clean ObjectiveExtract.exe.
Do not open the door whilst ObjectiveExtract.exe is running.  Never allow small children
near ObjectiveExtract.exe.  Seek advice if you read this far.


Scripting notes
---------------

See the document ObjectiveTrak_notes.txt for more details.

-- ObjectiveTrak -- v3.2.1 -- Scripters notes ------------------------------------------------------------------
Written by |HH|Crunchy (Jonathan Slark)
Web page: http:www.planetstarsiege.com/crunchy/
Email: [email redacted]

*** Requires the Presto Pack v0.93 or later ***  http:www.planetstarsiege.com/presto/
*** Supports Poker's BWAdmin mod ***  http:www.pokerspockets.freeserve.co.uk/

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 below).

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.


-------------
---Example---
-------------

	To check the status of all the objectives you could use a simple loop to run through them:

		for(%id = 0; id < Objective::Number(); id++)
		{
			%status = Objective::GetStatus(%id);
			%type = Objective::GetType(%id);
			if(%type == $Objective::CandH)
			{
				if(%status == $Objective::Enemy)
				{
					(do something useful regarding enemy having the objective)
				}
				else
				{
					(etc)
				}
			}
		}

 For a working example take a look at Objective HUD.


------------------
--- New events ---
------------------

	eventObjectiveReset()

		Triggered when the script is reset.  There are no obectives at this point, we will either load info
		about them or find out about them during the game.

	eventObjectiveLoaded(%num)

		Called when the objectives are loaded off disk, the number loaded is returned.  If they can't be
		loaded the objectives will be added when they are taken or lost.  After each mission any new
		objectives will be saved to the config directory so that the next time you play that level the
		script will know about the objectives.  If only a partial list was saved out then the script will
		still learn about new objectives when they are claimed.

		Note: This event is triggered even if no objectives were loaded, %num == 0.

	eventObjectiveMadeNeutral()

		On a mission change or if you join a server just before the match starts the script knows that all
		the objectives are neutral.  It sets them neutral and then triggers this event.

	eventObjectiveNew(%client, %id, %status, %type)

		Just found about a new objective.  The event returns the client ID of the player that changed the
		state of the objective, the ID of the objective, the status of the objective and the type of the
		objective.  The client ID is 0 if it was the server that changed the status of the objective, for
		instance returning an F&R flag after it was dropped and no one picked it up.

	eventObjectiveUpdated(%client, %id, %status, %type)

		An objective already known about has changed state in some way.  The event returns the client ID of
		the player that took the objective, the ID of the objective, the new status of the objective and the
		type of the objective.  The client ID is 0 if it was the server that changed the status of the
		objective.


Events more specific than eventObjectiveUpdated:

	Use the following events instead of eventObjectiveUpdated if they provide what you need.  This ensures
	your script has to do little as possible.

	eventObjectiveTaken(%client, %id, %team, %type)

		Whenever an objective is taken by your team or if your in observer mode this is triggered.  It returns
		the client that took the objective and the objective name.  Objectives that can be taken are C&H
		towers and D&D objectives.  In the case of D&D objectives "take" means your team destroyed the enemy
		objective.

	eventObjectiveLost(%client, %id, %team, %type)

		Whenever an objective that your team was holding is lost this is triggered.  It returns the client
		that took the objective, the objective name and the team that took it.  Objectives that can be lost
		are C&H towers and D&D objectives.  In the case of D&D objectives "lost" means your team failed to
		defend one of your objectives.

	eventObjectiveFlagTaken(%client, %id, %team, %type)

		This event is triggered when a flag has been taken.  It returns the client that is now carrying the
		flag, the flag's ID and the team number.  The type can be a CTF flag or F&R flag.  In CTF missions
		the team is that of the flag, for F&R flags it is the team of the taker.

	eventObjectiveFlagDropped(%client, %id, %team, %type)

		A flag was dropped in the field.  The client that dropped the flag is returned.  Also the flag ID
		and team are returned.  The type can be a CTF flag or F&R flag.  In CTF missions the team is that of
		the flag, for F&R flags it is the team of the dropper.

	eventObjectiveFlagReturned(%client, %id, %team, %type)

		A flag was returned to it's initial position.  For F&R flags this only happens when a player left the
		mission area whilst carrying it or the flag was dropped in the field for a certain length of time.
		For CTF flags this can be either when a player left the mission area or an enemy returned it or the
		flag 

• Readme_ObjectiveTrak.txt 2.3 KB
• ObjectiveExtract.exe 76.0 KB
• ObjectiveTrak_notes.txt 14.6 KB
• ObjectiveAbbreviations.cs 4.1 KB
• ObjectiveTrak.avl.vol 57.1 KB
• ObjectiveTrak.avl.vol/Crunchy\ObjectiveTrak.cs 56.6 KB
• ObjectiveTrak.avl.vol/Crunchy\RegisterPref.cs 460 B
• Tac.zip 6.7 KB