SCORINFO: Difference between revisions

* '''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.

* '''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.

* '''DisableInGameMode''' - The scoreboard is disabled entirely in the listed game modes. This can be useful if modders prefer to design their own entire scoreboard via ACS. Refer to [[GAMEMODE]] for a list of all built-in game modes.

* '''DisableInGameType''' - If specified, the scoreboard is disabled in game modes that are of the following type: '''cooperative''', '''deathmatch''', or '''teamgame'''.

* '''DisableInEarnType''' - If specified, the scoreboard is disabled in game modes where players earn any of the following: '''kills''', '''frags''', '''points''', or '''wins'''.

     OverrideGap = <value [, <left | right>]

* The column's '''type''' can be one of the following:

** <code>Name</code> - The player's current name. This may also include player numbers and join queue positions. '''Every scoreboard must have this column or else Zandronum will throw a fatal error!'''

** <code>Index</code> - The player's index number, between 0-63.

** <code>Time</code> - How long the player has been in the current game, in minutes.

** <code>Ping</code> - The player's ping measured in milliseconds.

** <code>Frags</code> - The player's frag count.

** <code>Points</code> - The player's point count.

** <code>Wins</code> - The player's win count.

** <code>Kills</code> - The player's monster kill count.

** <code>Deaths</code> - The player's death count.

** <code>Assists</code> - How many times this player earned the "assist" medal.

** <code>Secrets</code> - How many secrets this player discovered.

** <code>Lives</code> - How many lives this player still has. '''This column is disabled if players are supposed to have only one life.'''

** <code>Rank</code> - The player's rank. This is not the same as the rank order on the scoreboard.

** <code>Spread</code> - The player's spread from whoever is first place.

** <code>Vote</code> - What decision this player made for the current vote, either "Yes", "No", or blank if they haven't voted yet. '''This column is disabled if there's no vote in progress.'''

** <code>Country</code> - The country that a player is connecting from.

** <code>Color</code> - The current colour that this player is using. This should not be confused with the <code>Color</code> data type used for custom columns.

** <code>StatusIcon</code> - A mini icon to indicate the status of the player (i.e. chatting, in console/menu, lagging, ready to go).

** <code>ScoreIcon</code> - The [https://zdoom.org/wiki/Actor_properties#Player.ScoreIcon ScoreIcon] of the player's class. '''This column is disabled if there are no defined players classes with score icons.'''

** <code>ArtifactIcon</code> - A mini icon for when a player is carrying a terminator sphere, possession hellstone, the white flag, or another team's item. '''This column is disabled in game modes that don't use these items.'''

** <code>BotSkillIcon</code> - A mini icon to indicate the skill level of a bot. '''This column is disabled if there are no bots in the game.'''

* '''DisplayName''' - Determines what will be used in the column's header. If this property isn't specified, then the display name will use the same text as its type instead.

* '''ShortName''' - A shorter or abbreviated version of the column's display name, used if the scoreboard is too wide to fit on the user's screen and needs to be shrunken down as much as possible. If unspecified, the display name will always be used.

* '''Alignment''' - Determines how the contents of the column are aligned, and can be one of the following: '''left''', '''center''', or '''right'''. By default, the column is aligned to the left.

* '''Width''' - The maximum width of the column, in pixels. In case the scoreboard is too wide and needs to be shrunken down, this column could be narrower than what's specified.

* '''OverrideGap''' - This overrides the value of '''ColumnGap''' from the scoreboard block to control the amount of spacing from the column that comes from the left or right of this one.

* '''Flags''' - Can be one of the following:

** <code>REVERSEORDER</code> - Sorts players in reverse (i.e. from least to greatest).

** <code>INTERMISSIONONLY</code> - This column only appears on the intermission screen.

** <code>NOINTERMISSION</code> - This column won't appear on the intermission screen.

** <code>NOSPECTATORS</code> - Don't draw values on rows for true spectators.

** <code>OFFLINEONLY</code> - This column only appears in offline games.

** <code>ONLINEONLY</code> - This column only appears in online games.

** <code>HIDDENBYDEFAULT</code> - Don't show this column at the start of the game.

** <code>DONTSHOWHEADER</code> - Prevents this column's header from being shown.

** <code>DONTRESETONLEVELCHANGE</code> - This column's values won't be reset to their default when the level changes. '''This only works on custom columns.'''

* '''GameMode''' - A list of game modes where this column is active. By default, columns are active in all game modes. Refer to [[GAMEMODE]] for a list of all built-in game modes.

* '''GameType''' - If specified, this column is active in game modes that are of the following type: '''cooperative''', '''deathmatch''', or '''teamgame'''.

* '''EarnType''' - If specified, this column is active in game modes where players earn any of the following: '''kills''', '''frags''', '''points''', or '''wins'''.

===Other Properties===

* '''RequiresTeams''' - This column is only active in game modes that support teams (e.g. TDM, TLMS, CTF).

* '''RequiresNoTeams''' - This column is disabled in game modes that support teams.

* '''RequiresLives''' - This column is only active in game modes where players have lives (e.g. Survival, LMS, TLMS).

* '''RequiresNoLives''' - This column is disabled in game modes that use lives.

* '''RequiresTeamItem''' - This column is only active in game modes where a team's item is used (e.g. CTF or Skulltag).

* '''RequiresNoTeamItem''' - This column is disabled in game modes that use team items.

* A column's '''data type''' can be one of the following:

** <code>Int</code> - Draws the column contents as an integer.

** <code>Bool</code> - Treats the column as a boolean and draws two different strings depending on the value:

*** '''TrueText''' - What's shown if the value is 1. By default, this is "true".

*** '''FalseText''' - What's shown if the value is 0. By default, this is "false".

** <code>Float</code> - Draws the column's contents as a float or fixed-point number.

** <code>String</code> - Draws the column's contents as text.

** <code>Color</code> - Draws the column with a single hexadecimal colour. A rectangular box is filled inside the column:

*** '''ClipRectWidth''' - The width of the box where the colour is drawn. If zero or unspecified, then it's the same as the column's width.

*** '''ClipRectHeight''' - The height of the box where the colour is drawn. If zero or unspecified, then it's the same as the row height.

** <code>Texture</code>: Draws the column with a graphic or texture. The name of the graphic must be entered as a string.

*** '''ClipRectWidth''' - The maximum width of the image that will be drawn, from the left-side of the image. If zero or unspecified, then there's no cut-off width.

*** '''ClipRectHeight''' - The maximum height of the image that will be drawn, from the top-side of the image. If zero or unspecified, then it's the same as the row height.

* '''DefaultValue''' - The default value of this column at the start of a new game.

* '''TeamValueMethod''' - Determines how the value of this column ('''only works for int and float types''') on a team's header is determined:

** <code>None</code> - The value will not be drawn on any team header. This is the default behaviour of all custom columns.

** <code>Sum</code> - Calculates the total value of all players on the team.

** <code>Average</code> - Calculates the average value of all players on the team.

** <code>Median</code> - Uses the middle value of all players on the team, from least to greatest.

** <code>Mode</code> - Uses the most common value of all players on the team.

** <code>Max</code> - Uses the player's value that is the highest on their team.

** <code>Min</code> - Uses the player's value that is the lowest on their team.

** <code>Custom</code> - The modder is responsible for updating the team's value on their own via [[SetColumnValue]] in ACS.

* '''Length''' - This has different implications depending on the data type:

** <code>Int</code> - Limits the number of digits that are shown. This means that a number like 255 will appear as "99" if only two digits are allowed.

** <code>Float</code> - Limits the number of decimals that are shown. This means that a number like 3.14159 will appear as "3.14" if only two decimals are allowed.

** <code>Bool</code> and <code>String</code> - Limits the number of characters. Longer messages are truncated with an ellipsis at the end.

</pre>

* 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.

{| class="wikitable" border="2" width="100%"

! Command <!-- Command name -->

! Default

! Description <!-- What does the command do? -->

|style="text-align:center" | Bool

|style="text-align:center" | false

|style="text-align:center" | Bool

|style="text-align:center" | false

|style="text-align:center" | Float

|style="text-align:center" | 0.9

|style="text-align:center" | Float

|style="text-align:center" | 0.9

|The maximum width of the scoreboard as a percentage of the screen's width.  

|style="text-align:center" | Float

|style="text-align:center" | 1.0

* <code>[[CheckColumnStatus]]</code>

* <code>[[CheckScoreboardStatus]]</code>

* <code>[[GetColumnType]]</code>

* <code>[[GetColumnValue]]</code>

* <code>[[SetColumnValue]]</code>

* <code>[[SetColumnVisibility]]</code>

* <code>[[SetScoreboardVisibility]]</code>