minecraft-bedrock-json-schemas/source/behavior/entities/format/components/rideable.json

{
  "$id": "blockception.minecraft.behavior.entities.minecraft.rideable",
  "description": "Determines whether this entity can be ridden. Allows specifying the different seat positions and amount.",
  "type": "object",
  "title": "Rideable",
  "additionalProperties": false,
  "definitions": {
    "seats_spec": {
      "additionalProperties": false,
      "type": "object",
      "properties": {
        "dismount_mode": {
          "title": "Dismount Mode",
          "description": "Defines where riders are placed when dismounting this entity:\n- \"default\", riders are placed on a valid ground position around the entity, or at the center of the entity's collision box if none is found.\n- \"on_top_center\", riders are placed at the center of the top of the entity's collision box.",
          "type": "string",
          "enum": ["default", "on_top_center"]
        },
        "on_rider_enter_event": {
          "title": "On Rider Enter Event",
          "description": "Event to execute on the owner entity when an entity starts riding it.",
          "type": "string"
        },
        "on_rider_exit_event": {
          "title": "On Rider Exit Event",
          "description": "Event to execute on the owner entity when an entity stops riding it.",
          "type": "string"
        },
        "third_person_camera_radius": {
          "title": "Third Person Camera Radius",
          "description": "Can be used to set a different camera radius when in third person or third person front camera. Value 0.0 is ignored.",
          "type": "number",
          "default": 0.0,
          "minimum": 0.0,
          "maximum": 64.0
        },
        "camera_relax_distance_smoothing": {
          "title": "Camera Relax Distance Smoothing",
          "description": "Adds springiness to the camera movement when the camera moves back to its radius after being pushed closer to the player by and obstacle. A higher value means a stiffer spring. Value 0.0 is ignored.",
          "type": "number",
          "default": 0.0,
          "minimum": 0.0,
          "maximum": 32.0
        },
        "lock_rider_rotation": {
          "type": "number",
          "default": 181,
          "description": "Angle in degrees that a rider is allowed to rotate while riding this entity. Omit this property for no limit",
          "title": "Lock Rider Rotation"
        },
        "max_rider_count": {
          "type": "integer",
          "default": 0,
          "description": "Defines the maximum number of riders that can be riding this entity for this seat to be valid.",
          "title": "Max Rider Count"
        },
        "min_rider_count": {
          "type": "integer",
          "default": 0,
          "description": "Defines the minimum number of riders that need to be riding this entity before this seat can be used.",
          "title": "Min Rider Count"
        },
        "position": {
          "$ref": "../../../../general/vectors/number3.json",
          "default": [0.0, 0.0, 0.0],
          "description": "Position of this seat relative to this entity's position.",
          "title": "Position"
        },
        "rotate_rider_by": {
          "$ref": "../../../../molang/number.json",
          "description": "Offset to rotate riders by.",
          "title": "Rotate Rider By"
        }
      }
    }
  },
  "properties": {
    "controlling_seat": {
      "type": "integer",
      "default": 0,
      "description": "The seat that designates the driver of the entity. Entities with the \"minecraft:behavior.controlled_by_player\" goal ignore this field and give control to any player in any seat.",
      "title": "Controlling Seat"
    },
    "crouching_skip_interact": {
      "type": "boolean",
      "default": true,
      "description": "If true, this entity can't be interacted with if the entity interacting with it is crouching.",
      "title": "Crouching Skip Interact"
    },
    "family_types": {
      "title": "Family Types",
      "description": "List of entities that can ride this entity.",
      "type": "array",
      "items": {
        "type": "string",
        "title": "Family Type"
      }
    },
    "interact_text": {
      "type": "string",
      "default": "",
      "description": "The text to display when the player can interact with the entity when playing with Touch-screen controls.",
      "title": "Interact Text"
    },
    "passenger_max_width": {
      "title": "Passenger Max Width",
      "description": "The max width a mob can have to be a rider. A value of 0 ignores this parameter.",
      "type": "number",
      "default": 0.0
    },
    "pull_in_entities": {
      "type": "boolean",
      "default": false,
      "description": "If true, this entity will pull in entities that are in the correct family_types into any available seats.",
      "title": "Pull In Entities"
    },
    "rider_can_interact": {
      "type": "boolean",
      "default": false,
      "description": "If true, this entity will be picked when looked at by the rider.",
      "title": "Rider Can Interact"
    },
    "seat_count": {
      "type": "integer",
      "default": 1,
      "description": "The number of entities that can ride this entity at the same time.",
      "title": "Seat Count"
    },
    "seats": {
      "description": "The list of positions and number of riders for each position for entities riding this entity.",
      "title": "Seats",
      "oneOf": [
        {
          "type": "object",
          "$ref": "#/definitions/seats_spec"
        },
        {
          "type": "array",
          "items": {
            "$ref": "#/definitions/seats_spec"
          }
        }
      ]
    }
  },
  "examples": [
    {
      "controlling_seat": 0,
      "crouching_skip_interact": true,
      "family_types": [],
      "interact_text": "",
      "pull_in_entities": false,
      "rider_can_interact": false,
      "seat_count": 1
    }
  ]
}