From OHRRPGCE-Wiki

This is a full listing of all plotscripting commands as of Jan 3 2007 (?) See the nightly-uploaded plotscripting dictionary for up-to-date information.

Contents 1 Declarations 2 Wait Commands 3 Suspend and Resume 4 Moving Heros 5 Moving NPCs 6 Moving the Camera 7 Text Boxes 8 Triggering and Showing Stuff 9 Adding and Removing 10 Effects 11 Hero's Spells 12 Mouse Functions 13 String Functions 14 Misc Functions 15 Tweaking Maps 16 Working with Tags 17 Working with Variables 18 Math, Comparison, and Logic Operators 19 Flow Control 20 Advanced Commands 21 Predefined Constants

[edit] Declarations

• define script
• script
• global variable
• variable
• define constant
• include

[edit] Wait Commands

• wait
• wait for text box
• wait for hero
• wait for key
• wait for scancode
• wait for NPC
• wait for camera
• wait for all

[edit] Suspend and Resume

• suspend player
• resume player
• suspend NPCs
• resume NPCs
• suspend obstruction
• resume obstruction
• suspend hero walls
• resume hero walls
• suspend NPC walls
• resume NPC walls
• suspend caterpillar
• resume caterpillar
• suspend catapillar
• resume catapillar
• suspend random enemies
• resume random enemies
• suspend random enemys
• resume random enemys
• suspend box advance
• resume box advance
• suspend overlay
• resume overlay
• suspend map music
• resume map music

[edit] Moving Heros

• walk hero
• set hero direction
• set hero frame
• set hero position
• set hero z
• walk hero to x
• walk hero to y
• check hero wall
• set hero speed
• use door
• teleport to map
• dismount vehicle
• hero is walking
• put hero

[edit] Moving NPCs

• NPC reference
• NPC at spot
• NPC at pixel
• walk NPC
• set NPC direction
• set NPC frame
• set NPC position
• walk NPC to X
• walk NPC to Y
• check NPC wall
• set NPC speed
• NPC is walking
• get NPC ID
• NPC copy count
• change NPC ID
• create NPC
• destroy NPC
• put npc

[edit] Moving the Camera

• camera follows hero
• camera follows NPC
• pan camera
• focus camera
• put camera

[edit] Text Boxes

• show text box
• advance text box

[edit] Triggering and Showing Stuff

• fight formation
• Use NPC
• game over
• show value
• show no value
• cancel map name display
• show backdrop
• show map
• use shop
• show mini map
• items menu
• status screen
• spells menu
• equip menu
• save menu
• load menu
• order menu
• team menu

[edit] Adding and Removing

• party money
• get money
• lose money
• set money
• pay money
• add hero
• delete hero
• swap in hero
• swap out hero
• lock hero
• unlock hero
• swap by name
• swap by position
• inventory
• get item
• delete item
• unequip
• force equip
• equip where
• check equipment
• get default weapon
• set default weapon
• give experience

[edit] Effects

• play song
• current song
• stop song
• set victory music
• set ambient music
• get ambient music
• set music volume
• get music volume
• fade screen out
• fade screen in
• update palette
• greyscale palette
• tweak palette
• reset palette
• read color
• write color
• get color
• set color
• RGB
• extract color
• play sound
• stop sound
• pause sound
• sound is playing

[edit] Hero's Spells

• teach spell
• forget spell
• read spell
• write spell
• knows spell
• can learn spell
• spells learnt

[edit] Mouse Functions

• init mouse
• mouse pixel X
• mouse pixel Y
• mouse button
• put mouse
• mouse region

[edit] String Functions

• show string
• clear string
• append ascii
• append number
• copy string
• concatenate strings
• string length
• string compare
• replace char
• delete char
• ascii from string
• string to globals
• globals to string
• get hero name
• set hero name
• get item name
• get map name
• get attack name
• get global string
• input string
• show string at
• center string at
• hide string
• string is visible
• string style
• string color
• position string
• string X
• string Y
• get song name
• search string
• trim string
• string from textbox
• expand string

[edit] Misc Functions

• random
• leader
• hero X
• hero Y
• NPC X
• NPC Y
• hero direction
• hero frame
• NPC direction
• NPC frame
• NPC extra
• set NPC extra
• room in active party
• current map
• map width
• map height
• get map tileset
• days of play
• set days of play
• hours of play
• set hours of play
• minutes of play
• set minutes of play
• seconds of play
• set seconds of play
• system year
• system month
• system day
• system hour
• system minute
• system second
• key is pressed
• keyval
• last ascii
• joystick button
• joystick axis
• hero pixel X
• hero pixel Y
• NPC pixel X
• NPC pixel Y
• camera pixel X
• camera pixel Y
• pick hero
• rename hero
• rename hero by slot
• last save slot
• save slot used
• get enemy stat
• set enemy stat
• get enemy name
• set enemy name
• get enemy appearance
• set enemy appearance
• read enemy data
• write enemy data
• get formation song
• set formation song
• hero levelled
• set timer
• stop timer
• read timer

[edit] Tweaking Maps

• read map block
• write map block
• read pass block
• write pass block
• load tileset
• current display tile
• animation start tile

[edit] Working with Tags

• set tag
• check tag

[edit] Working with Variables

• set variable
• increment
• decrement

[edit] Math, Comparison, and Logic Operators

• add
• subtract
• multiply
• divide
• mod
• ^
• ==
• <>
• <<
• >>
• <=
• >=
• and
• or
• xor
• &&
• ||
• ^^

[edit] Flow Control

• begin
• end
• if
• then
• else
• while
• do
• for
• return
• switch
• case

[edit] Advanced Commands

• set hero picture
• set hero palette
• get hero picture
• get hero palette
• alter NPC
• read NPC
• set death script
• get death script
• set load script
• get load script
• set on keypress script
• get on keypress script
• set each step script
• get each step script
• set instead of battle script
• get instead of battle script
• set harm tile damage
• set harm tile flash
• set foot offset
• get foot offset
• draw NPCs above heroes
• set map edge mode
• get map edge mode
• find hero
• hero by slot
• rank in caterpillar
• hero by rank
• get hero stat
• set hero stat
• set capped hero stat
• get hero stat cap
• get hero level
• set hero level
• read global
• write global
• set battle wait mode
• set caterpillar mode
• set no HP level up restore
• set no MP level up restore
• set inn no revive mode
• set full hero swap mode
• hide battle ready meter
• hide battle health meter
• set debug keys disable
• allow minimap
• allow save anywhere
• autosave
• save in slot
• load from slot
• delete save
• import globals
• export globals
• run script by ID
• get damage cap
• set damage cap
• trace
• save map state
• load map state
• reset map state
• delete map state
• get tile animation offset
• set tile animation offset

[edit] Predefined Constants

• Numeric Constants
• zero
• one
• two
• three
• four
• five
• six
• seven
• eight
• nine
• nine
• Key Constants
• any key
• up key
• down key
• left key
• right key
• use key
• menu key
• cancel key
• Boolean Constants
• true
• false
• on
• off
• Direction Constants
• north
• south
• east
• west
• up
• down
• right
• left
• me
• none
• autonumber
• current stat
• maximum stat
• inside battle
• outside battle
• Color Constants
• color:red
• color:green
• color:blue
• Mouse Constants
• left button
• right button
• get count
• Tile Constants
• north wall
• east wall
• west wall
• south wall
• vehicle A
• vehicle B
• harm tile
• overhead tile
• crop
• wrap
• default tile
• party
• x axis
• y axis
• timer: default
• timer: game over
• timer flag: critical
• timer flag: battle
• timer flag: menu