Enum ScriptCommand 

pub enum ScriptCommand {
    ShowText {
        text: String,
    },
    ShowChoice {
        options: Vec<String>,
    },
    GiveItem {
        item_id: String,
        quantity: u8,
    },
    GiveMonster {
        species: String,
        level: u8,
    },
    TakeItem {
        item_id: String,
        quantity: u8,
    },
    SetFlag {
        flag: String,
    },
    ResetFlag {
        flag: String,
    },
    CheckFlag {
        flag: String,
    },
    ShowObject {
        object_index: u8,
    },
    HideObject {
        object_index: u8,
    },
    ShowObjectByName {
        toggle_id: String,
    },
    HideObjectByName {
        toggle_id: String,
    },
    MoveNpc {
        npc_id: String,
        path: Vec<(u8, u8)>,
    },
    StartNpcMove {
        npc_id: String,
        path: Vec<(u8, u8)>,
    },
    AwaitNpcMove {
        npc_id: String,
    },
    MovePlayer {
        path: Vec<(u8, u8)>,
    },
    MovePlayerRelative {
        steps: Vec<(i16, i16)>,
    },
    MoveNpcTo {
        npc_id: String,
        x: u8,
        y: u8,
    },
    StartNpcMoveTo {
        npc_id: String,
        x: u8,
        y: u8,
    },
    MovePlayerTo {
        x: u8,
        y: u8,
    },
    FaceNpc {
        npc_id: String,
        direction: String,
    },
    FacePlayer {
        direction: String,
    },
    PlayMusic {
        music_id: String,
    },
    PlaySound {
        sound_id: String,
    },
    StopMusic,
    FadeOutMusic,
    StartBattle {
        trainer_id: String,
    },
    StartWildBattle {
        species: String,
        level: u8,
    },
    SetWeather {
        weather: Option<String>,
    },
    Delay {
        frames: u16,
    },
    WarpTo {
        map: String,
        x: u8,
        y: u8,
    },
    Heal,
    FadeScreen {
        fade_type: String,
    },
    SetJoyIgnore {
        mask: u8,
    },
    ClearJoyIgnore,
    FollowNpc {
        npc_id: String,
        target_x: u8,
        target_y: u8,
    },
    OpenShop {
        items: Vec<String>,
    },
    ShowEmotionBubble {
        npc_id: String,
        emotion: String,
    },
    SetNpcPosition {
        npc_id: String,
        x: u8,
        y: u8,
    },
    SetNpcFrame {
        npc_id: String,
        frame: u8,
    },
    ShowScene {
        scene_name: String,
        layout_json: Option<String>,
    },
    HideScene {
        scene_name: String,
    },
    UpdateUI {
        scene_name: String,
        data_json: String,
    },
    GiveMoney {
        amount: u32,
    },
    TakeMoney {
        amount: u32,
    },
    PlayCry {
        species: String,
    },
    GiveBadge {
        badge: u8,
    },
    Custom {
        name: String,
        args: Vec<Value>,
    },
}

Variants

ShowText

Fields

text: String

ShowChoice

Fields

options: Vec<String>

GiveItem

Fields

item_id: String

quantity: u8

GiveMonster

Fields

species: String

level: u8

TakeItem

Fields

item_id: String

quantity: u8

SetFlag

Fields

flag: String

ResetFlag

Fields

flag: String

CheckFlag

Fields

flag: String

ShowObject

Fields

object_index: u8

HideObject

Fields

object_index: u8

ShowObjectByName

Fields

toggle_id: String

HideObjectByName

Fields

toggle_id: String

MoveNpc

Fields

npc_id: String

path: Vec<(u8, u8)>

StartNpcMove

Fields

npc_id: String

path: Vec<(u8, u8)>

AwaitNpcMove

Fields

npc_id: String

MovePlayer

Fields

path: Vec<(u8, u8)>

MovePlayerRelative

Relative player steps: each entry is a (dx, dy) delta applied cumulatively from the player’s current position. Direction strings (“up”/“down”/“left”/“right”) are converted to unit deltas at parse time.

Fields

steps: Vec<(i16, i16)>

MoveNpcTo

Fields

npc_id: String

x: u8

y: u8

StartNpcMoveTo

Fields

npc_id: String

x: u8

y: u8

MovePlayerTo

Fields

x: u8

y: u8

FaceNpc

Fields

npc_id: String

direction: String

FacePlayer

Fields

direction: String

PlayMusic

Fields

music_id: String

PlaySound

Fields

sound_id: String

StopMusic

FadeOutMusic

StartBattle

Fields

trainer_id: String

StartWildBattle

Start a wild/static battle against a single generated opponent of the given species and level (catchable, like a random encounter). Resolves to the battle outcome string (“win” | “lose” | “caught” | “fled” | …).

Fields

species: String

level: u8

SetWeather

Arm the battle-local weather for the NEXT battle (Some(id) names a kind: Weather rules.ron record; None clears a previously armed one). Runner-local: registered by the jrpg runner’s scene engine next to startBattle, consumed before the battle starts, cleared when the battle ends. Never saved.

Fields

weather: Option<String>

Delay

Fields

frames: u16

WarpTo

Fields

map: String

x: u8

y: u8

Heal

FadeScreen

Fields

fade_type: String

SetJoyIgnore

Fields

mask: u8

ClearJoyIgnore

FollowNpc

Fields

npc_id: String

target_x: u8

target_y: u8

OpenShop

Fields

items: Vec<String>

ShowEmotionBubble

Fields

npc_id: String

emotion: String

SetNpcPosition

Fields

npc_id: String

x: u8

y: u8

SetNpcFrame

Fields

npc_id: String

frame: u8

ShowScene

Fields

scene_name: String

layout_json: Option<String>

HideScene

Fields

scene_name: String

UpdateUI

Fields

scene_name: String

data_json: String

GiveMoney

Fields

amount: u32

TakeMoney

Fields

amount: u32

PlayCry

Fields

species: String

GiveBadge

Fields

badge: u8

Custom

A game-defined command outside the generic JRPG protocol.

The game registers the JS verb through its ScriptApiRegistrar (returning this variant with the verb’s name and arguments) and dispatches on name/args in its own app layer.

Fields

name: String

args: Vec<Value>

Trait Implementations

impl Clone for ScriptCommand

fn clone(&self) -> ScriptCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScriptCommand

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ScriptCommand

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ScriptCommand

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ScriptCommand

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 ScriptCommand