Difference between revisions of "PipScale"
EvilRenegade (talk | contribs) m (Replacing Template:TTL with Template:F.) |
m (Lots of minor revisions and clarifications. Style adjustments to Technoes: Instead of writing "VehicleType", for example, write "vehicle".) |
||
| Line 1: | Line 1: | ||
{{Flag | {{Flag | ||
| − | |values={{Values|strings|hardcoded values[[ | + | |values={{Values|strings|hardcoded values[[#Accepted values|{{sup|{{arr|d}}}}]]}} |
|default=none | |default=none | ||
|types={{Categ|Technoes}} | |types={{Categ|Technoes}} | ||
| Line 8: | Line 8: | ||
|ra2=yes | |ra2=yes | ||
|yr=yes | |yr=yes | ||
| − | |||
}} | }} | ||
| − | This flag is used to display a special type of graphical representation on certain units. This usually indicates a unit's current load of passengers, ammunition, or harvested ore. Each icon representing a portion of the load is referred to as a "pip". | + | This flag is used to display a special type of graphical representation on certain [[TechnoTypes|units]]. This usually indicates a unit's current load of passengers, ammunition, or harvested ore. Each icon representing a portion of the load is referred to as a "pip". |
==Accepted values== | ==Accepted values== | ||
| − | All values are case-insensitive. Any other values will simply be ignored. | + | All values are case-insensitive. Any other values will simply be ignored and the default used instead. |
| − | {| cellpadding=" | + | {| cellpadding="4" class="table_descrow" |
!Value | !Value | ||
!colspan=4|Game Availability | !colspan=4|Game Availability | ||
| Line 60: | Line 59: | ||
|[[Image:Game_ra2_yes.png]] | |[[Image:Game_ra2_yes.png]] | ||
|[[Image:Game_yr_yes.png]] | |[[Image:Game_yr_yes.png]] | ||
| − | |No effect | + | |No effect—no pips are displayed |
|- | |- | ||
|<code>mindcontrol</code> | |<code>mindcontrol</code> | ||
| Line 71: | Line 70: | ||
===Passengers=== | ===Passengers=== | ||
| − | {{f|PipScale|Passengers|link}} is typically used for any [[ | + | {{f|PipScale|Passengers|link}} is typically used for any [[VehicleTypes|vehicle]] with {{f|Passengers|link}} and {{f|SizeLimit|link}} each set to positive [[Help:Values#Integers|integers]] greater than or equal to the combined {{f|Size|link}} of its passengers, to show that there are units inside of it. The [[engine]] will always render a number of pips equal to {{f|Passengers}}. [[InfantryTypes|Infantry]] loaded inside of the unit are represented by the icon determined by {{f|Pip|link}}. Loaded vehicles are always represented by the sixth frame of ''pips2.shp''. If a loaded unit's {{f|Size}} is greater than 1, it will take up that many pips, with each pip beyond the first drawn using the fourth frame of ''pips2.shp''. The first frame is used to represent empty pips. |
| − | In {{Yr}} this can also be used to indicate units loaded into a [[BuildingType]] with {{f|UnitAbsorb|yes|link}}, {{f|InfantryAbsorb|yes|link}}, or both | + | In {{Yr}} this can also be used to indicate units loaded into a [[BuildingType|building]] with {{f|UnitAbsorb|yes|link}}, {{f|InfantryAbsorb|yes|link}}, or both. An absorbed vehicle is represented by the fifth frame of ''pips.shp'', while the fourth frame is used for infantry. In this case, the first frame of ''pips.shp'' is used to represent empty pips. It should be noted that this is not the flag used to display occupancy pips; see {{f|MaxNumberOccupants|link}} for that. |
===Ammo=== | ===Ammo=== | ||
| − | This can be used to display the current number of rounds loaded on a unit with {{f|Ammo|link}}. This is typically used for [[AircraftTypes]], but it will display properly for any [[TechnoType]]. | + | This can be used to display the current number of rounds loaded on a unit with {{f|Ammo|link}} set to a positive [[Help:Values#Integers|integer]] greater than 0. This is typically used for [[AircraftTypes|aircraft]], but it will display properly for any [[TechnoType]]. |
| − | In {{Ts}}, the seventh frame of ''pips2.shp'' is used to display the unit's current ammo supply. The engine will only draw up to five ammo pips individually. If the unit's total {{ | + | In {{Ts}}, the seventh frame of ''pips2.shp'' is used to display the unit's current ammo supply. The engine will only draw up to five ammo pips individually. If the unit's total {{f|Ammo}} is over five, each pip represents 20 percent. Nothing will be drawn to represent empty pips. |
| − | In {{Ra2}}, if {{f|PipWrap|0|link}}, the 14th frame of ''pips2.shp'' is used | + | In {{Ra2}}, if {{f|PipWrap|0|link}} (the default value), the 14th frame (15th frame in {{Yr}}) of ''pips2.shp'' is used, and an individual pip will be drawn for each ammo point. Nothing will be drawn to represent empty pips. |
| − | If {{ | + | If {{f|PipWrap}} is set to an integer greater than 0, a more [[PipWrap|specialized method of displaying ammo pips]] is used. |
===Tiberium=== | ===Tiberium=== | ||
| − | {{f|PipScale|Tiberium | + | {{f|PipScale|Tiberium}} is used to show the amount for harvested ore on [[VehicleTypes|vehicles]] with {{f|Harvester|yes|link}} or {{f|Weeder|yes|link}}, and {{f|Storage|link}} set to a positive [[Help:Values#Integers|integer]] greater than 0. Exactly five pips are rendered; each indicating 20 percent of {{f|Storage}}. The third frame of ''pips2.shp'' is used to represent stored ore in {{Ra2}}. In {{Ts}}, the second frame of ''pips2.shp'' is used for green [[Tiberium_(fictional_substance)|Tiberium]] and veins. For gems (or blue Tiberium in TS), the sixth frame of ''pips2.shp'' is used. The first frame of ''pips2.shp'' is always used to represent an empty pip. |
| − | In {{Yr}}, this is also used to display the current {{ | + | In {{Yr}}, this is also used to display the current {{f|Storage}} for infantry that can gather ore in an enslaved state. The pips are rendered in the same way as they are for vehicles, but only three are used instead; each indicating one third {{f|Storage}}. |
| − | In {{Ts}}, this is also used to display | + | In {{Ts}}, this is also used to display Tiberium storage for [[BuildingTypes|buildings]] such as refineries and silos. In this case, the second frame of ''pips.shp'' is used, while the first frame is used for empty pips. The [[engine]] will draw as many pips as it takes to span the selection box. |
===Charge=== | ===Charge=== | ||
| − | This should only used in {{Fs}} for VehicleTypes with {{f|IsMobileEMP|yes|link}} | + | This should only be used in {{Fs}} for [[VehicleTypes|vehicles]] with {{f|IsMobileEMP|yes|link}}. Exactly eight pips will be drawn; each representing 12.5 percent of {{f|MaxCharge|link}}. The second frame of ''pips2.shp'' is used for complete portions of the full charge, while the first frame is used for the incomplete portions. |
===MindControl=== | ===MindControl=== | ||
| − | This is only used in {{Yr}} to display the number of mind-controlled units for an | + | This is only used in {{Yr}} to display the number of mind-controlled units for an [[InfantryTypes|infantry]], [[VehicleTypes|vehicle]], or [[BuildingTypes|building]] with a [[weapon]] whose [[warhead]] has {{f|MindControl|yes|link}}. {{f|PipScale|MindControl|link}} will display a number of pips equal to {{f|Damage|link}} set on the mind control weapon. The second frame of ''pips2.shp'' (or ''pips.shp'' for buildings) is used to represent each mind-controlled unit, while the first frame (of the respective .shp file) is used for empty pips. |
| − | If the mind control weapon also has {{f|InfiniteMindControl|yes|link}} | + | If the mind control weapon also has {{f|InfiniteMindControl|yes|link}} and the controlling unit controls more units than it has pips, an additional pip will be drawn to represent "mind-control overload". This pip will use the fifth frame of ''pips2.shp'' (or ''pips.shp'' for buildings), but will briefly switch to the fourth frame (of the respective .shp file) each time the controlling unit takes damage specified by {{f|OverloadDamage|link}}. |
===Power=== | ===Power=== | ||
| − | Although this is value is parsed, it has no effect in either {{ts}} or {{ra2}}. | + | Although this is value is parsed, it has no effect in either {{ts}} or {{ra2}}. No pips will be displayed. |
==See also== | ==See also== | ||
* {{f|PipsDrawForAll|link}} | * {{f|PipsDrawForAll|link}} | ||
| − | * {{f| | + | * {{f|Passengers|link}} |
| + | * {{f|Ammo|link}} | ||
| + | * {{f|Storage|link}} | ||
Revision as of 06:50, 20 December 2009
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| Flag: | PipScale |
| File(s): | rules(md).ini |
| Values: | Strings: Normal text. (Limited to: hardcoded values↓) |
| Default: | none |
| Applicable to: | TechnoTypes:
AircraftTypes, BuildingTypes, InfantryTypes and VehicleTypes |
This flag is used to display a special type of graphical representation on certain units. This usually indicates a unit's current load of passengers, ammunition, or harvested ore. Each icon representing a portion of the load is referred to as a "pip".
Contents
Accepted values
All values are case-insensitive. Any other values will simply be ignored and the default used instead.
| Value | Game Availability | Remarks | |||
|---|---|---|---|---|---|
charge
|
|
For use with IsMobileEMP | |||
none
|
|
|
|
|
Default behavior—no pips are displayed |
passengers
|
|
|
|
|
For use with Passengers |
ammo
|
|
|
|
|
For use with Ammo |
tiberium
|
|
|
|
|
For use with Storage |
power
|
|
|
|
|
No effect—no pips are displayed |
mindcontrol
|
|
For use with units having weapons whose warheads have MindControl=yes | |||
Passengers
PipScale=Passengers is typically used for any vehicle with Passengers and SizeLimit each set to positive integers greater than or equal to the combined Size of its passengers, to show that there are units inside of it. The engine will always render a number of pips equal to Passengers. Infantry loaded inside of the unit are represented by the icon determined by Pip. Loaded vehicles are always represented by the sixth frame of pips2.shp. If a loaded unit's Size is greater than 1, it will take up that many pips, with each pip beyond the first drawn using the fourth frame of pips2.shp. The first frame is used to represent empty pips.
In Yuri's Revenge this can also be used to indicate units loaded into a building with UnitAbsorb=yes, InfantryAbsorb=yes, or both. An absorbed vehicle is represented by the fifth frame of pips.shp, while the fourth frame is used for infantry. In this case, the first frame of pips.shp is used to represent empty pips. It should be noted that this is not the flag used to display occupancy pips; see MaxNumberOccupants for that.
Ammo
This can be used to display the current number of rounds loaded on a unit with Ammo set to a positive integer greater than 0. This is typically used for aircraft, but it will display properly for any TechnoType.
In Tiberian Sun, the seventh frame of pips2.shp is used to display the unit's current ammo supply. The engine will only draw up to five ammo pips individually. If the unit's total Ammo is over five, each pip represents 20 percent. Nothing will be drawn to represent empty pips.
In Red Alert 2, if PipWrap=0 (the default value), the 14th frame (15th frame in Yuri's Revenge) of pips2.shp is used, and an individual pip will be drawn for each ammo point. Nothing will be drawn to represent empty pips.
If PipWrap is set to an integer greater than 0, a more specialized method of displaying ammo pips is used.
Tiberium
PipScale=Tiberium is used to show the amount for harvested ore on vehicles with Harvester=yes or Weeder=yes, and Storage set to a positive integer greater than 0. Exactly five pips are rendered; each indicating 20 percent of Storage. The third frame of pips2.shp is used to represent stored ore in Red Alert 2. In Tiberian Sun, the second frame of pips2.shp is used for green Tiberium and veins. For gems (or blue Tiberium in TS), the sixth frame of pips2.shp is used. The first frame of pips2.shp is always used to represent an empty pip.
In Yuri's Revenge, this is also used to display the current Storage for infantry that can gather ore in an enslaved state. The pips are rendered in the same way as they are for vehicles, but only three are used instead; each indicating one third Storage.
In Tiberian Sun, this is also used to display Tiberium storage for buildings such as refineries and silos. In this case, the second frame of pips.shp is used, while the first frame is used for empty pips. The engine will draw as many pips as it takes to span the selection box.
Charge
This should only be used in Firestorm for vehicles with IsMobileEMP=yes. Exactly eight pips will be drawn; each representing 12.5 percent of MaxCharge. The second frame of pips2.shp is used for complete portions of the full charge, while the first frame is used for the incomplete portions.
MindControl
This is only used in Yuri's Revenge to display the number of mind-controlled units for an infantry, vehicle, or building with a weapon whose warhead has MindControl=yes. PipScale=MindControl will display a number of pips equal to Damage set on the mind control weapon. The second frame of pips2.shp (or pips.shp for buildings) is used to represent each mind-controlled unit, while the first frame (of the respective .shp file) is used for empty pips.
If the mind control weapon also has InfiniteMindControl=yes and the controlling unit controls more units than it has pips, an additional pip will be drawn to represent "mind-control overload". This pip will use the fifth frame of pips2.shp (or pips.shp for buildings), but will briefly switch to the fourth frame (of the respective .shp file) each time the controlling unit takes damage specified by OverloadDamage.
Power
Although this is value is parsed, it has no effect in either Tiberian Sun or Red Alert 2. No pips will be displayed.
