Struct NpcDefinition 

#[non_exhaustive]
pub struct NpcDefinition {
    pub sprite_id: u8,
    pub x: u8,
    pub y: u8,
    pub movement: NpcMovementType,
    pub wander_axis: NpcWanderAxis,
    pub facing: Direction,
    pub range: u8,
    pub text_id: u8,
}

Definition of an NPC placed on the map (static data from map objects).

This is a generic NPC definition with no game-specific fields. Game-specific data (e.g., trainer flags, item drops) should be stored in a separate struct alongside this one.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

sprite_id: u8

Sprite ID (index into sprite table).

x: u8

Starting position.

y: u8

movement: NpcMovementType

Movement type.

wander_axis: NpcWanderAxis

Axis restriction for Wander NPCs (classic movement byte 2). Ignored for other movement types.

facing: Direction

Facing direction.

range: u8

Range of movement (0 = stationary).

text_id: u8

Text ID triggered on interaction.

Implementations

impl NpcDefinition

pub fn new( sprite_id: u8, x: u8, y: u8, movement: NpcMovementType, facing: Direction, range: u8, text_id: u8, ) -> Self

Create a new NPC definition.

Examples found in repository

examples/hello_dotzuki.rs (lines 521-529)

fn build_town_map() -> MapData<MapId, Tileset, ()> {
    let blocks: Vec<u8> = vec![
        0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x01, 0x01, 0x01, 0xFF, 0xFF, 0x01, 0x01, 0x01, 0xFF,
        0xFF, 0x01, 0x01, 0x01, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
    ];
    let npcs = vec![NpcDefinition::new(
        0,
        2,
        2,
        NpcMovementType::Stationary,
        Direction::Down,
        0,
        0,
    )];
    MapData::new(
        MapId(0),
        5,
        5,
        Tileset(0),
        (),
        blocks,
        vec![],
        npcs,
        vec![],
        MapConnections::default(),
    )
}

pub fn new_with_axis( sprite_id: u8, x: u8, y: u8, movement: NpcMovementType, wander_axis: NpcWanderAxis, facing: Direction, range: u8, text_id: u8, ) -> Self

Create a new NPC definition with an explicit Wander axis (the classic GB “movement byte 2”). Only meaningful for NpcMovementType::Wander.

Trait Implementations

impl Clone for NpcDefinition

fn clone(&self) -> NpcDefinition

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NpcDefinition

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NpcDefinition

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for NpcDefinition

impl PartialEq for NpcDefinition

fn eq(&self, other: &NpcDefinition) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for NpcDefinition

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for NpcDefinition