Skip to content

Commit

Permalink
Remove sub-elements property tables (#144)
Browse files Browse the repository at this point in the history
Signed-off-by: Pear <20259871+TheRealPear@users.noreply.github.com>
  • Loading branch information
TheRealPear authored Nov 24, 2024
1 parent 2fce5c8 commit d891c50
Show file tree
Hide file tree
Showing 19 changed files with 20 additions and 157 deletions.
30 changes: 7 additions & 23 deletions docs/modules/blocks/blockdrops.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,23 +33,15 @@ Blocks broken by means other than mining or explosions currently do not cause cu
| `wrong-tool` | <span className="badge badge--secondary" title="Can be either this attribute or a sub-element.">Property</span>Drop items regardless of what tool was used to mine the block. | <span className="badge badge--primary">true/false</span> | false |
| `punch` | <span className="badge badge--secondary" title="Can be either this attribute or a sub-element.">Property</span>Check this rule when a block is punched. | <span className="badge badge--primary">true/false</span> | false |
| `trample` | <span className="badge badge--secondary" title="Can be either this attribute or a sub-element.">Property</span>Check this rule when a block is walked on. | <span className="badge badge--primary">true/false</span> | false |
| `fall-chance` | <span className="badge badge--secondary" title="Can be either this attribute or a sub-element.">Property</span>The percentage of blocks that will change to falling blocks when exploded. | <span className="badge badge--primary">0 - 1.0</span> |
| `land-chance` | <span className="badge badge--secondary" title="Can be either this attribute or a sub-element.">Property</span>The percentage of falling blocks that will change back to real blocks when they land. | <span className="badge badge--primary">0 - 1.0</span> |
| `fall-speed` | <span className="badge badge--secondary" title="Can be either this attribute or a sub-element.">Property</span>A multiplier for the velocity of the blocks flying out from a explosion. | <span className="badge badge--primary">Number</span> |

#### Rule Sub-elements

| Element | Description | Value/Children | Default |
|---|---|---|---|
| `<filter>` | <span className="badge badge--secondary" title="Can be either this attribute or a sub-element.">Property</span>Filter what blocks get modified by this rule. | [Filters](/docs/modules/mechanics/filters) |
| `<region>` | <span className="badge badge--secondary" title="Can be either this attribute or a sub-element.">Property</span>The region this rule applies to. | [Regions](/docs/modules/mechanics/regions) |
| `<kit>` | <span className="badge badge--secondary" title="Can be either this attribute or a sub-element.">Property</span>The kit to give players when this rule applies. | [Kits](/docs/modules/gear/kits) |
| `<drops>` | The items which get dropped when a matching block is mined. | [Items](/docs/modules/gear/items)| |
| `<experience>` | <span className="badge badge--secondary" title="Can be either this attribute or a sub-element.">Property</span>The amount of XP that gets dropped. | <span className="badge badge--primary">Number</span> |
| `<replacement>` | <span className="badge badge--secondary" title="Can be either this attribute or a sub-element.">Property</span>What to replace the mined block with. | [Single Material Pattern](/docs/reference/items/inventory#material-matchers) | <span className="badge badge--secondary">Air</span> |
| `<wrong-tool>` | <span className="badge badge--secondary" title="Can be either this attribute or a sub-element.">Property</span>Drop items regardless of what tool was used to mine the block. | <span className="badge badge--primary">true/false</span> | false |
| `<punch>` | <span className="badge badge--secondary" title="Can be either this attribute or a sub-element.">Property</span>Check this rule when a player in adventure mode punches a block. | <span className="badge badge--primary">true/false</span> | false |
| `<trample>` | <span className="badge badge--secondary" title="Can be either this attribute or a sub-element.">Property</span>Check this rule when a block is walked on. | <span className="badge badge--primary">true/false</span> | false |
| `<fall-chance>` | <span className="badge badge--secondary" title="Can be either this attribute or a sub-element.">Property</span>The percentage of blocks that will change to falling blocks when exploded. | <span className="badge badge--primary">0 - 1.0</span> |
| `<land-chance>` | <span className="badge badge--secondary" title="Can be either this attribute or a sub-element.">Property</span>The percentage of falling blocks that will change back to real blocks when they land. | <span className="badge badge--primary">0 - 1.0</span> |
| `<fall-speed>` | <span className="badge badge--secondary" title="Can be either this attribute or a sub-element.">Property</span>A multiplier for the velocity of the blocks flying out from a explosion. | <span className="badge badge--primary">Number</span> |
| Element | Description | Value/Children |
|---|---|---|
| `<drops>` | The items which get dropped when a matching block is mined. | [Items](/docs/modules/gear/items)|

#### Block Drops Item Attributes

Expand All @@ -69,7 +61,7 @@ This value can range from 0 to 1, a chance of 0.5 would mean that the item will
By default, custom drops will not appear if a block is mined with the "wrong" tool, e.g., stone mined with a shovel.
If `wrong-tool` is set to true, the custom drops will happen regardless of what tool was used.

### Examples
## Examples

```xml
<block-drops>
Expand Down Expand Up @@ -181,14 +173,6 @@ Additionally the `<sprinting/>`, `<walking/>`, and `<crouching/>` filters used i

The behavior for blocks that become airborne due to explosions can be modified in addition to all the other drop rules.

#### Rule Sub-elements

| Element | Description | Value/Children |
|---|---|---|
| `<fall-chance>` | <span className="badge badge--secondary" title="Can be either this sub-element or an attribute.">Property</span>The percentage of blocks that will change to falling blocks when exploded. | <span className="badge badge--primary">0 - 1.0</span> |
| `<land-chance>` | <span className="badge badge--secondary" title="Can be either this sub-element or an attribute.">Property</span>The percentage of falling blocks that will change back to real blocks when they land. | <span className="badge badge--primary">0 - 1.0</span> |
| `<fall-speed>` | <span className="badge badge--secondary" title="Can be either this sub-element or an attribute.">Property</span>A multiplier for the velocity of the blocks flying out from a explosion. | <span className="badge badge--primary">Number</span> |

```xml
<block-drops>
<rule>
Expand Down
10 changes: 1 addition & 9 deletions docs/modules/blocks/falling-blocks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,18 +25,10 @@ Entire structures can then be built from those blocks, and they will not collaps

| Attribute | Description | Value | Default |
|---|---|---|---|
| `filter` | <span className="badge badge--secondary" title="Can be either this attribute or a sub-element.">Property</span><span className="badge badge--danger">Required</span>Filter what blocks get modified by this rule. | [Block Filter](/docs/modules/mechanics/filters) |
| `filter` | <span className="badge badge--secondary" title="Can be either this attribute or a sub-element.">Property</span><span className="badge badge--danger">Required</span>Filter what blocks get modified by this rule.<br />*Also accepts regions to limit the rule to a certain area.* | [Block Filter](/docs/modules/mechanics/filters) &amp;<br />[Regions](/docs/modules/mechanics/regions) |
| `sticky` | <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 blocks that are sticky. | [Block Filter](/docs/modules/mechanics/filters) |
| `delay` | <span className="badge badge--secondary" title="Can be either this attribute or a sub-element.">Property</span>Tick delay until blocks start to fall after they have been disturbed. | <span className="badge badge--primary">Number</span> | 2 |

#### Rule Sub-elements

| Element | Description | Value/Children | Default |
|---|---|---|---|
| `<filter>` | <span className="badge badge--secondary" title="Can be either this attribute or a sub-element.">Property</span><span className="badge badge--danger">Required</span>Filter what blocks get modified by this rule.<br />*Also accepts regions to limit the rule to a certain area.* | [Block Filters](/docs/modules/mechanics/filters) &amp;<br />[Regions](/docs/modules/mechanics/regions) |
| `<sticky>` | <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 blocks that are sticky. | [Block Filter](/docs/modules/mechanics/filters) |
| `<delay>` | <span className="badge badge--secondary" title="Can be either this attribute or a sub-element.">Property</span>Tick delay till blocks start to fall after they have been disturbed. | <span className="badge badge--primary">Number</span> | 2 |

### Examples

```xml
Expand Down
9 changes: 0 additions & 9 deletions docs/modules/blocks/renewables.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,6 @@ If neither are specified, the renewable affects all blocks in the world.
| `sound` | Play block restore sound effects. | <span className="badge badge--primary">true/false</span> | true |
| `avoid-players` | Prevent blocks from being restored within a specific number of distance from any player. | <span className="badge badge--primary">block</span> | 2 |

#### Renewable Sub-elements

| Element | Description | Value/Children |
|---|---|---|
| `<region>` | <span className="badge badge--secondary" title="Can be either this attribute or a sub-element.">Property</span>The region the renewable applies to. | [Bounded Regions](/docs/modules/mechanics/regions) |
| `<renew-filter>` | <span className="badge badge--secondary" title="Can be either this attribute or a sub-element.">Property</span>Filter which blocks are renewed. | [Filters](/docs/modules/mechanics/filters) |
| `<replace-filter>` | <span className="badge badge--secondary" title="Can be either this attribute or a sub-element.">Property</span>Filter which blocks are replaced. | [Filters](/docs/modules/mechanics/filters) |
| `<shuffle-filter>` | <span className="badge badge--secondary" title="Can be either this attribute or a sub-element.">Property</span>Filter which blocks are shuffled. | [Filters](/docs/modules/mechanics/filters) |

### Examples

By default, all blocks in the region are renewable.
Expand Down
6 changes: 0 additions & 6 deletions docs/modules/environment/border.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,6 @@ Attributes for multiple world borders can be applied for all borders by specifyi
| `warning-distance` | Specify the block distance to the border before showing a red vignette to players. | <span className="badge badge--primary">Number</span> | 5 |
| `warning-time` | Show red vignette to players when the border is moving and will reach them within the specified time. | [Time Period](/docs/reference/misc/time-periods) | 15s |

##### World Border Sub-elements

| Element | Description | Value/Children |
|---|---|---|
| `<when>` | <span className="badge badge--secondary" title="Can be either this attribute or a sub-element.">Property</span>Filter when this world border is in effect. | [Filters](/docs/modules/mechanics/filters) |

### Examples

```xml
Expand Down
4 changes: 0 additions & 4 deletions docs/modules/environment/mobs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,6 @@ Mob spawns can also be filtered against any other filter type, including regions
|---|---|---|
| `filter` | <span className="badge badge--secondary" title="Can be either this sub-element or an attribute.">Property</span><span className="badge badge--danger">Required</span>Filter what mobs can spawn when and where. | [Filters](/docs/modules/mechanics/filters) |

| Sub-elements |||
|---|---|---|
| `<filter> </filter>` | <span className="badge badge--secondary" title="Can be either this sub-element or an attribute.">Property</span><span className="badge badge--danger">Required</span>Filter what mobs can spawn when and where. | [Filters](/docs/modules/mechanics/filters) |

##### Mob Spawning Filter Matchers

| Element | Description | Value |
Expand Down
4 changes: 0 additions & 4 deletions docs/modules/gear/kill-rewards.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,6 @@ Then, once they have collected enough ingots, they can craft armor, purchase ite
| Element | Description | Value/Children |
|---|---|---|
| `<item>` | Individual items given as a kill reward. | [Item](/docs/modules/gear/items) |
| `<filter>` | <span className="badge badge--secondary" title="Can be either this sub-element or an attribute.">Property</span>Filter who can claim this reward and when. | [Filter](/docs/modules/mechanics/filters) |
| `<kit>` | <span className="badge badge--secondary" title="Can be either this sub-element or an attribute.">Property</span>The kit to give players as the kill reward. | [Kit](/docs/modules/gear/kits) |
| `<action>` | <span className="badge badge--secondary" title="Can be either this sub-element or an attribute.">Property</span>The action to run as the kill reward. | [Action](/docs/modules/mechanics/actions-triggers) |
| `<victim-action>` | <span className="badge badge--secondary" title="Can be either this sub-element or an attribute.">Property</span>The action to run on the victim. | [Action](/docs/modules/mechanics/actions-triggers) |

## Examples

Expand Down
9 changes: 0 additions & 9 deletions docs/modules/gear/pickups.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,6 @@ A `<point>` region does not return a randomized position but can still be used t
| `effects` | Show the pickup's particle effects. | <span className="badge badge--primary">true/false</span> | true |
| `sounds` | Play the pickup's sound effects. | <span className="badge badge--primary">true/false</span> | true |

##### Pickup Sub-elements

| Element | Description | Value | Default |
|---|---|---|---|
| `<spawn-filter>` | <span className="badge badge--secondary" title="Can be either this sub-element or an attribute.">Property</span>Filter if this pickup is and can be spawned. | [Filters](/docs/modules/mechanics/filters) | `always` |
| `<pickup-filter>` | <span className="badge badge--secondary" title="Can be either this sub-element or an attribute.">Property</span>Filter who can pick up the pickup's kit. | [Filters](/docs/modules/mechanics/filters) | `always` |
| `<region>` | <span className="badge badge--secondary" title="Can be either this sub-element or an attribute.">Property</span><span className="badge badge--danger">Required</span>The region where this pickup is placed into. | [Randomize-able Regions](/docs/modules/mechanics/regions) |
| `<kit>` | <span className="badge badge--secondary" title="Can be either this sub-element or an attribute.">Property</span>The kit to give to players who pick up this pickup. | [Kits](/docs/modules/gear/kits) |

### Examples

```xml
Expand Down
9 changes: 1 addition & 8 deletions docs/modules/gear/projectiles.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,18 +29,11 @@ or the item form of the custom projectile itself.
| `damage` | The amount of damage this projectile deals. | <span className="badge badge--primary">Half-hearts</span> | 0.0 |
| `velocity` | The speed at which the projectile moves. | <span className="badge badge--primary">Meters/tick</span> | 1.0 |
| `click` | The click action that fires the projectile. | `right`,<br />`left`,<br />or `both` | `both` |
| `effects` | The potion effects to apply to players hit by this projectile. | [Potion Effect](/docs/modules/gear/potions) |
| `effect` | The potion effects to apply to players hit by this projectile. | [Potion Effect](/docs/modules/gear/potions) |
| `destroy-filter` | <span className="badge badge--secondary" title="Can be this attribute or a sub-element.">Property</span>Filter if/what blocks get destroyed when hit with this projectile. | [Filter](/docs/modules/mechanics/filters) | `never` |
| `cooldown` | The minimum time between each firing of this projectile. | [Time Period](/docs/reference/misc/time-periods) |
| `precise` | Whether the path of a thrown projectile should be precise in hitting a target.<br />*This is only applicable if the projectile is `Fireball`, `LargeFireball`, `SmallFireball`, or `WitherSkull`.* | <span className="badge badge--primary">true/false</span> | true |

##### Projectile Sub-elements

| Element | Description | Value/Children |
|---|---|---|
| `<destroy-filter>` | <span className="badge badge--secondary" title="Can be this sub-element or an attribute.">Property</span>Filter if/what blocks get destroyed when hit with this projectile. | [Filters](/docs/modules/mechanics/filters) |
| `<effect>` | A potion effect to apply to players hit by this projectile. | [Potion Effects](/docs/modules/gear/potions) |

```xml
<!-- Create the projectile "lazer" -->
<projectiles>
Expand Down
6 changes: 0 additions & 6 deletions docs/modules/information/broadcasts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,6 @@ It should not be used for generic server-related messages.
| `count` | Amount of times the message is repeated.<br />*Infinite repetition can be specified by using `oo` as the duration.* | <span className="badge badge--primary">Number</span> |
| `filter` | <span className="badge badge--secondary" title="Can be either this attribute or a sub-element.">Property</span>Filter if the broadcast message should be sent after the duration has passed, or if it is skipped. | [Filter](/docs/modules/mechanics/filters) |

##### Message Tag Sub-elements

| Element | Description | Value |
|---|---|---|
| `<filter>` | <span className="badge badge--secondary" title="Can be either this attribute or a sub-element.">Property</span>Filter if the broadcast message should be sent after the duration has passed, or if it is skipped. | [Filters](/docs/modules/mechanics/filters) |

### Examples

```xml
Expand Down
Loading

0 comments on commit d891c50

Please sign in to comment.