Table of Contents

Class EntityBehaviorRideable

Namespace
Vintagestory.GameContent
Assembly
VSSurvivalMod.dll

Allows to ride an entity.
Requires EntityBehaviorSelectionBoxes, EntityBehaviorGait, Vintagestory.GameContent.EntityBehaviorTaskAI and optionally EntityBehaviorAttachable.
Uses the "rideable" code Open in GitHub

[DocumentAsJson]
[AddDocumentationProperty("saddleBreaksRequired", "How many saddle breaks are required before entity can be ridden", "Vintagestory.API.MathTools.NatFloat", "Optional", "None", true)]
[AddDocumentationProperty("controlScheme", "Use this on a collectible type. Overrides control scheme for when entity is ridden", "System.String", "Recommended", "None", true)]
public class EntityBehaviorRideable : EntityBehaviorSeatable
Inheritance
EntityBehaviorSeatable
EntityBehaviorRideable

Examples

"behaviors": [
 {
  "code": "rideable",
  "saddleBreakGait": "sprint",
  "saddleBreaksRequired": { "avg": 20, "var": 5 },
  "saddleBreakDayInterval": 1,
  "tamedEntityCode": "tameddeer-{type}-{gender}-{age}"
 }
]
"behaviors": [
 {
  "code": "rideable",
  "interactMountAnySeat": true,
  "seats": [{ "apName": "Rider", "selectionBox": "MidAP", "bodyYawLimit": 1.83, "controllable": true, "mountOffset": { "x": -0.05, "y": -0.69, "z": 0 }, "eyeOffsetX": -0.37 }],
  "rideableGaitOrder": ["walkback", "idle", "walk", "sprint"],
  "controls": {
      "walkback": {
          "moveSpeedMultiplier": 1,
          "animation": "walkback",
          "animationSpeed": 2.7,
          "weight": 10,
          "easeInSpeed": 1,
          "easeOutSpeed": 3,
          "blendMode": "Average",
          "riderAnim": {
              "animation": "rideelk-walk",
              "animationSpeed": 1,
              "weight": 1,
              "withFpVariant": true,
              "blendMode": "Average",
              "elementWeight": {
                  "LowerTorso": 80,
                  "UpperTorso": 80,
                  "UpperFootR": 80,
                  "UpperFootL": 80,
                  "LowerFootR": 80,
                  "LowerFootL": 80
              },
              "elementBlendMode": {
                  "LowerTorso": "Average",
                  "UpperTorso": "Average",
                  "UpperFootR": "Average",
                  "UpperFootL": "Average",
                  "LowerFootR": "Average",
                  "LowerFootL": "Average"
              }
          }
      },
    ...
  }
 }
]

Fields

saddleBreakDayInterval (Optional) (Default: 0)

How many in-game days must pass between saddle break attempts

[DocumentAsJson("Optional", "0", false)]
protected float saddleBreakDayInterval

Field Value

float

tamedEntityCode (Optional) (Default: None)

The entity code of the tamed version of this entity

[DocumentAsJson("Optional", "None", false)]
protected string? tamedEntityCode

Field Value

string

Properties

controlScheme (Recommended) (Default: None)

Use this on a collectible type. Overrides control scheme for when entity is ridden

Property Value

string

saddleBreaksRequired (Optional) (Default: None)

How many saddle breaks are required before entity can be ridden

Property Value

NatFloat