Struct rscache::def::osrs::NpcDefinition

pub struct NpcDefinition {
    pub id: u16,
    pub name: String,
    pub model_data: NpcModelData,
    pub animation_data: NpcAnimationData,
    pub size: usize,
    pub actions: [String; 5],
    pub visible_on_minimap: bool,
    pub combat_level: Option<u16>,
    pub configs: Vec<u16>,
    pub varbit_id: Option<u16>,
    pub varp_index: Option<u16>,
    pub interactable: bool,
    pub pet: bool,
    pub params: HashMap<u32, String>,
}

Contains all the information about a certain npc fetched from the cache through the NpcLoader.

The NpcModelData and the NpcAnimationData were hidden in the documents because these are rarely accessed, they contain useless information in most use-cases.

Fields

id: u16

name: String

model_data: NpcModelData

animation_data: NpcAnimationData

size: usize

actions: [String; 5]

visible_on_minimap: bool

combat_level: Option<u16>

configs: Vec<u16>

varbit_id: Option<u16>

varp_index: Option<u16>

interactable: bool

pet: bool

params: HashMap<u32, String>

Trait Implementations

impl Clone for NpcDefinition

fn clone(&self) -> NpcDefinition

Returns a copy 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 Default for NpcDefinition

fn default() -> NpcDefinition

Returns the "default value" for a type.

impl Definition for NpcDefinition

fn new(id: u16, buffer: &[u8]) -> Result<Self>

impl Eq for NpcDefinition

impl Loader<NpcDefinition> for NpcLoader

fn new<S: Store>(cache: &Cache<S>) -> Result<NpcLoader>

fn load(&self, id: u16) -> Option<&NpcDefinition>

impl PartialEq<NpcDefinition> for NpcDefinition

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for NpcDefinition

impl StructuralPartialEq for NpcDefinition