Skip to content

Commit

Permalink
Document scoreboard-filter
Browse files Browse the repository at this point in the history
Signed-off-by: Patrick <cowinkkeydinkinc@gmail.com>
  • Loading branch information
CoWinkKeyDinkInc committed Jul 26, 2024
1 parent 8ee0874 commit 600db7d
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/modules/objectives/control-points.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ Other uses of control points include unlocking an area of the map using objectiv
| `show-sidebar` | Displays the control point on scoreboard. | <span className="badge badge--primary">true/false</span> | true |
| `stats` | Determines if this control point counts as a win condition. | <span className="badge badge--primary">true/false</span> | true |
| `show` | Specify if the control point should be hidden from all visible locations to the player. These locations include chat, the boss bar, and the scoreboard.<br />**Note:** This attribute sets all five values above to true/false. | <span className="badge badge--primary">true/false</span> | true |
| `scoreboard-filter` | Determines when the objective should be displayed on the scoreboard. | [Dynamic Filter](/docs/modules/mechanics/filters#dynamic-filters) | |
| `visual-materials` | Filter the materials modified when updating the progress regions.<br />*Defaults to wool, carpet, stained clay, stained glass & stained glass panes.* | [Block Filter](/docs/modules/mechanics/filters) |
| `capture` | <span className="badge badge--secondary" title="Can be either this attribute or a sub-element.">Property</span><span className="badge badge--danger">Required</span>The region where players must stand to capture this control point. | [Region](/docs/modules/mechanics/regions) |
| `progress` | <span className="badge badge--secondary" title="Can be either this attribute or a sub-element.">Property</span>The region where colored blocks within this area point will progressively fade into the controlling team's color.<br />**Note:** This can be controlled with `visual-materials`. | [Bounded Region](/docs/modules/mechanics/regions) |
Expand Down
1 change: 1 addition & 0 deletions docs/modules/objectives/ctw.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ The victory monument's area, where the wool block is placed, is protected by def
| `show-sidebar` | Displays the wool on scoreboard. | <span className="badge badge--primary">true/false</span> | true |
| `stats` | Determines if this wool counts as a win condition. | <span className="badge badge--primary">true/false</span> | true |
| `show` | Specify if the wool should be hidden from all visible locations to the player. These locations include chat, the boss bar, and the scoreboard.<br />**Note:** This attribute sets all five values above to true/false. | <span className="badge badge--primary">true/false</span> |
| `scoreboard-filter` | Determines when the objective should be displayed on the scoreboard. | [Dynamic Filter](/docs/modules/mechanics/filters#dynamic-filters) | |
| `location` | <span className="badge badge--danger" title="Required after proto 1.3.4">Required</span>Location where the wool can be found at, used to determine proximity. | <span className="badge badge--primary">X,Y,Z</span> |
| `wool-proximity-metric` | Metric used to determine proximity to the wool. | `player`<br />`closest block`<br />`closest kill`<br />`none` | `closest kill` |
| `wool-proximity-horizontal` | Only calculate horizontal distance for wool proximity. | <span className="badge badge--primary">true/false</span> | false |
Expand Down
1 change: 1 addition & 0 deletions docs/modules/objectives/dtc.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ This can also be avoided by keeping the lava far away enough from the core and n
| `show-sidebar` | Displays the core on scoreboard. | <span className="badge badge--primary">true/false</span> | true |
| `stats` | Determines if this core counts as a win condition. | <span className="badge badge--primary">true/false</span> | true |
| `show` | Specify if the core should be hidden from all visible locations to the player. These locations include chat, the boss bar, and the scoreboard.<br />**Note:** This attribute sets all five values above to true/false. | <span className="badge badge--primary">true/false</span> | true |
| `scoreboard-filter` | Determines when the objective should be displayed on the scoreboard. | [Dynamic Filter](/docs/modules/mechanics/filters#dynamic-filters) | |
| `proximity-metric` | Metric used to determine proximity to the core.<br />Accepts `closest player`, `closest block`, `closest kill`, or `none`. | <span className="badge badge--primary">Proximity Metric</span> | `closest player` |
| `proximity-horizontal` | Only calculate horizontal distance for core proximity. | <span className="badge badge--primary">true/false</span> | false |
</div>
Expand Down
1 change: 1 addition & 0 deletions docs/modules/objectives/dtm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ For example, if the monument is obsidian and completion is set to 100%, then all
| `show-sidebar` | Displays the monument on scoreboard. | <span className="badge badge--primary">true/false</span> | true |
| `stats` | Determines if this monument counts as a win condition. | <span className="badge badge--primary">true/false</span> | true |
| `show` | Specify if the monument should be hidden from all visible locations to the player. These locations include chat, the boss bar, and the scoreboard.<br />**Note:** This attribute sets all five values above to true/false. | <span className="badge badge--primary">true/false</span> | true |
| `scoreboard-filter` | Determines when the objective should be displayed on the scoreboard. | [Dynamic Filter](/docs/modules/mechanics/filters#dynamic-filters) | |
| `proximity-metric` | Metric used to determine proximity to the destroyable.<br />Accepts `closest player`, `closest block`, `closest kill`, or `none`. | <span className="badge badge--primary">Proximity Metric</span> | `closest player` |
| `proximity-horizontal` | Only calculate horizontal distance for destroyable proximity. | <span className="badge badge--primary">true/false</span> | false |
</div>
Expand Down

0 comments on commit 600db7d

Please sign in to comment.