Difference between revisions of "CombatMFD"

From Elite Wiki
(v1.8)
(v1.9)
Line 79: Line 79:
  
  
=== HUD dials ===
+
=== Custom HUD dials ===
  
 
Oolite v1.81 provide [http://wiki.alioth.net/index.php/Hud.plist#data_source drawCustomText:] HUD dial which can display informations without MFD.
 
Oolite v1.81 provide [http://wiki.alioth.net/index.php/Hud.plist#data_source drawCustomText:] HUD dial which can display informations without MFD.
  
You still must buy the CombatMFD equipment for the followings but you must not show up the MFD if your HUD has support for these (like the Original HUD in [[HUDSelector]]).
+
You still must buy the CombatMFD equipment for the followings but you must not show up the MFD if your HUD has support for these (like the Original and Small HUDs in [[HUDSelector]]).
  
 
CombatMFD fill up the following dials with values, so HUD designers can use these:
 
CombatMFD fill up the following dials with values, so HUD designers can use these:
Line 90: Line 90:
 
  combatAftSh aft shield numeric value, including capacitors
 
  combatAftSh aft shield numeric value, including capacitors
 
  combatAftShP aft shield percent value, over 100% if upgraded
 
  combatAftShP aft shield percent value, over 100% if upgraded
  combatAlt altitude over a planet, moon or sun
+
  combatAlt altitude over the nearest planet, moon or sun in km
 +
combatAltR altitude over a planet, moon or sun in radius
 
  combatCredits credits of player
 
  combatCredits credits of player
 
  combatCTemp cabin temp
 
  combatCTemp cabin temp
Line 123: Line 124:
 
  combatTSpeed speed of the current target
 
  combatTSpeed speed of the current target
  
Numeric values are centered in a 28 character wide field by default, texts are left aligned.
+
Numeric values are centered in a 28 character wide field by default, texts are left aligned (you can align to right in hud plist with [http://wiki.alioth.net/index.php/Hud.plist#align align=1]).
  
 
The default width of centered fields is adjustable in the worldScripts.combat_MFD.$DW variable.
 
The default width of centered fields is adjustable in the worldScripts.combat_MFD.$DW variable.
Line 142: Line 143:
  
  
Original HUD display numeric speed over the speed bar (available in [[HUDSelector]]):
+
Original HUD use many custom dials (available in [[HUDSelector]]):
[[File:CombatMFD1.8a.png|710px]]
+
[[File:CombatMFD1.9.png|800px]]
  
This need the following code in the dials section in the plist of HUD:
+
 
 +
For example the speed value need the following code in the dials section in the plist of HUD:
 
  {
 
  {
 
  data_source = "combatSpeed";
 
  data_source = "combatSpeed";
Line 205: Line 207:
  
 
=== Downloads ===
 
=== Downloads ===
 +
 +
[[Media:CombatMFD_1.9.oxz|Combat MFD v1.9]] (downloaded {{#downloads:CombatMFD_1.9.oxz}} times).
  
 
[[Media:CombatMFD_1.8.oxz|Combat MFD v1.8]] (downloaded {{#downloads:CombatMFD_1.8.oxz}} times).
 
[[Media:CombatMFD_1.8.oxz|Combat MFD v1.8]] (downloaded {{#downloads:CombatMFD_1.8.oxz}} times).
Line 230: Line 234:
  
 
Changelog:
 
Changelog:
 +
2014.10.20. v1.9  Custom dials of player always calculated, dials of target need the equipment.
 +
                  Altitude custom dial in km added.
 
  2014.10.16. v1.8  HUD dials added, need Oolite 1.81 and support in HUD plist.
 
  2014.10.16. v1.8  HUD dials added, need Oolite 1.81 and support in HUD plist.
 
  2014.10.11. v1.7  Telescope display the newest detected target in the last line.
 
  2014.10.11. v1.7  Telescope display the newest detected target in the last line.
Line 264: Line 270:
 
==Quick Facts==
 
==Quick Facts==
 
{{OXPLevel|0}}{{Infobox OXPb| title = Combat MFD
 
{{OXPLevel|0}}{{Infobox OXPb| title = Combat MFD
|version = 1.8
+
|version = 1.9
|release = 2014-10-16
+
|release = 2014-10-20
 
|features = Data about your ship and your target
 
|features = Data about your ship and your target
 
|license = CC BY-NC-SA 4
 
|license = CC BY-NC-SA 4

Revision as of 21:13, 20 October 2014

Description

If you buy Combat MFD equipment then your Multi-Function Displays will display many info from your ship:

and your target's:

  • name,
  • distance and speed,
  • shield radius, then Front/Aft orientation display and Damaged!/Weak!/Derelict flag,
  • laser weapon type and range (after a shot),
  • status: Clean/Offender/Fugitive, if derelict then Trap or Treasure/Empty/Mined/Usable (see Towbar OXP).
  • fired missiles counter with "Hard" flag.

Telescope can display the newly detected target in the last line.

Use the ";" and ":" keys to select an MFD and enjoy the view. ;)

CombatMFD1.7.png


Compatible with Telescope OXP if lock far targets and ShieldEqualizer+Capacitors OXP: if shields are over 100% then either Shield Boosters are installed or Shield Capacitors are filled also.

The "Damaged!" flag shown when the target's exhaust plumes are blinking (below 40% energy) and show "Weak!" when blinking strongly and drop sparks with CustomShields OXP (below 20%).

If your HUD has support for this (like NumericHUDv3.25) then you will see these words near your crosshairs also. The support mean the following lines in the legends section of your hud.plist:

{ equipment_required="EQ_DTADAM"; x=30; y=40; y_origin=0; height=20; width=16; text="Damaged"; alpha=0.5; },
{ equipment_required="EQ_DTAWEA"; x=30; y=40; y_origin=0; height=20; width=16; text="Weak"; alpha=0.5; },
{ equipment_required="EQ_DTADER"; x=30; y=40; y_origin=0; height=20; width=16; text="Derelict"; },


SEE indicator

The top right corner show letters about how many shields, armour and energy remaining. Each letter represents 2 energy banks in strength and ordered by from outside to inside. Small letters mean one side is up only.


"SEE" mean you have basic Shields (2 banks=128 points) and 2*2 Energy banks filled (4 banks=256 points), as a Cobra Mark III at start.

The total length is relative with your ship's defensive strength. The strongest Andromeda has CCCCCCCCMBSAAAAAAAAHHHEEEEEEEE. :)

A letter will be changed to "-" if drops below the half of the banks represented by this letter so "-E" mean less than 3 banks filled and more than one.

Underscore "_" mean equipment damage which prevent regeneration, you should fix it in a dock. Checked damages:


The number in the corner show the total value in banks (64 points).

If you see "LAST BANK!" here instead of letters then ... well, you know. (Flee! ;))


One-shot indicator

The space rightwards from shield percentages show letters to indicate one-shot equipments, in order:


Custom HUD dials

Oolite v1.81 provide drawCustomText: HUD dial which can display informations without MFD.

You still must buy the CombatMFD equipment for the followings but you must not show up the MFD if your HUD has support for these (like the Original and Small HUDs in HUDSelector).

CombatMFD fill up the following dials with values, so HUD designers can use these:

data_source   	description
combatAftSh	aft shield numeric value, including capacitors
combatAftShP	aft shield percent value, over 100% if upgraded
combatAlt	altitude over the nearest planet, moon or sun in km
combatAltR	altitude over a planet, moon or sun in radius
combatCredits	credits of player
combatCTemp	cabin temp
combatDmgEq	name of the lastly damaged equipment
combatDEqNum	number of the damaged equipments
combatEnergy	energy of player ship in numeric form
combatEnergyP	energy of player ship in percent
combatFwSh	forward shield numeric value, including capacitors
combatFwShP	forward shield percent value, over 100% if upgraded
combatFuel	remaining fuel in the main tank in ly, min. 0.0, max. 7.0
combatFuelReq	required fuel of a declared hyperjump
combatFuelRes	reserve fuel in extra tanks (integer)
combatLegal	legal status of player, Clean/Offender/Fugitive
combatLegalNum	legal status of player, bounty
combatNewTelT	name of the newest target detected by Telescope
combatOneShot	letters of One-shot indicator (BCEGHPRU)
combatSCTDist	distance of space compass target
combatSEE	letters of SEE indicator about the player ship (CMBSAHE)
combatSEEMax	maximum number of ship durability: max of shield+armour+energy
combatSEENum	number of ship durability: shield+armour+energy
combatSpeed	actual speed of player ship in m/s
combatTDist	distance of the current target
combatTDmg	damaged/weak/derelict status of the current target
combatTEnergy	energy of the current target, use for debug only
combatTLaser	laser weapon of the current target
combatTLegal	legal status of the current target, if derelict then Towbar status
combatTLRange	range of the target's laser weapon
combatTMissile	missile type fired by the target, Normal/Hard/Unknown
combatTMissNum	number of missiles fired by the target so far
combatTName	full name of the current target
combatTRadius	shield radius of the current target
combatTSpeed	speed of the current target

Numeric values are centered in a 28 character wide field by default, texts are left aligned (you can align to right in hud plist with align=1).

The default width of centered fields is adjustable in the worldScripts.combat_MFD.$DW variable.

If $DW is 0 then all field will be left aligned.

If $DW negative then right aligned in the given width.


Using the drawCustomBar: selector HUDs can give graphical feedback about the following values:

data_source   	description
combatAftShBar	aft shield bar including capacitors
combatCargoBar	how filled the cargo bay of player ship
combatFwShBar	forward shield bar including capacitors
combatSEEBar	total durability bar of player ship based on the SEE indicator
combatSLBar	service level bar of player ship


Original HUD use many custom dials (available in HUDSelector): CombatMFD1.9.png


For example the speed value need the following code in the dials section in the plist of HUD:

{
	data_source = "combatSpeed";
	selector = "drawCustomText:";
//	alert_conditions = 2; //uncomment if you want to see in green alert only
	alpha = 1.0;
	height = 13;
	width = 15;
	x = 151;
	y = 87;
	y_origin = -1;
},


OXP developers can reach all data in worldScripts.combat_MFD.$Data object using the same data_soucre key names, so for speed use $Data.combatSpeed .

The access of worldScript name is slow, so you should get a pointer once in startUp:

this.startUp = function() {
	this.$combatWS = worldScripts.combat_MFD; //slow access for the pointer, one time only
}
this.$displaySpeed = function() {
	if( this.$combatWS ) //must check CombatMFD existence to prevent an error
		player.consoleMessage( this.$combatWS.$Data.combatSpeed ); //fast access
	else log(this.name, "Can not display speed value, CombatMFD OXP is missing");
}


The $DataArray contain all available data_source keys.

this.$combatKeyIsExists = function( key ) {
	if( this.$combatWS && this.$combatWS.$DataArray.indexOf( key ) > -1 )
		return true;
	else return false;
}


The $DataShow can disable the display of any data in the HUD:

this.$disableKey = function(combatKey) {
	if( this.$combatWS ) this.$combatWS.$DataShow[combatKey] = false;
}



Dependencies

Oolite 1.79 or later.

Instructions

Do not unzip the .oxz file, just move into the AddOns folder of your Oolite installation.

License

This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike License version 4.0. If you are re-using any piece of this OXP, please let me know by sending an e-mail to norbylite@gmail.com.

Downloads

Combat MFD v1.9 (downloaded 662 times).

Combat MFD v1.8 (downloaded 281 times).

Combat MFD v1.7 (downloaded 265 times).

Combat MFD v1.6 (downloaded 681 times).

Combat MFD v1.5 (downloaded 370 times).

Combat MFD v1.4 (downloaded 358 times).

Combat MFD v1.3 (downloaded 286 times).

Combat MFD v1.2 (downloaded 277 times).

Combat MFD v1.1 (downloaded 254 times).

Combat MFD v1.0 (downloaded 269 times).

Forum

Make your comments in this topic.


Changelog:

2014.10.20. v1.9  Custom dials of player always calculated, dials of target need the equipment.
                  Altitude custom dial in km added.
2014.10.16. v1.8  HUD dials added, need Oolite 1.81 and support in HUD plist.
2014.10.11. v1.7  Telescope display the newest detected target in the last line.
                  Fuel display counts additional FuelTank, DuplexFuelTank, ExtraFuelTanks and
                  the reserve fuel of Andromeda also.
                  Better energy feedback for ships with a single energy bank.
2014.08.11. v1.6  Damaged, Weak and Derelict display on HUDs with support for this feature.
                  Show FW instead of 8x when TorusToSun use time forwarding at max. speed.
2014.07.24. v1.5  Equipment cost raised to 1000cr due to the MFD pricing thread.
                  Show Torus multiplier after player speed if Torus To Sun is installed.
                  Line length fine tune with hair spaces, thanks to spara.
2014.07.09. v1.4  SEE and One shot indicators added.
                  Player legal status added.
                  Missile counter with "Hard" flag added.
                  Energy and Shields percents are rounded to 10 for better readability.
                  Target Front/Aft orientation display.
                  Speed display use velocity for Q-Charger.
                  A fix against garbage-collected timer in log.
2014.07.07. v1.3  Informations added in top right and bottom right corners.
                  Speed labels removed to prevent twithcing.
                  A small fix about Telescope far targets.
2014.07.06. v1.2  Show the name of the lastly damaged equipment.
                  Show the target's laser type and range after a shot.
                  Energy and Shields are displayed in percents only.
2014.07.05. v1.1  Must buy Combat MFD as an equipment.
                  Legal status display need Scanner Targeting Enhancement.
                  Show Telescope far target names without km.
                  Can show Empty, Mined and Usable ship status with Towbar.
                  Wormhole target supported with Wormhole Scanner equipment.
2014.07.02. v1.0  More info displayed by Norby.
2014.06.30. v0.1  Some info displayed by Zireael.


Quick Facts

Levelindicator0.png
0-{{{2}}}
Version Released License Features Category Author(s) Feedback
1.9 2014-10-20 CC BY-NC-SA 4 Data about your ship and your target HUD OXPs Norby BB-Link