SBARINFO

From ZDoom Wiki
Jump to: navigation, search

SBARINFO allows for custom status bars to be made without the need for ACS. Only the last SBARINFO lump will be read. If there is a need for more than one SBARINFO lump another can be included with the #include function. (#include syntax is identical to DECORATE.)

The syntax requires that all image names be in quotes. When something must have no image, for example the "off" sprite in a weapon indicator when you don't have that weapon, you can specify "" for "no image, leave it blank (unless otherwise noted)". The string "nullimage" can also be used for this. Note: an empty image cannot currently be used in place of the "default" argument of DrawMugShot.

Mugshot scripting may be used with the default Doom status bar. To do so, you simply need not to define any status bars.

Where flags are specified the pipe operator ("|") can be used instead of commas. Boolean values must be written as true or false.

Top-level commands

Commmand Description
Base <game> Sets the status bar to the specified game. As of right now the resulting status bar can not be modified. Valid games are Doom, Heretic, Hexen, Strife, and None.
CompleteBorder <bool> If true, continues drawing the border where the status bar is normally placed. Using this will remove the HOM. If false, the border is not drawn behind the status bar.
CreatePopup Sets the transition effect for the specified popup (log, keys, or status).
Height <height> Sets the height of the status bar. When set you will be expected to cover all the area between points (0, 200-height) and (320, 200). If the area is not covered, a HOM will be drawn instead.

Note: If fullscreenoffsets is used, then Height will not perform correctly and will end up too tall in most cases. They should not be used together.

InterpolateHealth <bool> [, <speed>] Interpolates the value drawn for health. This is useful for drawing life bars so that the gem will smoothly move between positions like in Heretic and Hexen. Speed is by default set to 8 which is the same as used for Heretic (Hexen used 6). Speed is measured in hp per tic.
InterpolateArmor <bool> [, <speed>] Similar to InterpolateHealth, interpolates the value drawn for armor. Speed is set to 8 by default.
LowerHealthCap <bool> Sets whether health should go no lower than 0. Default is true.
MonospaceFonts <bool>, <character>[, <alignment>] Monospaces all fonts to the specified character of their font. Alignment changes the position of off size characters within their spacing. Valid arguments are left (default), center, or right.
Resolution <x>, <y> Sets the base resolution for the status bar. By default this is 320x200.
StatusBar Begins the drawing routine for the specified status bar.

Status bar commands

The following commands must be placed after a StatusBar command.

Commmand Description
Alpha <amount> Increases the translucency for the following sub block.
AspectRatio <ratio> Executes the following sub block only if the player is using the specified aspect ratio. Ratio can be "4:3", "5:4", "16:9", or "16:10".
DrawBar Draws a Hexen-style bar with a length proportional to a value.
DrawGem Draws a Heretic-style life or armor gem.
DrawKeyBar Draws the inventory icon of all the keys the player is holding.
DrawInventoryBar Draws an inventory bar.
DrawImage Draws an image to the screen at the specified coordinates.
DrawMugShot Draws a mug shot.
DrawNumber Draws a number corresponding to a special value.
DrawSelectedInventory Draws the currently selected inventory item.
DrawShader Draws a transparency gradient.
DrawString Draws a text string.
DrawSwitchableImage Conditionally draws an image.
Else Executes the following sub-block if the previous was not executed.
GameMode <gamemode> [, ...] Executes the following sub block only if the user is playing one of the specified game modes. Valid game modes are singleplayer, cooperative, deathmatch, and teamgame.
HasWeaponPiece <weapon>, <piecenum> Executes the following sub block if the player is holding the specified piece for the specified weapon.
IfHealth Executes the following sub block if the player's health is greater than or equal to (or less than) the specified value. (development version 27ebfa7 only)
InInventory Executes the following sub block if the specified item or items are (or not) in the players inventory.
InventoryBarNotVisible Executes the following sub block if the player does not have the inventory bar active.
IsSelected [not] <weapon1> [, <weapon2>] Executes the following sub block only if the player is (not) using one of the two specified weapons.
PlayerClass <classname> [, <classname2> [, <classname3>]] Executes the following sub block only if the player is one of the specified classes (represented by their display name).
PlayerType <classname> [, <classname2> [, <classname3>]] Executes the following sub block only if the player is one of the specified classes (represented by their actor class name). Unlike 'PlayerClass' this command is capable of handling inheritance so it also gets executed if the current player class is a subclass of one of the passed class names.
UsesAmmo [not] Checks if the current weapon uses an ammo type (either primary or secondary). If so it will execute the sub block. Adding "not" will invert the result.
UsesSecondaryAmmo [not] Checks if the current weapon has a secondary ammo type. If so it will execute the sub block. Adding "not" will invert the result.
WeaponAmmo [not] <ammo1> [{&& | ||} <ammo2>] Executes the sub block only if the weapon uses the specified ammo (be it primary or secondary). If ammo2 is specified then the result will depend on the operator. If "&&" is used then both ammo types must match one or the other. If "||" is used then only one ammo type must match. If the weapon does not use any ammo then it will always evaluate to true. The "not" inverses the result.

Mug shots

The mug shot can be scripted with a series of states. A list of states with a special purpose is given below:

Normal
The default face when starting.
Pain
When the player has been damaged.
Ouch
Shown instead of pain when the player loses more than 20 hit points at once.
Rampage
Shown when the player holds down one of the fire buttons.
Grin
Weapon pickup face.
Death
Normal death.
XDeath
Extreme death, this state must be enabled by a drawmugshot flag.
God
Standard Invulnerability.
GodAnimated
Invulnerability when "animatedgodmode" is set.

In addition you can also create pain, ouch, death, and xdeath states for any custom damage types that may be in use. The syntax for that is "State.DamageType".

mugshot "StateName"[, flags, ...]
{
	frame duration;
	// OR
	{frame1[, ...]} duration;
}

Each frame may be 5 letters long (proper prefix will be added later) and may have a duration of -1 (infinite) or any positive number (except for 0). In addition you can list frame names in braces to have SBarInfo pick a random graphic from those named. Every frame must end in a semi-colon.

Now there are some flags (listed after the state name) that you can use to change how SBarInfo reads the frames. They are as follows:

health
Makes the last character of every frame represent the health level. It works by adding the level to the character specified in the definition so you may use any style you want as long as the characters are consecutive (ST0A, ST0B, ST0C, etc would be fine as long as you specify ST0A in SBARINFO).
health2
Same as health except it applies the effect to the second character from the end.
healthspecial
Applies health to the middle frame and health2 to all other frames.
directional
Changes the meaning of frames in braces. Instead of picking a random frame it will pick one of three frames like so: {left, middle, right}. This is only useful for the pain or ouch states which calculate the direction of damage. Otherwise only the middle will be shown.

SBARINFO does support custom states of any name which can be called by the ACS function SetMugShotState.

Examples

An example of mug shot definitions:

mugshot "Normal", health2
{
	{ST00, ST01, ST02} 17;
}

Finally, an example of using the 'fullscreenoffsets' statusbar flag:

Statusbar FullScreen, FullScreenOffsets
{
	//Bottom Left
	//Lives from Inventory with Icon
	DrawImage "LIFEA0", 14, -1;
	DrawNumber 1, CONFONT, WHITE, Life, 35, -10;

	//Top Right
	//Keys
	DrawKeyBar 2, vertical, 13, -8, 0;

	//Bottom Right
	//Points Variable from Global Array 0, index PlayerNumber()
	DrawNumber 8, CONFONT, WHITE, GlobalArray 0 , -2, -25;

	//Ammo and Icon
	DrawImage AmmoIcon1, -105, -1;
	DrawNumber 2, CONFONT, WHITE, Ammo1, -80, -10;

	//Health and Icon
	DrawImage "HLTHE0", -50, -1;
	DrawNumber 3, CONFONT, WHITE, Health, -2, -10;
}

See also