SCORINFO: Difference between revisions
m
no edit summary
m (More edits.) |
mNo edit summary |
||
| Line 13: | Line 13: | ||
=Scoreboard Commands= | =Scoreboard Commands= | ||
* '''ClearColumns''' - Deletes any and all previously defined columns. '''At least one column must be defined afterwards or else Zandronum will throw a fatal error!''' | * '''ClearColumns''' - Deletes any and all previously defined columns. '''At least one column must be defined afterwards or else Zandronum will throw a fatal error!''' | ||
* '''RemoveColumn''' - Deletes a single column, if defined, by '''type''' for standard columns or '''name''' for custom columns. | * '''RemoveColumn''' - Deletes a single column, if defined, by '''type''' for standard columns, or '''name''' for custom or composite columns. | ||
<pre> | <pre> | ||
| Line 115: | Line 115: | ||
** <code>EXCLUDEUNLISTEDCOLUMNS</code> - If a '''ColumnOrder''' list is defined, then any columns not included in the list aren't put on the right of the scoreboard. | ** <code>EXCLUDEUNLISTEDCOLUMNS</code> - If a '''ColumnOrder''' list is defined, then any columns not included in the list aren't put on the right of the scoreboard. | ||
** <code>SHOWGAPSINBACKGROUND</code> - Shows the gaps between columns on the row's background. | ** <code>SHOWGAPSINBACKGROUND</code> - Shows the gaps between columns on the row's background. | ||
* '''ColumnOrder''' - By default, columns are ordered from left to right on the scoreboard in the same order that they're defined in. This means that columns defined first will be on the left, while columns defined last will be on the right. If this command is used, the user can decide how exactly they would like to order the columns. Any defined columns missing from this list are put on the right unless <code>EXCLUDEUNLISTEDCOLUMNS</code> is enabled. Columns should be entered in by '''type''' for standard columns, or '''name''' for custom columns. | * '''ColumnOrder''' - By default, columns are ordered from left to right on the scoreboard in the same order that they're defined in. This means that columns defined first will be on the left, while columns defined last will be on the right. If this command is used, the user can decide how exactly they would like to order the columns. Any defined columns missing from this list are put on the right unless <code>EXCLUDEUNLISTEDCOLUMNS</code> is enabled. Columns should be entered in by '''type''' for standard columns, or '''name''' for custom or composite columns. Any columns defined inside a composite column cannot be used here. | ||
* '''RankOrder''' - This decides how players will be sorted. Columns entered first have the highest priority over those entered last. If no rank order is specified, players can only be sorted by their number. Columns should be entered in by '''type''' for standard columns, or '''name''' for custom columns. | * '''RankOrder''' - This decides how players will be sorted. Columns entered first have the highest priority over those entered last. If no rank order is specified, players can only be sorted by their number. Columns should be entered in by '''type''' for standard columns, or '''name''' for custom columns. | ||
* '''AddToRankOrder''' - Adds one single column to the end of the rank order list. Columns should be entered in by '''type''' for standard columns, or '''name''' for custom columns. | * '''AddToRankOrder''' - Adds one single column to the end of the rank order list. Columns should be entered in by '''type''' for standard columns, or '''name''' for custom columns. | ||
| Line 244: | Line 244: | ||
Composite columns can be used when multiple columns, whether standard or custom, must appear under a single '''DisplayName''' or '''ShortName'''. For example, a player's <code>Name</code>, <code>Color</code>, or <code>StatusIcon</code> are typically grouped together and would look nicer if they're all placed under a single "Name" header. Therefore, a composite column would be useful here. | Composite columns can be used when multiple columns, whether standard or custom, must appear under a single '''DisplayName''' or '''ShortName'''. For example, a player's <code>Name</code>, <code>Color</code>, or <code>StatusIcon</code> are typically grouped together and would look nicer if they're all placed under a single "Name" header. Therefore, a composite column would be useful here. | ||
<pre> | <pre> | ||
CompositeColumn | CompositeColumn <name> | ||
{ | { | ||
DisplayName = <string> | DisplayName = <string> | ||
ShortName = <string> | ShortName = <string> | ||
Alignment = <value> | Alignment = <value> | ||
ColumnOrder = <column1> [, column2 [, ...]] | |||
Column "Type1" | Column "Type1" | ||
{ | { | ||
... | |||
} | } | ||
Column "Type2" | Column "Type2" | ||
{ | { | ||
... | |||
} | } | ||
CustomColumn "Type3" | CustomColumn "Type3" | ||
{ | { | ||
... | |||
} | } | ||
} | } | ||
</pre> | </pre> | ||
When a column is defined inside a composite column block, its own '''DisplayName''' or '''ShortName''' are never used, instead replaced by what the composite column uses. | * The '''name''' is what's used to reference the composite column, similar to custom columns. | ||
* When a column is defined inside a composite column block, its own '''DisplayName''' or '''ShortName''' are never used, but instead replaced by what the composite column uses. | |||
* '''Alignment''' controls the alignment of the header text on the composite column, but the individual columns still control the alignment of their own contents. | |||
* '''ColumnOrder''' controls the order of the columns from left to right. Only columns defined inside the composite column block can be used in the order. | |||
=Console Variables= | =Console Variables= | ||