Sprinkler

/CustomCrops/contents/sprinklers/__SPRINKLER__.yml

Let take sprinkler_1 as an example to configure the sprinkler settings

Unique Identifier for Your Sprinkler: Start by naming your sprinkler under a unique identifier like sprinkler_1. This makes it easy to reference and customize later on.

Specify the Type of Sprinkler: The type parameter defines the sprinkler as FURNITURE, distinguishing it from block-based types and allowing for more flexibility in placement.

# The type of sprinkler (BLOCK or FURNITURE)
type: FURNITURE

Choose a Sprinkling Pattern and Set Range: Decide how your sprinkler sprinkles! The working-mode allows you to set the pattern:

• 1 for a square pattern

• 2 for a rhombus pattern (currently selected)

• 3 for a circular pattern This adds a creative twist to your watering strategy!

# Sprinkling pattern mode:
# 1 = square, 2 = rhombus, 3 = circle
working-mode: 2

The range parameter specifies the reach of the sprinkler. In this example, a range of 1 covers a compact area:

# Sprinkler's working range:
# □■□
# ■▼■
# □■□
range: 1

mode 1

mode 2

mode 3

Set Water Storage Capacity: The storage parameter determines how much water your sprinkler can hold—4 in this case. This limits how long the sprinkler can operate before needing a refill.

# Maximum capacity for storing water
storage: 4

Decide on Unlimited or Limited Water Supply: With infinite set to false, the sprinkler has a finite water supply. If you want a limitless sprinkler, change this to true!

# Indicates whether the sprinkler has unlimited water supply
infinite: false

Control Water Usage Per Operation: The water and sprinkling parameters dictate how much water is added to a pot and how much is consumed per sprinkling cycle, both set to 1 here for balanced watering.

# The amount of water added to pot per sprinkling operation
water: 1
# The amount of water consumed per sprinkling operation
sprinkling: 1

Visual Representation of Your Sprinkler: Use 3D-item and 3D-item-with-water to define how the sprinkler looks in both dry and watered states. This visual cue enhances the gameplay experience by reflecting the sprinkler’s status.

# 3D model identifier for the sprinkler
3D-item: sprinkler_1 # without water
3D-item-with-water: sprinkler_1 # with water

Optional 2D Model: The 2D-item is an optional parameter for those who prefer a simpler visual representation or when using 2D views in certain scenarios.

# Optional 2D item model identifier
2D-item: sprinkler_1_item

Whitelist for Planting Pots: Ensure your sprinkler only works in specified pots by adding them to pot-whitelist. The example allows the default pot type.

# List of allowed planting pots where the sprinkler can function
pot-whitelist:
  - default

Define Refilling Methods: Under fill-method, you can get creative with how the sprinkler is refilled. For instance, using a WATER_BUCKET returns an empty BUCKET, and adds 3 units of water, while using a POTION returns a GLASS_BOTTLE and adds 1 unit.

# Methods available for refilling the sprinkler's water supply
fill-method:
  # Custom refill method 1 configuration
  method_1:
    # Item used for refilling
    item: WATER_BUCKET
    # Item returned after refilling (optional)
    return: BUCKET
    # Amount of water added by this method
    amount: 3
  # Custom refill method 2 configuration
  method_2:
    item: POTION
    return: GLASS_BOTTLE
    amount: 1

Customize the Water Level Display: The water-bar section lets you create a unique visual representation of the water level with symbols. Adjust these characters to match your game's style or preferences.

# Configuration for the water level display bar
water-bar:
  left: '뀂'   # Left end of the water bar
  full: '뀁뀃' # Full segment of the water bar
  empty: '뀁뀄' # Empty segment of the water bar
  right: '뀁뀅' # Right end of the water bar

Set Up Events: Under events, you can configure how the sprinkler responds to different player actions. Available events: break/place/interact/work/add_water/full/reach_limit

# Event settings for various interactions and actions
events:
  place:
    # Action performed when placing the sprinkler
    swing_hand_action:
      type: swing-hand
      value: true
    # Sound effect triggered when placing the sprinkler
    sound_action:
      type: sound
      value:
        source: player
        key: minecraft:block.bone_block.place
        volume: 1
        pitch: 1
  interact:
    # Conditional action executed on interaction
    force_work_action:
      type: conditional
      value:
        conditions:
          requirement_1:
            type: sneak
            value: true
        actions:
          action_1:
            type: force-tick
    # Hologram display action upon interaction
    hologram_action:
      type: hologram
      value:
        text: '<font:customcrops:default>{water_bar}</font>'
        duration: 40
        x: 0.5
        y: -0.3
        z: 0.5
        visible-to-all: false
  work:
    # Visual effect displayed when the sprinkler is working
    fake_item_action:
      type: fake-item
      value:
        item: water_effect
        duration: 100
        x: 0.5
        y: 0.4
        z: 0.5
        visible-to-all: true
  add_water:
    # Particle effect shown when adding water
    particle_action:
      type: particle
      value:
        particle: WATER_SPLASH
        x: 0.5
        y: 0.7
        z: 0.5
        count: 5
    # Sound effect played when adding water
    sound_action:
      type: sound
      value:
        key: "minecraft:item.bucket.empty"
        source: 'player'
        volume: 1
        pitch: 1

Set Up Requirements: Under requirements, you can configure the conditions player have to meet before using the sprinkler. Available events: break/place/use

requirements:
  use: {}
  place: {}
  break:
    requirement_1:
      type: permission
      value: xxx.xxx