Skip to content
game-platform

PlayerProps

Defined in: packages/engine/src/components/Player.tsx:55

The body fields are hers at spawn: the physics cuts her capsule to them and climbs and slides by them.

Extends

Section titled “Extends”

Properties

Section titled “Properties”
Property Type Default value Description Overrides
avatar? VrmBody undefined The body she wears, over a model or a primitive when none is named. Every avatar plays the same clips. -
children? HeroOverlay undefined Drawn inside her model, so it follows her: a game’s bar over her head. -
climb? number 50 The steepest ground in degrees it climbs and stands on: on anything steeper it slides down. -
collides? readonly CollisionLayer[] every layer The layers its sweeps and contacts test against: every one unless a game narrows it. A chaser’s default leaves out the players and the other walkers; a game lists Players again for a body that blocks her. -
color? ColorRepresentation blue The colour of her primitive. -
facing? number 0 Radians about y at spawn; zero is the rest direction. -
footsteps? readonly string[] undefined Files, ?url imports, one played at random each stride she walks. -
health? object { current: 100, maximum: 100 } Her health at spawn: full unless a save says otherwise. -
health.current number undefined - -
health.maximum number undefined - -
height? number 1.4 Metres above the feet the head stands. Never her model’s. Partial.height
marker? DestinationMarkerShape DestinationMarkerShape.Ring What marks the ground where a walk ends: a ring, a pillar of light, or nothing. -
model? string undefined The name of a registered model she wears, static, when no avatar is named. It plays no clips. -
movement? Partial<{ acceleration: number; deceleration: number; jumpHeight: number; maximumTurnSeconds: number; speed: number; standingShare: number; standTurnRate: number; turnAngle: number; turnInPlace: boolean; turnRate: number; }> undefined Her movement settings, each laid over the preset’s. -
position? Position [0, 0, 0] Where the player spawns. The first step stands the player on the ground. -
preset? "responsive" | "realistic" | MovementPreset MovementPreset.Responsive The movement settings she starts from: responsive unless named. Its value’s text too, so preset="realistic" reads as the enum does. -
radius? number 0.35 Metres from the axis to the side. Never her model’s. Partial.radius
shape? BodyShape ColliderShape.Capsule The primitive she wears when neither an avatar nor a model is named. -
step? number 0.6 Metres a surface may stand above or below the feet and still be stood on, kerb or wall. -