Table of Contents

Class SeatConfig

Namespace
Vintagestory.API.Common
Assembly
VintagestoryAPI.dll

Seat properties Open in GitHub

[DocumentAsJson]
public class SeatConfig
Inheritance
SeatConfig

Fields

APName (Required)

Attachment point name

[DocumentAsJson("Required", "", false)]
public string APName

Field Value

string

SelectionBox (Required)

The name of attachment point of shape element that should be used as selection box for interactions with this seat

[DocumentAsJson("Required", "", false)]
public string SelectionBox

Field Value

string

Animation (Recommended) (Default: None)

Player's animation code that is used while seated

[DocumentAsJson("Recommended", "None", false)]
public string Animation { get; set; }

Field Value

string

AngleMode (Optional) (Default: FixateYaw)

How the mounted entity should rotate relative to the mount

[DocumentAsJson("Optional", "FixateYaw", false)]
public EnumMountAngleMode AngleMode

Field Value

EnumMountAngleMode

Attributes (Optional) (Default: None)

Miscallaneous attributes

[JsonProperty]
[JsonConverter(typeof(JsonAttributesConverter))]
[DocumentAsJson("Optional", "None", false)]
public JsonObject Attributes

Field Value

JsonObject

BodyYawLimit (Optional) (Default: None)

Optional maximum yaw rotation (in radians) that a player can turn to look to left or right (relative to their body) while seated.
If null, no yaw limit is applied.

The limit is applied relative to the seats mount rotation

[DocumentAsJson("Optional", "None", false)]
public float? BodyYawLimit

Field Value

float?

Controllable (Optional) (Default: False)

Can player in this seat control the mountable entity?

[DocumentAsJson("Optional", "False", false)]
public bool Controllable

Field Value

bool

EyeHeight (Optional) (Default: 1.5)

Overrides player's eye height while seated

[DocumentAsJson("Optional", "1.5", false)]
public float EyeHeight

Field Value

float

EyeOffsetX (Optional) (Default: 0)

Offset player's eye position while seated

[DocumentAsJson("Optional", "0", false)]
public float EyeOffsetX

Field Value

float

RiderOffset (Optional) (Default: 0, 0, 0,)

Offset of the mount point

[DocumentAsJson("Optional", "0, 0, 0,", false)]
public Vec3f RiderOffset

Field Value

Vec3f

MountOffset (Obsolete) (Default: None)

Obsolete. Offset of the mount point. Setting this triggers use of slightly incorrect math for backwards compatibility.

[Obsolete("Setting this triggers use of slightly incorrect math for backwards compatibility")]
[DocumentAsJson("Obsolete", "None", false)]
public Vec3f MountOffset

Field Value

Vec3f