Plot:Index
From OHRRPGCE-Wiki
(Redirected from Plotscripting Dictionary)
This is a full listing of all plotscripting commands as of Monday May 18 2009. For more recent changes to the plotscripting dictionary, see plotdict.xml
[edit] Declarations
[edit] Wait Commands
- wait
- wait for text box
- wait for menu
- 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
- suspend timers
- resume timers
[edit] Moving Heroes
- 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
[edit] Text Boxes
[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
- main menu
- 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
- 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
- get victory music
- set ambient music
- get ambient music
- set music volume
- get music volume
- fade screen out
- fade screen in
- load palette
- 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
- outside battle cure
[edit] Mouse Functions
[edit] String Functions
- show string
- clear string
- append ascii
- append number
- number from string
- 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] Menu Functions
- open menu
- create menu
- close menu
- top menu
- bottom menu
- previous menu
- next menu
- bring menu forward
- find menu ID
- menu is open
- add menu item
- delete menu item
- select menu item
- selected menu item
- first menu item
- menu item by slot
- menu item slot
- next menu item
- previous menu item
- find menu item caption
- get menu item caption
- set menu item caption
- get menu item type
- set menu item type
- get menu item subtype
- set menu item subtype
- get menu item tag
- set menu item tag
- get menu item settag
- set menu item settag
- get menu item togtag
- set menu item togtag
- get menu item bit
- set menu item bit
- get menu item extra
- set menu item extra
- get menu bit
- set menu bit
- parent menu
- get menu ID
- swap menu items
- get menu boxstyle
- set menu boxstyle
- get menu textcolor
- set menu textcolor
- get menu max rows
- set menu max rows
- get menu offset x
- get menu offset y
- set menu offset x
- set menu offset y
- get menu anchor x
- get menu anchor y
- set menu anchor x
- set menu anchor y
- get menu text align
- set menu text align
- get menu min chars
- set menu min chars
- get menu max chars
- set menu max chars
- get menu border
- set menu border
[edit] Sprite Functions
- load hero sprite
- replace hero sprite
- load walkabout sprite
- replace walkabout sprite
- load small enemy sprite
- replace small enemy sprite
- load medium enemy sprite
- replace medium enemy sprite
- load large enemy sprite
- replace large enemy sprite
- load attack sprite
- replace attack sprite
- load weapon sprite
- replace weapon sprite
- load border sprite
- replace border sprite
- load portrait sprite
- replace portrait sprite
- free sprite
- clone sprite
- place sprite
- get sprite type
- get sprite set number
- set sprite palette
- get sprite palette
- set sprite frame
- get sprite frame
- sprite frame count
- sprite layer
- horiz flip sprite
- vert flip sprite
- sprite is horiz flipped
- sprite is vert flipped
[edit] Slice Functions
- create container
- create rect
- slice is sprite
- slice is container
- slice is rect
- slice is text
- slice x
- slice y
- set slice x
- set slice y
- slice screen x
- slice screen y
- set slice screen x
- set slice screen y
- slice width
- slice height
- set slice width
- set slice height
- slice edge x
- slice edge y
- set horiz align
- set vert align
- set horiz anchor
- set vert anchor
- realign slice
- center slice
- set slice visible
- set sprite visible
- get slice visible
- free slice
- first child
- last child
- next sibling
- previous sibling
- first sprite child
- next sprite sibling
- first rect child
- next rect sibling
- first container child
- next container sibling
- set parent
- check parentage
- slice to front
- slice to back
- Y sort children
- set sort order
- get sort order
- sort children
- set slice extra
- get slice extra
- get rect style
- set rect style
- get rect bgcol
- set rect bgcol
- get rect fgcol
- set rect fgcol
- get rect border
- set rect border
- get rect trans
- set rect trans
- create text
- set slice handle
- get text color
- set text color
- get text bg
- set text bg
- get outline
- set outline
- get wrap
- set wrap
- slice collide point
- slice collide
- slice contains
- clamp slice
- set padding
- get top padding
- set top padding
- get left padding
- set left padding
- get right padding
- set right padding
- get bottom padding
- set bottom padding
- fill parent
- is filling parent
[edit] Misc Functions
- random
- reseedrandom
- inventory
- get inventory size
- set inventory size
- leader
- hero X
- hero Y
- NPC X
- NPC Y
- hero direction
- hero frame
- get hero speed
- NPC direction
- NPC frame
- NPC extra
- set NPC extra
- room in active party
- current map
- map width
- map height
- get map tileset
- layer 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
- hero levelled
- total experience
- experience to next level
- experience to level
- set timer
- stop timer
- read timer
[edit] Enemy and Formation Functions
- get enemy stat
- set enemy stat
- get enemy name
- set enemy name
- get enemy appearance
- set enemy appearance
- read enemy data
- write enemy data
- add enemy to formation
- delete enemy from formation
- find enemy in formation
- formation slot enemy
- formation slot x
- formation slot y
- set formation background
- get formation background
- set formation song
- get formation song
- last formation
- random formation
- formation set frequency
- formation probability
[edit] Tweaking Maps
- read map block
- write map block
- read pass block
- write pass block
- load tileset
- change tileset
- current display tile
- animation start tile
[edit] Working with Tags
[edit] Working with Variables
[edit] Math, Comparison, and Logic Operators
[edit] Flow Control
[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
- set experience
- get level MP
- get level MP
- 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
- milliseconds
[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
- song: silence
- song: same as last map
- song: same as map
