Region Definition
Protection region definition
Champs
| Champ | Type | Par défaut | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
artifact | Ref<RegionArtifactEntry> | — | Primary artifact storing runtime data for this region | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
priority | Int | 0 | Priority applied when regions overlap (higher wins) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
owners | List<String> | empty | UUIDs of players allowed to manage the region | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
members | List<String> | empty | UUIDs of players allowed to interact inside the region | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
groups | List<Ref<GroupEntry>> | empty | Groups synchronized with the region | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
parentRegion | Ref<RegionDefinitionEntry> | — | Optional parent region used for inheritance | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
flags | List<FlagBinding> | empty | Flags applied to the region
|
| Champ | Type | Par défaut | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
key | RegionFlagKey | BUILD | —Valeurs :BUILDBLOCK_BREAKBLOCK_PLACEUSEINTERACTPVPMOB_DAMAGEMOB_SPAWNINGCREEPER_EXPLOSIONTNTFIRE_SPREADLIGHTNINGENDERMAN_GRIEFGHAST_FIREBALLLAVA_FIRELAVA_FLOWWATER_FLOWICE_MELTSNOW_MELTLEAF_DECAYGRASS_GROWTHVINE_GROWTHENTITY_PAINTING_DESTROYVEHICLE_PLACEVEHICLE_DESTROYENDER_PEARLPOTION_SPLASHEXP_DROPSITEM_PICKUPITEM_DROPENTRYEXITENTRY_ACTIONEXIT_ACTIONPASS_THROUGHINVINCIBLEFALL_DAMAGEHUNGERHEAL_AMOUNTHEAL_DELAYHEAL_MINHEAL_MAXTELEPORTBLOCKED_EFFECTSFLYWALK_SPEEDFLY_SPEEDKEEP_INVENTORYKEEP_EXPCHAT_PREFIXCHAT_SUFFIXGODMODEFROSTWALKERNETHER_PORTALSGLIDECHUNK_UNLOADITEM_DURABILITYJOIN_LOCATIONENTRY_MIN_LEVELENTRY_MAX_LEVEL | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
value | FlagValue | — | —Variantes :flag_value_actionsflag_value_boolflag_value_colorflag_value_doubleflag_value_intflag_value_listflag_value_locationflag_value_soundflag_value_text
|
| Champ | Type | Par défaut | Description |
|---|---|---|---|
actions | List<Ref<ActionEntry>> | empty | — |
flag_value_bool (1)
| Champ | Type | Par défaut | Description |
|---|---|---|---|
enabled | Boolean | true | — |
flag_value_color (1)
| Champ | Type | Par défaut | Description |
|---|---|---|---|
hex | String | #FFFFFF | — |
flag_value_double (1)
| Champ | Type | Par défaut | Description |
|---|---|---|---|
value | Double | 0.0 | — |
flag_value_int (1)
| Champ | Type | Par défaut | Description |
|---|---|---|---|
value | Int | 0 | — |
flag_value_list (1)
| Champ | Type | Par défaut | Description |
|---|---|---|---|
entries | List<String> | empty | — |
flag_value_location (1)
| Champ | Type | Par défaut | Description |
|---|---|---|---|
position | Position | ORIGIN | — |
flag_value_sound (3)
| Champ | Type | Par défaut | Description |
|---|---|---|---|
sound | String | minecraft:block.note_block.pling | — |
volume | Float | 1.0 | — |
pitch | Float | 1.0 | — |
flag_value_text (1)
| Champ | Type | Par défaut | Description |
|---|---|---|---|
content | String | — | — |
bluemapSettingsRegionBlueMapDisplaySettingsRegionBlueMapDisplaySettings (14)
| Champ | Type | Par défaut | Description |
|---|---|---|---|
enabled | Boolean | false | Enable BlueMap integration for this region |
markerSetId | String | protection_regions | Marker set id for grouping regions on BlueMap. Regions with the same set id are grouped together. |
markerSetLabel | String | Protection Regions | Label for the marker set (only used when creating a new marker set) |
markerSetToggleable | Boolean | true | Whether the marker set can be toggled on/off in the BlueMap UI |
markerSetDefaultHidden | Boolean | false | Whether the marker set is hidden by default in the BlueMap UI |
shapeType | BlueMapShapeType | EXTRUDE | Marker shape type: EXTRUDE (3D) or SHAPE (flat)Valeurs :EXTRUDESHAPE |
lineColor | String | #FF0000 | Line color for the region border (CSS color format: #RRGGBB or #AARRGGBB) |
fillColor | String | #FF000040 | Fill color for the region area (CSS color format: #RRGGBB or #AARRGGBB) |
lineWidth | Int | 2 | Line width in pixels for the region border |
depthTestEnabled | Boolean | true | Enable depth test (hide marker when behind terrain) |
minY | Double | -64.0 | Minimum Y height for extruded markers |
maxY | Double | 320.0 | Maximum Y height for extruded markers |
labelTemplate | String | {name} | Label template for the marker. Placeholders: {name}, {id}, {priority} |
sorting | Int | 0 | Sorting order for this marker within its set (lower = first) |
How to use it
A region exists as soon as its definition is published. The shape comes from the linked artifact: without an artifact, or before you apply a selection, the region covers nothing.
priorityorders overlapping regions: higher first. A child with priority0takes the priority of its parent.ownersandmembersare player UUIDs. They, and players withtypewriter.protection.bypass, ignore every flag of the region.parentRegionlets the region inherit flags, owners and members of another region. Circular parents are ignored with a warning in the log.flagsis a list of key and value pairs. Booleans set to false deny the action. Several keys are not enforced: see the Flags section of the extension page.groupsis stored for information (placeholders) and is not used for enforcement.bluemapSettingsdraws the region on BlueMap whenenabledis on.