In query mode, return type is based on queried flag.
Long name (short name) |
Argument types |
Properties |
-allowOverlap(-ao)
|
boolean
|
|
|
Sets the Heads-Up Display to be visible regardless of overlapping section
widths/limitations (see -s/section flag description for more details).
|
|
-block(-b)
|
int
|
|
|
Denotes the individual block that the HUD will reside in, within a
section. Each section is composed of a single column of blocks.
The total number of blocks contained within each section is variable.
The number of blocks that will be visible within each section is
dependent on the size of blocks contained in each section and the
current size of the window. Blocks begin enumerating from 0 and
flexibly increase based on need.
For HUD buttons, the format differs from that of the standard HUD.
The layout using parameters defined by the formatting flags listed
below (eg. justify, padding, buttonWidth) is shown below:
__________________________________
| | | | | |
| P | J | Button | J | P |
|_____|_____|__________|_____|_____|
P = Sub-block of width, padding
J = Justification of the entire block
Button = Sub-block of width, buttonWidth
Block Positioning
Blocks on the top section begin from the top edge of the main
viewport, while the bottom section begins from the bottom edge.
Blocks are dynamically removed from visibility from the midpoint
of the viewport. So, a relatively large block number will not
draw to the viewport.
Lastly, there can be at most one HUD occupying a block at any time.
Trying to position a HUD in an occupied block will result in an error.
Keep this in mind when positioning the HUD.
|
|
-blockAlignment(-ba)
|
string
|
|
|
Specifies the alignment of the block within its respective column. Available
alignments are: "center", "left" and "right". The default alignment is "left".
|
|
-blockSize(-bs)
|
string
|
|
|
Sets the height of each block. Available heights are: small, medium and large.
In pixel measurements, each corresponds to a 20, 35 or 50 pixel height, respectively.
|
|
-buttonShape(-bsh)
|
string
|
|
|
Specifies the shape of the button. Available button shapes are:
"rectangle" and "roundRectangle". The first will draw a rectangular
button, while the latter is a rectangle with rounded edges.
|
|
-buttonWidth(-bw)
|
int
|
|
|
Specifies the width of the button.
|
|
-label(-l)
|
string
|
|
|
Text label of the HUD button.
|
|
-labelFontSize(-lfs)
|
string
|
|
|
Sets the font size of the label. Available sizes are: small and large.
|
|
-padding(-p)
|
int
|
|
|
Specifies the width of both the left and right margins of a block. Default
value is 15 pixels.
|
|
-pressCommand(-pc)
|
script
|
|
|
Specifies the procedure or script to run during a mouse click event.
|
|
-releaseCommand(-rc)
|
script
|
|
|
Specifies the procedure or script to run during a mouse release event.
|
|
-section(-s)
|
int
|
|
|
Defines the section the HUD will appear in. There are 10 sections
divided across the screen. Five columns and two rows make up the
ten element matrix which divide the main viewport. Here is a visual
layout of the sections.
________________________
| | | | | |
| | | | | |
| 0 | 1 | 2 | 3 | 4 |
| | | | | |
|____|____|____|____|____|
| | | | | |
| | | | | |
| 5 | 6 | 7 | 8 | 9 |
| | | | | |
|____|____|____|____|____|
Each section is denoted by a number from 0 to 9 as illustrated above.
For example, if the second column of the top row was desired, the
section would be defined as: -sec 1
To prevent HUD objects from displaying over each other and causing a
clutter of letters, each row has a defined visibility precedence,
where each section would have a visibility priority level. Depending
on each priority level, when the screen space begins to shrink to
a point where the section widths of a given row begin to collide, the
HUD automatically compensates for this by removing the sections of
least priority. These sections are made invisible and a warning is
issued to inform the user of the removal. This continues until only
the section of highest priority remains.
For each row, the priorities are defined as follows. Using the top
row as an example: Section 0, has the highest priority, followed
by Section 4, making the outermost sections of highest priority.
Next in the list is Section 2, and lastly Sections 1 and 3 are of
the equal and least priority. This priority structure can be applied
to the bottom row as well. The two outermost sections have the highest
priority, followed by the middle section, and finally the remaining
two sections are of lowest priority.
This means that as the viewport gradually decreases in width
to the point where sections in the top row begin to overlap, sections
1 and 3 will be removed from view first, followed by section 2, and
finally section 4. A similar note is provided below for the block layout.
|
|
-visible(-vis)
|
boolean
|
|
|
Sets the visibility of the Heads-Up Display on and off.
|
|