Struct Page 

pub struct Page { /* private fields */ }

An event page containing most of the event state.

Each event page describes the behaviour of the event, its appearance and the scripts that it runs as a collection of Command.

Implementations

impl Page

pub fn parse(bytes: &[u8]) -> (usize, Self)

Parse raw bytes into a single Page struct.

Use of this method is highly discouraged unless you know exactly what you are doing. Prefer using Map::parse and then extract what you want from the structure tree.

Panics

This function will panic if the given bytes do not represent a valid page structure.

This might be caused by unaligned bytes, corrupt files, incompatible format updates and library bugs. If you are confident you are doing everything right, feel free to report an issue on GitHub.

pub fn icon(&self) -> &str

The filename of the icon sprite sheet used by this page.

pub fn icon_mut(&mut self) -> &mut String

Mutable reference accessor for Page::icon.

pub fn icon_row(&self) -> u8

The row of the selected icon in the selected sprite sheet.

pub fn icon_row_mut(&mut self) -> &mut u8

Mutable reference accessor for Page::icon_row.

pub fn icon_column(&self) -> u8

The column of the selected icon in the selected sprite sheet.

pub fn icon_column_mut(&mut self) -> &mut u8

Mutable reference accessor for Page::icon_column.

pub fn icon_opacity(&self) -> u8

The opacity the icon should have when rendered.

pub fn icon_opacity_mut(&mut self) -> &mut u8

Mutable reference accessor for Page::icon_opacity.

pub fn icon_blend(&self) -> &BlendType

The blend method used for painting the icon onto the background.

pub fn icon_blend_mut(&mut self) -> &mut BlendType

Mutable reference accessor for Page::icon_blend.

pub fn event_trigger(&self) -> &EventTrigger

The condition by which the event is triggered.

pub fn event_trigger_mut(&mut self) -> &mut EventTrigger

Mutable reference accessor for Page::event_trigger.

pub fn conditions(&self) -> &[Condition; 4]

The conditions that must be mut for the script to run.

pub fn conditions_mut(&mut self) -> &mut [Condition; 4]

Mutable reference accessor for Page::conditions.

pub fn animation_speed(&self) -> u8

The speed at which the event’s animation advance.

pub fn animation_speed_mut(&mut self) -> &mut u8

Mutable reference accessor for Page::animation_speed.

pub fn move_speed(&self) -> u8

The speed at which the event moves.

pub fn move_speed_mut(&mut self) -> &mut u8

Mutable reference accessor for Page::move_speed.

pub fn move_frequency(&self) -> u8

The frequency at which the event moves.

pub fn move_frequency_mut(&mut self) -> &mut u8

Mutable reference accessor for Page::move_frequency.

pub fn move_route(&self) -> &MoveRoute

How (and whether) the event should move.

pub fn move_route_mut(&mut self) -> &mut MoveRoute

Mutable reference accessor for Page::move_route.

pub fn options(&self) -> &Options

A set of options that influence the event rendering and behaviour.

pub fn options_mut(&mut self) -> &mut Options

Mutable reference accessor for Page::options.

pub fn moves(&self) -> &Vec<Move>

The pattern the event follows when moving.

This field is only valid if Page::move_route is MoveRoute::Custom, otherwise it’s empty.

pub fn moves_mut(&mut self) -> &mut Vec<Move>

Mutable reference accessor for Page::moves.

pub fn commands(&self) -> &Vec<Command>

The event script, in the form of a Command collection.

pub fn commands_mut(&mut self) -> &mut Vec<Command>

Mutable reference accessor for Page::commands.

pub fn shadow_graphic(&self) -> u8

The graphic to use for the shadow, if shadow graphics are enabled.

pub fn shadow_graphic_mut(&mut self) -> &mut u8

Mutable reference accessor for Page::shadow_graphic.

pub fn range_extension_x(&self) -> u8

How much the trigger area is expanded horizontally.

This field is only valid if Page::event_trigger is EventTrigger::ConfirmKey, EventTrigger::EventTouch or EventTrigger::PlayerTouch

pub fn range_extension_x_mut(&mut self) -> &mut u8

Mutable reference accessor for Page::range_extension_x.

pub fn range_extension_y(&self) -> u8

How much the trigger area is expanded horizontally.

This field is only valid if Page::event_trigger is EventTrigger::ConfirmKey, EventTrigger::EventTouch or EventTrigger::PlayerTouch

pub fn range_extension_y_mut(&mut self) -> &mut u8

Mutable reference accessor for Page::range_extension_y.

Trait Implementations

impl Clone for Page

fn clone(&self) -> Page

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl PartialEq for Page

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Page