'OHRRPGCE GAME - Script command implementations
'(C) Copyright 1997-2022 James Paige, Ralph Versteegen, and the OHRRPGCE Developers
'Dual licensed under the GNU GPL v2+ and MIT Licenses. Read LICENSE.txt for terms and disclaimer of liability.
'
' All script commands are implemented here, arranged in rather random order,
' including functions for the various handles and references that can be passed to script commands.
#include "config.bi"
#include "allmodex.bi"
#include "common.bi"
#include "gglobals.bi"
#include "const.bi"
#include "scrconst.bi"
#include "uiconst.bi"
#include "loading.bi"
#include "scripting.bi"
#include "savegame.bi"
#include "game.bi"
#include "scriptcommands.bi"
#include "yetmore2.bi"
#include "walkabouts.bi"
#include "moresubs.bi"
#include "menustuf.bi"
#include "bmod.bi"
#include "bmodsubs.bi"
#include "bcommon.bi"
#include "steam.bi"
''''' Local functions
DECLARE SUB run_game ()
DECLARE FUNCTION check_game_exists () as integer
DECLARE FUNCTION get_optional_arg(byval retval_index as integer, byval default as integer) as integer
DECLARE FUNCTION get_door_on_map(byref thisdoor as Door, byval door_id as integer, byval map_id as integer) as bool
DECLARE FUNCTION allow_gmap_idx(gmap_idx as integer) as bool
DECLARE FUNCTION load_sprite_plotslice(byval spritetype as SpriteType, byval record as integer, byval pal as integer=-2) as integer
DECLARE SUB replace_sprite_plotslice(byval slice_argno as integer, byval spritetype as SpriteType, byval record as integer, byval pal as integer=-2)
DECLARE FUNCTION get_enemy_sprite_size(index as integer) as XYPair
DECLARE FUNCTION bulk_append_extra(extravec_ptr as integer vector ptr, count_to_add as integer) as integer
DECLARE FUNCTION bulk_append_or_replace(extravec_ptr as integer vector ptr, count_to_add as integer, append_extra as bool) as integer
DECLARE FUNCTION copy_path_data_into_extra(extravec_ptr as integer vector ptr, byref pf as AStarPathfinder, destpos as XYPair, append_extra as bool, skip_start as bool) as bool
''''' Global variables
'Script commands in this file need to REDIM plotslices() and timers(), but FB
'doesn't let you REDIM a global array in a module other than where it is defined!
'plotslices(0) isn't used since Slice.TableSlot = 0 means the slice isn't in plotslices.
'plotslices will grow as needed up to SLICE_HANDLE_SLOT_MASK (2.1 million)
'The size of 64 is just so we won't have to reallocate for a little while
REDIM plotslices(0 TO 64) as SliceHandleSlot
plotslicesp = @plotslices(0)
'Next plotslices() slot to try assigning (if unused), linearly scanned upwards
DIM next_slice_table_slot as integer = 1
'Tracks the number of unused plotslices() slots less than next_slice_table_slot
DIM num_reusable_slice_table_slots as integer
REDIM timers(numInitialTimers - 1) as PlotTimer
'==========================================================================================
' Text embed codes
'==========================================================================================
SUB embedtext (text as string, byval limit as integer=0, byval saveslot as integer=-1)
'saveslot is optional. If >= 0 then that save slot will be used for reading things like hero names
text = embed_text_codes(text, saveslot)
'--enforce limit (if set)
IF limit > 0 THEN
text = LEFT(text, limit)
END IF
END SUB
FUNCTION embed_text_codes (text_in as string, byval saveslot as integer=-1, byval callback as FnEmbedCode=0, byval arg0 as ANY ptr=0, byval arg1 as ANY ptr=0, byval arg2 as ANY ptr=0) as string
' Expand embed codes like ${H0}.
' The optional callback can be passed to process additional codes.
' It should set its result string if it recognised the code, and otherwise
' leave it alone. arg0, arg1, arg2 are forwarded to it.
'saveslot is optional. If >= 0 then that save slot will be used for reading things like hero names
DIM text as string = text_in
DIM start as integer = 1
DIM insert as string
DO WHILE start < LEN(text)
'--seek an embed spot
DIM embedbegin as integer = INSTR(start, text, "${")
IF embedbegin = 0 THEN EXIT DO '--failed to find an embed spot
DIM embedend as integer = INSTR(embedbegin + 4, text, "}")
IF embedend = 0 THEN EXIT DO '--embed spot has no end
'--break apart the string
DIM before as string = MID(text, 1, large(embedbegin - 1, 0))
DIM after as string = MID(text, embedend + 1)
'--extract the code
DIM code as string = MID(text, embedbegin + 2, embedend - 1 - (embedbegin + 1))
'--set a reasonable default for the insert text if the code is not matched
insert = "${" & code & "}"
'--extract the command and arg
DIM act as string = LEFT(code, 1)
DIM arg_str as string = MID(code, 2)
'--convert the arg to a number
DIM arg as integer = str2int(arg_str)
'--discourage bad arg values (not perfect)
IF NOT (arg = 0 AND arg_str <> STRING(LEN(arg_str), "0")) THEN
IF arg >= 0 THEN '--only permit postive args
'--evaluate standard insert actions based on the currently loaded game
IF saveslot >= 0 THEN
insert = saveslot_embed_codes(saveslot, act, arg)
ELSE
insert = standard_embed_codes(act, arg)
END IF
SELECT CASE UCASE(act)
CASE "B": '--buttonname (platform-specific)
insert = get_buttonname_code(arg)
END SELECT
END IF
END IF
IF callback <> NULL THEN
callback(code, insert, arg0, arg1, arg2)
END IF
'--skip past this embed
text = before & insert & after
start = LEN(before) + LEN(insert) + 1
LOOP
RETURN text
END FUNCTION
FUNCTION standard_embed_codes(act as string, byval arg as integer) as string
'act --- the code text. It is normally alpha only. For example, the "H" in ${H0}
'arg --- the code argument. This is an integer. For example, the 0 in ${H0}
'--by default the embed is unchanged
DIM insert as string = "${" & act & arg & "}"
SELECT CASE UCASE(act)
CASE "H": '--Hero name by ID
'--first search for a copy of the hero in the party
DIM where as integer = findhero(arg)
IF where >= 0 THEN
insert = gam.hero(where).name
ELSE
insert = getheroname(arg, NO) 'Don't default to "Hero #" if blank name
END IF
CASE "P": '--Hero name by Party position
IF arg >= 0 ANDALSO arg <= UBOUND(gam.hero) THEN
'--defaults blank if not found
insert = ""
IF gam.hero(arg).id >= 0 THEN
insert = gam.hero(arg).name
END IF
END IF
CASE "C": '--Hero name by caterpillar position
'--defaults blank if not found
insert = ""
DIM where as integer = rank_to_party_slot(arg)
IF where >= 0 ANDALSO where <= active_party_slots() - 1 THEN
insert = gam.hero(where).name
END IF
CASE "V": '--global variable by ID
'--defaults blank if out-of-range
insert = ""
IF arg >= 0 ANDALSO arg <= maxScriptGlobals THEN
insert = STR(global(arg))
END IF
CASE "S": '--string variable by ID
insert = ""
IF in_bound(arg, 0, UBOUND(plotstr)) THEN
insert = plotstr(arg).s
END IF
END SELECT
RETURN insert
END FUNCTION
FUNCTION saveslot_embed_codes(byval saveslot as integer, act as string, byval arg as integer) as string
'saveslot -- the save slot number that we should read values from. 0-maxSaveSlotCount-1
'act --- the code text. It is normally alpha only. For example, the "H" in ${H0}
'arg --- the code argument. This is an integer. For example, the 0 in ${H0}
'--by default the embed is unchanged
DIM insert as string = "${" & act & arg & "}"
DIM node as NodePtr = saveslot_quick_root_node(saveslot)
IF node = 0 THEN RETURN insert
SELECT CASE UCASE(act)
CASE "H": '--Hero name by ID
'--first search for a copy of the hero in the party
DIM where as integer = saveslot_findhero(node, arg)
IF where >= 0 THEN
insert = saveslot_hero_name_by_slot(node, where)
ELSE
insert = getheroname(arg, NO) 'Don't default to "Hero #" if blank name
END IF
CASE "P": '--Hero name by Party position
'--defaults blank if not found
'--Don't have to check validity of arg here. Don't assume UBOUND(gam.hero) is fixed.
insert = saveslot_hero_name_by_slot(node, arg)
CASE "C": '--Hero name by caterpillar position
'--defaults blank if not found
insert = ""
DIM where as integer = saveslot_rank_to_party_slot(node, arg)
IF where >= 0 ANDALSO where <= active_party_slots() - 1 THEN
insert = saveslot_hero_name_by_slot(node, where)
END IF
CASE "V": '--global variable by ID
'--defaults blank if out-of-range
insert = ""
IF arg >= 0 ANDALSO arg <= maxScriptGlobals THEN
insert = STR(saveslot_global(node, arg))
END IF
CASE "S": '--string variable by ID
'--Don't have to check validity of arg here
insert = saveslot_plotstr(node, arg)
END SELECT
FreeDocument(GetDocument(node))
RETURN insert
END FUNCTION
' Implementation of "string sprintf". Reads from retval(1...).
' retval(1) is the format string id; retval(2...) are the arguments
' Returns the formatted string
FUNCTION script_sprintf() as string
DIM ret as string
DIM formatstring as string = plotstr(retvals(1)).s
DIM nextarg as integer = 2 'retval() index
DIM copystart as integer = 1 'Position to copy literally from. 1-based indexing
WHILE copystart <= LEN(formatstring)
DIM percentptr as zstring ptr
percentptr = strchr(STRPTR(formatstring) + copystart - 1, ASC("%"))
'Position of the start of this format code. 1-based indexing
DIM percentpos as integer
percentpos = (percentptr - STRPTR(formatstring)) + 1
IF percentptr = NULL THEN EXIT WHILE
ret &= MID(formatstring, copystart, percentpos - copystart)
' Check what the next letter is
IF percentptr[1] = 0 THEN ' End of string
scripterr interpreter_context_name() & !"Found lone % at end of format string:\n" & formatstring, serrBadOp
EXIT WHILE
ELSEIF percentptr[1] = ASC("%") THEN
ret &= "%"
copystart = percentpos + 2
ELSE
IF nextarg >= curcmd->argc THEN
scripterr interpreter_context_name() & "There are only " & curcmd->argc & !" formatting arguments, but format string has more codes than that:\n" & formatstring, serrBadOp
EXIT WHILE
ELSE
IF percentptr[1] = ASC("s") THEN
' String
IF valid_plotstr(retvals(nextarg), serrBadOp) THEN
ret &= plotstr(retvals(nextarg)).s
END IF
ELSEIF percentptr[1] = ASC("d") THEN
' Decimal
ret &= retvals(nextarg)
ELSEIF percentptr[1] = ASC("x") THEN
' Hexidecimal
ret &= LCASE(HEX(retvals(nextarg)))
ELSEIF percentptr[1] = ASC("o") THEN
' Octal
ret &= OCT(retvals(nextarg))
ELSEIF percentptr[1] = ASC("b") THEN
' Binary
DIM temp as string = BIN(retvals(nextarg))
' Split into groups of 8 digits
WHILE LEN(temp)
DIM numbits as integer = LEN(temp) MOD 8
IF numbits = 0 THEN numbits = 8 : ret &= " "
ret &= LEFT(temp, numbits)
temp = MID(temp, numbits + 1)
WEND
ELSEIF percentptr[1] = ASC("c") THEN
' Character
IF bound_arg(retvals(nextarg), 0, 255, "%c character code", , serrBadOp) THEN
ret &= CHR(retvals(nextarg))
END IF
END IF
copystart = percentpos + 2
nextarg += 1
END IF
END IF
WEND
ret &= MID(formatstring, copystart)
IF nextarg <> curcmd->argc THEN
scripterr interpreter_context_name() & "There were more arguments (" & curcmd->argc & ") than were needed (only " & nextarg & !"):\n" & formatstring, serrBadOp
END IF
RETURN ret
END FUNCTION
'==========================================================================================
' Battle and caterpillar party
'==========================================================================================
FUNCTION rank_to_party_slot (byval rank as integer) as integer
'Returns the party slot of the nth hero in the party
'This is used for converting caterpillar rank into party slot.
'Returns -1 if there are not that many heroes in the active party
DIM heronum as integer = -1
FOR party_slot as integer = 0 TO 3
IF gam.hero(party_slot).id >= 0 THEN heronum += 1
IF heronum = rank THEN
RETURN party_slot
END IF
NEXT
RETURN -1
END FUNCTION
FUNCTION party_slot_to_rank (byval slot as integer) as integer
'Returns the rank of the hero in a party slot (not just caterpillar party), or -1 if invalid
IF slot < -1 OR slot > UBOUND(gam.hero) THEN RETURN -1
FAIL_IF(gam.hero(slot).id < 0, "empty slot", -1)
DIM heronum as integer = 0
FOR party_slot as integer = 0 TO slot - 1
IF gam.hero(party_slot).id >= 0 THEN heronum += 1
NEXT
RETURN heronum
END FUNCTION
FUNCTION herobyrank (byval rank as integer) as integer
'Return the ID of the nth hero in the *caterpillar* party
DIM party_slot as integer = rank_to_party_slot(rank)
IF party_slot >= 0 AND party_slot <= 3 THEN RETURN gam.hero(party_slot).id
RETURN -1
END FUNCTION
FUNCTION rankincaterpillar (byval heroid as integer) as integer
'Returns -1 if the hero is not found.
'Returns the last hero's rank if there are more than one copy of the same hero
DIM result as integer = -1
DIM o as integer = 0
FOR i as integer = 0 TO 3
IF gam.hero(i).id >= 0 THEN
IF gam.hero(i).id = heroid THEN result = o
o += 1
END IF
NEXT i
RETURN result
END FUNCTION
'==========================================================================================
' Keypresses and script triggering
'==========================================================================================
FUNCTION script_keyval (byval key as KBScancode, byval player as integer = 0, byref down_ms as integer = 0) as KeyBits
'Wrapper around player_keyval for use by scripts: performs scancode mapping for back-compat
IF valid_key(key, serrWarn) = NO THEN RETURN 0
DIM ret as KeyBits = player_keyval(key, player, down_ms)
IF gam.click_keys THEN
DIM mask as integer
SELECT CASE key
CASE ccAny : mask = -1
CASE ccUse : mask = mouseLeft
CASE ccCancel : mask = mouseRight
CASE ccMenu : mask = mouseRight
'CASE ccRun
END SELECT
IF mask THEN
DIM byref mouse as MouseInfo = readmouse()
'Check for release, not click, because that's how all builtin
'use/menu/cancel/textbox advance controls work.
'Not counting mouse buttons towards down_ms because it's too much work, too obscure,
'and mouse buttons don't cause key-repeat anyway.
IF mouse.release AND mask THEN ret OR= 6
IF mouse.buttons AND mask THEN ret OR= 1
END IF
END IF
IF prefbit(24) = NO THEN 'If improved scancodes not enabled
'The new scancodes separate some keys which previously had the same scancode.
'For backwards compatibility (whether or not you recompile your scripts with
'a new copy of scancodes.hsi) we make the newly separated scancodes behave
'as if they were indistinguishable.
SELECT CASE key
CASE scHome TO scDelete
ret OR= player_keyval(key + scNumpad7 - scHome, player, down_ms)
CASE scNumpad7 TO scNumpad9, scNumpad4 TO scNumpad6, scNumpad1 TO scNumpadPeriod
ret OR= player_keyval(key - scNumpad7 + scHome, player, down_ms)
CASE scSlash: ret OR= player_keyval(scNumpadSlash, player, down_ms)
CASE scEnter: ret OR= player_keyval(scNumpadEnter, player, down_ms)
CASE scNumlock: ret OR= player_keyval(scPause, player, down_ms)
CASE scNumpadSlash: ret OR= player_keyval(scSlash, player, down_ms)
CASE scNumpadEnter: ret OR= player_keyval(scEnter, player, down_ms)
CASE scPause: ret OR= player_keyval(scNumlock, player, down_ms)
END SELECT
END IF
IF prefbit(47) = NO THEN '!Map joystick controls to keyboard keys for scripts
SELECT CASE key
CASE scUp: ret OR= player_keyval(ccUp, player, down_ms, , , NO) 'check_keyboard=NO
CASE scDown: ret OR= player_keyval(ccDown, player, down_ms, , , NO)
CASE scLeft: ret OR= player_keyval(ccLeft, player, down_ms, , , NO)
CASE scRight: ret OR= player_keyval(ccRight, player, down_ms, , , NO)
CASE scEnter: ret OR= player_keyval(ccUse, player, down_ms, , , NO)
CASE scEsc: ret OR= player_keyval(ccMenu, player, down_ms, , , NO)
END SELECT
END IF
RETURN ret
END FUNCTION
' Trigger the on-keypress script if appropriate
SUB trigger_onkeypress_script ()
DIM doit as bool = NO
'Checks whether keyboard and joystick keys are down, and optionally the mouse
'(we check keys are down, not whether they're held/released.)
'(Mouse is checked if "init mouse" has been run at least once, or if one of these settings enabled)
DIM checkmouse as bool = gam.mouse_enabled
gam.click_keys = get_gen_bool("/mouse/click_keys")
IF gam.click_keys ORELSE get_gen_bool("/mouse/move_hero") THEN checkmouse = YES
IF anykeypressed(YES, checkmouse, 1) THEN doit = YES 'checkjoystick=YES, trigger_level=1
'Because anykeypressed doesn't check it, and we don't want to break scripts looking for key:alt (== scUnfilteredAlt)
IF keyval(scUnfilteredAlt) > 0 THEN doit = YES
IF nowscript >= 0 THEN
IF scriptinsts(nowscript).waiting = waitingOnCmd AND scriptinsts(nowscript).curvalue = 9 THEN
'--never trigger a onkey script when the previous script
'--has a "wait for key" command active
doit = NO
END IF
END IF
IF doit THEN
DIM trigger as integer = trigger_or_default(gmap(15), gen(genDefOnKeypressScript))
IF trigger THEN
trigger_script trigger, 1, YES, "on-key", "", mainFibreGroup
END IF
END IF
END SUB
'==========================================================================================
' Wait Commands
'==========================================================================================
' Implementations of 'wait' commands.
SUB process_wait_conditions()
WITH scriptinsts(nowscript)
' Evaluate wait conditions, even if the fibre is paused (unimplemented),
' as waiting for unpause first will just lead to bugs eg. due to map changes
' (Note however that is the way the old one-script-at-a-time mode works: wait
' conditions not considered until its turn to run)
IF .waiting = waitingOnTick THEN
.waitarg -= 1
IF .waitarg <= 0 THEN script_stop_waiting()
EXIT SUB
END IF
SELECT CASE .curvalue
CASE 15, 35, 61, 76'--use door, use NPC, teleport to map, fade screen in
script_stop_waiting()
CASE 16'--fight formation
script_stop_waiting(IIF(gam.wonbattle, 1, 0))
CASE 1'--wait number of ticks
.waitarg -= 1
IF .waitarg < 1 THEN
script_stop_waiting()
END IF
CASE 2'--wait for all
DIM unpause as bool = YES
FOR i as integer = 0 TO 3
IF herow(i).xgo <> 0 ORELSE herow(i).ygo <> 0 ORELSE hero_is_pathfinding(i) THEN unpause = NO
NEXT i
IF readbit(gen(), genSuspendBits, suspendnpcs) = 1 THEN
FOR i as integer = 0 TO UBOUND(npc)
IF npc(i).id > 0 ANDALSO (npc(i).xgo <> 0 OR npc(i).ygo <> 0) THEN unpause = NO: EXIT FOR
NEXT i
END IF
FOR i as integer = 0 TO UBOUND(npc)
'check for script initiated NPC pathing even when npcs are not suspended
IF npc(i).id > 0 ANDALSO npc(i).pathover.override THEN unpause = NO: EXIT FOR
NEXT i
IF gen(genCameraMode) = pancam ORELSE gen(genCameraMode) = focuscam THEN unpause = NO
IF unpause THEN
script_stop_waiting()
END IF
CASE 3'--wait for hero
IF .waitarg < 0 OR .waitarg > 3 THEN
showbug "waiting for nonexistant hero " & .waitarg 'should be bound by waitforhero
script_stop_waiting()
ELSE
IF herow(.waitarg).xgo = 0 ANDALSO herow(.waitarg).ygo = 0 ANDALSO NOT hero_is_pathfinding(.waitarg) THEN
script_stop_waiting()
END IF
END IF
CASE 4'--wait for NPC
DIM npcref as NPCIndex = getnpcref(.waitarg, 0)
IF npcref >= 0 ANDALSO .waitarg2 = gam.map.id THEN
IF npc(npcref).xgo = 0 ANDALSO npc(npcref).ygo = 0 ANDALSO npc(npcref).pathover.override = NO THEN
script_stop_waiting()
END IF
ELSE
'--no reference found, why wait for a non-existant npc?
script_stop_waiting()
END IF
CASE 9, 244'--wait for key, wait for scancode
IF txt.showing ANDALSO use_touch_textboxes() THEN
'If a touch textbox is currently being displayed, we make a special
'exception and treat any touch as the key we are waiting for
IF readmouse().release AND mouseLeft THEN
script_stop_waiting()
EXIT SUB
END IF
ELSE
a_script_wants_keys()
END IF
IF .waitarg <> ccAny THEN
IF script_keyval(.waitarg) > 1 THEN
script_stop_waiting()
EXIT SUB
END IF
'Because carray(ccMenu/ccCancel) don't include it, and we don't want to break scripts
'doing waitforkey(menu key) followed by looking for key:alt (== scUnfilteredAlt)
IF (.waitarg = ccMenu OR .waitarg = ccCancel) ANDALSO keyval(scUnfilteredAlt) > 1 THEN script_stop_waiting()
ELSE
'.waitarg == ccAny
DIM temp as KBScancode = anykeypressed(YES, gam.click_keys) 'check joystick, maybe mouse
'Because anykeypressed doesn't check it, and we don't want to break scripts
'doing waitforkey(any key) followed by looking for key:alt (== scUnfilteredAlt)
IF keyval(scUnfilteredAlt) > 1 THEN temp = scUnfilteredAlt
IF temp THEN
script_stop_waiting(temp)
END IF
END IF
CASE 42'--wait for camera
IF gen(genCameraMode) <> pancam ANDALSO gen(genCameraMode) <> focuscam THEN script_stop_waiting()
CASE 59'--wait for text box
IF txt.showing = NO OR readbit(gen(), genSuspendBits, suspendboxadvance) = 1 THEN
script_stop_waiting()
END IF
CASE 73, 234, 438'--game over, quit from loadmenu, reset game
CASE 508'--wait for slice
DIM sl as Slice ptr
sl = get_handle_slice(.waitarg, serrWarn)
IF sl THEN
IF SliceIsMoving(sl) = NO THEN
script_stop_waiting()
END IF
ELSE
'If the slice ceases to exist, we should stop waiting for it (after throwing our minor warning)
script_stop_waiting()
END IF
CASE 575'--wait for dissolve
DIM sl as Slice ptr
'Don't need to throw an error if the slice is no longer a sprite (SpriteSliceIsDissolving doesn't either)
sl = get_handle_slice(.waitarg, serrWarn)
IF sl THEN
IF NOT SpriteSliceIsDissolving(sl, YES) THEN
script_stop_waiting()
END IF
ELSE
'If the slice ceases to exist, we should stop waiting for it (after throwing our minor warning)
script_stop_waiting()
END IF
CASE ELSE
showbug "illegal wait substate " & .curvalue
script_stop_waiting()
END SELECT
END WITH
END SUB
'==========================================================================================
' Script Commands
'==========================================================================================
' This entry point is called from the script interpreter.
SUB script_commands(byval cmdid as integer)
'These variables are uninitialised for speed
DIM id as integer = ANY
DIM menuslot as integer = ANY
DIM mislot as integer = ANY
DIM sl as Slice ptr = ANY
DIM extravec_ptr as integer vector ptr = ANY
DIM npcref as NPCIndex = ANY
DIM mi as MenuDefItem ptr = ANY
DIM i as integer = ANY
scriptret = 0
SELECT CASE as CONST cmdid
CASE 11'--show textbox (box)
'showtextbox(0) does nothing
gam.want.box = large(0, retvals(0))
IF immediate_showtextbox ANDALSO gam.want.box > 0 THEN loadsay gam.want.box: gam.want.box = 0
CASE 15'--use door
gam.want.door = retvals(0) + 1
gam.want.door_fadescreen = get_optional_arg(1, 1) <> 0
script_start_waiting(0)
CASE 16'--fight formation
IF retvals(0) >= 0 AND retvals(0) <= gen(genMaxFormation) THEN
gam.want.battle = retvals(0) + 1
script_start_waiting(0)
ELSE
scriptret = -1
END IF
CASE 23'--unequip
IF valid_hero_party(retvals(0)) THEN
unequip retvals(0), bound(retvals(1) - 1, 0, 4)
END IF
CASE 24'--force equip
IF valid_hero_party(retvals(0)) THEN
i = retvals(0)
IF valid_item(retvals(2)) THEN
IF doequip(retvals(2), i, bound(retvals(1) - 1, 0, 4)) = NO THEN
'This could fail because there is no room in the inventory for whatever item
'is being unequipped
scriptret = 0
ELSE
scriptret = 1
END IF
END IF
END IF
CASE 32'--show backdrop
gen(genScrBackdrop) = bound(retvals(0) + 1, 0, gen(genNumBackdrops))
CASE 33'--show map
gen(genScrBackdrop) = 0
CASE 34'--dismount vehicle
forcedismount
CASE 35'--use NPC
npcref = getnpcref(retvals(0), 0)
IF npcref >= 0 THEN
gam.want.usenpc = npcref + 1
script_start_waiting()
END IF
CASE 37'--use shop
IF retvals(0) >= 0 AND retvals(0) <= gen(genMaxShop) THEN
shop retvals(0)
END IF
CASE 55'--get default weapon
IF valid_hero_party(retvals(0)) THEN
scriptret = gam.hero(retvals(0)).def_wep - 1
ELSE
scriptret = 0
END IF
CASE 56'--set default weapon
IF valid_hero_party(retvals(0)) THEN
IF valid_item(retvals(1)) THEN
'--identify new default weapon
DIM as integer newdfw = retvals(1)
'--remember old default weapon
DIM as integer olddfw = gam.hero(retvals(0)).def_wep - 1
'--remember currently equipped weapon
DIM as integer cureqw = gam.hero(retvals(0)).equip(0).id
'--change default
gam.hero(retvals(0)).def_wep = newdfw + 1
IF cureqw <> olddfw THEN
'--if previously using a weapon, re-equip old weapon
IF doequip(cureqw, retvals(0), 0) = NO THEN
'I don't think this can actually fail because default weapon is a special case
END IF
ELSE
'--otherwise equip new default weapon
IF doequip(newdfw, retvals(0), 0) = NO THEN
'I don't think this can actually fail because default weapon is a special case
END IF
END IF
END IF
END IF
CASE 61'--teleport to map
IF valid_map(retvals(0)) THEN
gam.map.id = retvals(0)
(herox(0)) = retvals(1) * 20
(heroy(0)) = retvals(2) * 20
gam.want.teleport = YES
script_start_waiting(0)
END IF
CASE 63, 169'--resume random enemies
setbit gen(), genSuspendBits, suspendrandomenemies, 0
gam.random_battle_countdown = range(100, 60)
CASE 73'--game over
gam.quit = YES
script_start_waiting()
CASE 77'--show value/show values
IF curcmd->argc = 1 THEN
gam.showstring = STR(retvals(0))
ELSE
gam.showstring = ""
FOR i as integer = 0 TO curcmd->argc - 1
IF i <> 0 THEN gam.showstring &= " "
gam.showstring &= strprintf("%3d", retvals(i))
NEXT
END IF
CASE 78'--alter NPC (npcref, npcstat, value, [pool])
IF bound_arg(retvals(1), 0, maxNPCDataField, "NPCstat: constant", , serrBadOp) THEN
DIM npcid as NPCTypeID
DIM pool as integer
IF get_valid_npc_id_pool(retvals(0), get_optional_arg(3, -1), npcid, pool) THEN
DIM write_value as bool = YES
IF retvals(1) = 0 THEN 'NPCstat:picture
IF retvals(2) < 0 ORELSE retvals(2) > gen(genMaxNPCPic) THEN
write_value = NO
ELSE
change_npc_def_sprite npcid, retvals(2), pool
END IF
END IF
IF retvals(1) = 1 THEN 'NPCstat:palette
change_npc_def_pal npcid, retvals(2), pool
END IF
'Shouldn't we check validity of retvals(2) for other data?
IF write_value THEN SetNPCD(npool(pool).npcs(npcid), retvals(1), retvals(2))
lump_reloading.npcd.dirty = YES
END IF
END IF
CASE 79'--show no value
gam.showstring = ""
CASE 80'--current map
scriptret = gam.map.id
CASE 86'--advance text box
advance_text_box
CASE 97'--read map block
retvals(2) = get_optional_arg(2, 0)
IF retvals(2) >= 0 AND retvals(2) <= UBOUND(maptiles) THEN
scriptret = readblock(maptiles(retvals(2)), bound(retvals(0), 0, mapsizetiles.x-1), bound(retvals(1), 0, mapsizetiles.y-1), 0)
END IF
CASE 98'--write map block
retvals(3) = get_optional_arg(3, 0)
IF retvals(3) >= 0 AND retvals(3) <= UBOUND(maptiles) AND retvals(2) >= 0 AND retvals(2) <= 255 THEN
writeblock maptiles(retvals(3)), bound(retvals(0), 0, mapsizetiles.x-1), bound(retvals(1), 0, mapsizetiles.y-1), retvals(2)
lump_reloading.maptiles.dirty = YES
END IF
CASE 99'--read pass block
scriptret = readblock(pass, bound(retvals(0), 0, mapsizetiles.x-1), bound(retvals(1), 0, mapsizetiles.y-1), 0)
CASE 100'--write pass block
'pass isn't known to be the same size as mapsizetiles
writeblock pass, bound(retvals(0), 0, pass.wide - 1), bound(retvals(1), 0, pass.high - 1), bound(retvals(2), 0, 255)
lump_reloading.passmap.dirty = YES
CASE 144'--load tileset(tileset, map layer) or load tileset(tileset) or load tileset()
'Unlike "change tileset", doesn't modify gmap
IF retvals(0) <= gen(genMaxTile) THEN
IF get_optional_arg(1, -1) < 0 THEN
IF retvals(0) < 0 THEN
'Reload all layers back to tilesets defined in gmap(), try to preserve animation states
loadmaptilesets tilesets(), gmap(), NO
ELSE
'Change default tileset. Scan for layers set to use default.
FOR i = 0 TO mapLayerMax
IF gmap(layer_tileset_index(i)) = 0 THEN loadtilesetdata tilesets(), i, retvals(0)
NEXT
END IF
ELSEIF valid_map_layer(retvals(1), serrWarn) AND retvals(0) >= 0 THEN
'Load different tileset for an individual layer.
loadtilesetdata tilesets(), retvals(1), retvals(0)
END IF
'Important to refresh map slices regardless of how the tileset was changed
refresh_map_slice_tilesets
END IF
CASE 305'--change tileset(tileset, layer) or change tileset(tileset) or change tileset()
'Unlike "load tileset" this modifies gmap() for persistent (given map state saving) effects
IF retvals(0) <= gen(genMaxTile) THEN
IF retvals(1) < 0 THEN
IF retvals(0) < 0 THEN
'Reset all tilesets changes made with "load tileset", by reloading from gmap()
'Does NOT reset changes made by "change tileset".
ELSE
'Change default tileset
gmap(0) = retvals(0)
END IF
ELSEIF valid_map_layer(retvals(1), serrWarn) THEN
'Change tileset for an individual layer (-1 changes it to default tilesets)
gmap(layer_tileset_index(retvals(1))) = large(0, retvals(0) + 1)
END IF
lump_reloading.maptiles.dirty = YES 'Tilesets are treated as part of tilemap data, not gmap
'load while trying to preserve animation states
loadmaptilesets tilesets(), gmap(), NO
refresh_map_slice_tilesets
END IF
CASE 151'--show mini map
stop_fibre_timing
minimap heropos(0)
start_fibre_timing
CASE 153'--items menu
stop_fibre_timing
gam.want.box = item_screen()
IF gam.want.box ANDALSO immediate_showtextbox THEN loadsay gam.want.box: gam.want.box = 0
start_fibre_timing
CASE 155, 170'--save menu
'ID 155 is a backcompat hack
stop_fibre_timing
scriptret = picksave() + 1
IF scriptret = -1 THEN scriptret = 0 'Cancelled/Exit
IF scriptret > 0 AND (retvals(0) OR cmdid = 155) THEN
savegame scriptret - 1
END IF
start_fibre_timing
CASE 166'--save in slot
IF valid_save_slot(retvals(0)) THEN
savegame retvals(0) - 1
END IF
CASE 167'--last save slot
scriptret = lastsaveslot
CASE 174'--load from slot(slot, args...)
IF curcmd->argc = 0 THEN
scripterr "load from slot: Expected save slot as argument"
ELSEIF valid_save_slot(retvals(0)) THEN
IF save_slot_used(retvals(0) - 1) THEN
gam.want.loadgame = retvals(0)
' Save extra args
REDIM gam.want.script_args(-1 TO curcmd->argc - 2)
FOR i as integer = 1 TO curcmd->argc - 1
gam.want.script_args(i - 1) = retvals(i)
NEXT
script_start_waiting()
END IF
END IF
CASE 210'--show string
IF valid_plotstr(retvals(0)) THEN
gam.showstring = plotstr(retvals(0)).s
END IF
CASE 234'--load menu (reallyload, show new game)
stop_fibre_timing
' Originally only had one argument; 'show new game' should default to true
retvals(1) = get_optional_arg(1, 1) <> 0
scriptret = pickload(retvals(1)) + 1
IF retvals(0) THEN
'Enact whatever the user picked
IF scriptret = -1 THEN
'Cancelled/Exit
gam.quit = YES
gam.want.dont_quit_to_loadmenu = YES 'don't go straight back to loadmenu!
script_start_waiting()
fadeout uilook(uiFadeoutNewGame)
ELSEIF scriptret > 0 THEN
gam.want.loadgame = scriptret
script_start_waiting()
'ELSEIF scriptret = 0 THEN 'New Game/no saves available (menu skipped)
'Do nothing, script continues
END IF
END IF
start_fibre_timing
CASE 245'--save map state
IF retvals(1) > -1 AND retvals(1) <= 31 THEN
savemapstate_bitmask retvals(1), retvals(0), "state"
ELSEIF retvals(1) = 255 THEN
savemapstate_bitmask gam.map.id, retvals(0), "map"
END IF
CASE 246'--load map state
IF retvals(1) > -1 AND retvals(1) <= 31 THEN
loadmapstate_bitmask retvals(1), retvals(0), "state", YES 'dontfallback=YES
ELSEIF retvals(1) = 255 THEN
loadmapstate_bitmask gam.map.id, retvals(0), "map"
END IF
CASE 247'--reset map state
loadmap_bitmask gam.map.id, retvals(0)
CASE 248'--delete map state
DIM customid as integer = get_optional_arg(1, 255)
IF customid > -1 AND customid <= 31 THEN
deletemapstate customid, retvals(0), "state"
ELSEIF customid = 255 THEN
deletemapstate gam.map.id, retvals(0), "map"
END IF
CASE 253'--set tile animation offset
retvals(2) = get_optional_arg(2, 0)
IF (retvals(0) = 0 OR retvals(0) = 1) AND valid_map_layer(retvals(2), serrBound) THEN
tilesets(retvals(2))->tanim_state(retvals(0)).cycle = retvals(1) MOD 160
END IF
CASE 254'--get tile animation offset
retvals(1) = get_optional_arg(1, 0)
IF (retvals(0) = 0 OR retvals(0) = 1) AND valid_map_layer(retvals(1), serrBound) THEN
scriptret = tilesets(retvals(1))->tanim_state(retvals(0)).cycle
END IF
CASE 255'--animation start tile
retvals(1) = get_optional_arg(1, 0)
IF (retvals(0) >= 0 AND retvals(0) < 256) AND valid_map_layer(retvals(1), serrBound) THEN
scriptret = tile_anim_deanimate_tile(retvals(0), tilesets(retvals(1))->tanim())
END IF
CASE 258'--check hero wall
IF valid_hero_caterpillar_rank(retvals(0)) THEN
DIM as integer tempxgo = 0, tempygo = 0
IF retvals(1) = 0 THEN tempygo = 20
IF retvals(1) = 1 THEN tempxgo = -20
IF retvals(1) = 2 THEN tempygo = -20
IF retvals(1) = 3 THEN tempxgo = 20
scriptret = wrappass(herotx(retvals(0)), heroty(retvals(0)), tempxgo, tempygo, 0)
END IF
CASE 259'--check NPC wall
npcref = getnpcref(retvals(0), 0)
IF npcref >= 0 THEN
'Only check walls for NPC who actually exists
DIM as integer tempxgo = 0, tempygo = 0
IF retvals(1) = 0 THEN tempygo = 20
IF retvals(1) = 1 THEN tempxgo = -20
IF retvals(1) = 2 THEN tempygo = -20
IF retvals(1) = 3 THEN tempxgo = 20
scriptret = wrappass(npc(npcref).x \ 20, npc(npcref).y \ 20, tempxgo, tempygo, 0)
END IF
CASE 267'--main menu
scriptret = add_menu(0)
CASE 274'--open menu
IF bound_arg(retvals(0), 0, gen(genMaxMenu), "menu ID") THEN
scriptret = add_menu(retvals(0), (retvals(1) <> 0))
END IF
CASE 275'--read menu int
IF valid_menu_handle(retvals(0), menuslot) THEN
scriptret = read_menu_int(menus(menuslot), retvals(1))
END IF
CASE 276'--write menu int
IF valid_menu_handle(retvals(0), menuslot) THEN
write_menu_int(menus(menuslot), retvals(1), retvals(2))
mstates(menuslot).need_update = YES
END IF
CASE 277'--read menu item int
IF valid_menu_item_handle_ptr(retvals(0), mi) THEN
scriptret = read_menu_item_int(*mi, retvals(1))
END IF
CASE 278'--write menu item int
IF valid_menu_item_handle_ptr(retvals(0), mi, menuslot) THEN
write_menu_item_int(*mi, retvals(1), retvals(2))
mstates(menuslot).need_update = YES
END IF
CASE 279'--create menu
scriptret = add_menu(-1)
menus(topmenu).allow_gameplay = YES
CASE 280'--close menu (menu, run close script)
IF valid_menu_handle(retvals(0), menuslot) THEN
remove_menu menuslot, get_optional_arg(1, NO) <> 0
END IF
CASE 281'--top menu
IF topmenu >= 0 THEN
scriptret = menus(topmenu).handle
END IF
CASE 282'--bring menu forward
IF valid_menu_handle(retvals(0), menuslot) THEN
bring_menu_forward menuslot
END IF
CASE 283'--add menu item
IF valid_menu_handle(retvals(0), menuslot) THEN
append_menu_item(menus(menuslot), "")
scriptret = assign_menu_item_handle(*menus(menuslot).last)
mstates(menuslot).need_update = YES
END IF
CASE 284'--delete menu item
IF valid_menu_item_handle(retvals(0), menuslot, mislot) THEN
remove_menu_item menus(menuslot), mislot
mstates(menuslot).need_update = YES
END IF
CASE 285'--get menu item caption
IF valid_menu_item_handle_ptr(retvals(0), mi, menuslot) THEN
IF valid_plotstr(retvals(1)) THEN
plotstr(retvals(1)).s = get_menu_item_caption(*mi, menus(menuslot))
END IF
END IF
CASE 286'--set menu item caption
IF valid_menu_item_handle_ptr(retvals(0), mi) THEN
IF valid_plotstr(retvals(1)) THEN
mi->caption = plotstr(retvals(1)).s
END IF
END IF
CASE 287'--get level mp
IF valid_hero_party(retvals(0)) THEN
IF bound_arg(retvals(1), 0, maxMPLevel, "mp level") THEN
retvals(2) = get_optional_arg(2, 0)
IF retvals(2) = 0 THEN
'Current stat
scriptret = gam.hero(retvals(0)).levelmp(retvals(1))
ELSEIF retvals(2) = 1 THEN
'Maximum stat
DIM levelmp(maxMPLevel) as integer
get_max_levelmp(levelmp(), gam.hero(retvals(0)).lev)
scriptret = levelmp(retvals(1))
ELSE
scripterr "getlevelmp: stat type should be currentstat (0) or maximumstat (1), not " & retvals(2), serrBadOp
END IF
END IF
END IF
CASE 288'--set level mp
IF valid_hero_party(retvals(0)) THEN
IF bound_arg(retvals(1), 0, maxMPLevel, "mp level") THEN
gam.hero(retvals(0)).levelmp(retvals(1)) = retvals(2)
END IF
END IF
CASE 289'--bottom menu
IF topmenu >= 0 THEN
scriptret = menus(0).handle
END IF
CASE 290'--previous menu
IF valid_menu_handle(retvals(0), menuslot) THEN
menuslot = menuslot - 1
IF menuslot >= 0 THEN
scriptret = menus(menuslot).handle
END IF
END IF
CASE 291'--next menu
IF valid_menu_handle(retvals(0), menuslot) THEN
menuslot = menuslot + 1
IF menuslot <= topmenu THEN
scriptret = menus(menuslot).handle
END IF
END IF
CASE 292'--menu item by slot
IF valid_menu_handle(retvals(0), menuslot) THEN
scriptret = menu_item_handle_by_slot(menuslot, retvals(1), retvals(2)<>0)
END IF
CASE 293'--previous menu item
IF valid_menu_item_handle(retvals(0), menuslot, mislot) THEN
scriptret = menu_item_handle_by_slot(menuslot, mislot - 1, retvals(1)<>0)
END IF
CASE 294'--next menu item
IF valid_menu_item_handle(retvals(0), menuslot, mislot) THEN
scriptret = menu_item_handle_by_slot(menuslot, mislot + 1, retvals(1)<>0)
END IF
CASE 295'--selected menu item
IF retvals(0) = -1 THEN
IF topmenu >= 0 THEN
scriptret = menu_item_handle_by_slot(topmenu, mstates(topmenu).pt)
END IF
ELSE
IF valid_menu_handle(retvals(0), menuslot) THEN
scriptret = menu_item_handle_by_slot(menuslot, mstates(menuslot).pt)
END IF
END IF
CASE 296'--select menu item
IF valid_menu_item_handle_ptr(retvals(0), mi, menuslot, mislot) THEN
update_menu_item *mi
'Note: you can select hidden items!
'After a tick, the selection should get moved to a valid item.
IF mi->unselectable THEN
'scripterr "Can't select unselectable menu item", serrInfo
ELSE
mstates(menuslot).pt = mislot
mstates(menuslot).need_update = YES
scriptret = 1
END IF
END IF
CASE 297'--parent menu
IF valid_menu_item_handle(retvals(0), menuslot, mislot) THEN
scriptret = menus(menuslot).handle
END IF
CASE 298'--get menu ID
IF valid_menu_handle(retvals(0), menuslot) THEN
scriptret = menus(menuslot).record
END IF
CASE 299'--swap menu items
DIM as integer menuslot2, mislot2
IF valid_menu_item_handle(retvals(0), menuslot, mislot) THEN
IF valid_menu_item_handle(retvals(1), menuslot2, mislot2) THEN
swap_menu_items menus(menuslot), mislot, menus(menuslot2), mislot2
mstates(menuslot).need_update = YES
mstates(menuslot2).need_update = YES
END IF
END IF
CASE 300'--find menu item caption
IF valid_plotstr(retvals(1)) THEN
IF valid_menu_handle(retvals(0), menuslot) THEN
DIM start_slot as integer
IF retvals(2) = 0 THEN
start_slot = 0
ELSE
DIM menuslot2 as integer
IF valid_menu_item_handle(retvals(2), menuslot2, start_slot) = NO THEN
start_slot = -1
ELSEIF menuslot2 <> menuslot THEN
start_slot = -1
scripterr "find menu item caption: 'search after' menu item doesn't belong to the same menu"
ELSE
start_slot += 1
END IF
END IF
IF start_slot >= 0 THEN
mislot = find_menu_item_slot_by_string(menuslot, plotstr(retvals(1)).s, start_slot, (retvals(3) <> 0))
IF mislot >= 0 THEN scriptret = menus(menuslot).items[mislot]->handle
END IF
END IF
END IF
CASE 301'--find menu ID
IF bound_arg(retvals(0), 0, gen(genMaxMenu), "menu ID") THEN
menuslot = find_menu_id(retvals(0))
IF menuslot >= 0 THEN
scriptret = menus(menuslot).handle
ELSE
scriptret = 0
END IF
END IF
CASE 302'--menu is open
menuslot = find_menu_handle(retvals(0))
IF menuslot = -1 THEN
scriptret = 0
ELSE
scriptret = 1
END IF
CASE 303'--menu item slot
IF valid_menu_item_handle(retvals(0), menuslot, mislot) THEN
scriptret = mislot
END IF
CASE 304'--outside battle cure
'WARNING: This exists for backcompat, but "map cure" should be preferred.
'See bug 719
IF valid_attack(retvals(0) + 1) THEN
IF valid_hero_party(retvals(1)) THEN
IF valid_hero_party(retvals(2), -1) THEN
scriptret = ABS(outside_battle_cure(retvals(0), retvals(1), retvals(2), NO))
END IF
END IF
END IF
CASE 306'--layer tileset
IF valid_map_layer(retvals(0), serrBound) THEN
scriptret = tilesets(retvals(0))->num
END IF
CASE 320'--current text box
scriptret = -1
IF txt.showing = YES THEN scriptret = txt.id
IF immediate_showtextbox = NO ANDALSO gam.want.box > 0 THEN scriptret = gam.want.box
CASE 432 '--use menu item
IF valid_menu_item_handle_ptr(retvals(0), mi, menuslot) THEN
activate_menu_item(*mi, menuslot)
END IF
CASE 438 '--reset game
gam.want.resetgame = YES
REDIM gam.want.script_args(-1 TO curcmd->argc - 1)
FOR i as integer = 0 TO curcmd->argc - 1 'flexible argument number!
gam.want.script_args(i) = retvals(i)
NEXT
script_start_waiting()
CASE 490'--use item (id)
scriptret = 0
IF valid_item(retvals(0)) THEN
IF use_item_by_id(retvals(0), gam.want.box) THEN
scriptret = 1
END IF
evalitemtags
tag_updates
IF immediate_showtextbox ANDALSO gam.want.box > 0 THEN loadsay gam.want.box: gam.want.box = 0
END IF
CASE 491'--use item in slot (slot)
scriptret = 0
IF valid_item_slot(retvals(0)) THEN
IF use_item_in_slot(retvals(0), gam.want.box) THEN
scriptret = 1
END IF
evalitemtags
tag_updates
IF immediate_showtextbox ANDALSO gam.want.box > 0 THEN loadsay gam.want.box: gam.want.box = 0
END IF
CASE 517'--menu item by true slot
IF valid_menu_handle(retvals(0), menuslot) THEN
mi = dlist_nth(menus(menuslot).itemlist, retvals(1))
IF mi THEN
scriptret = mi->handle
ELSE
scriptret = 0
END IF
END IF
CASE 518'--menu item true slot
IF valid_menu_item_handle_ptr(retvals(0), mi, menuslot) THEN
scriptret = dlist_find(menus(menuslot).itemlist, mi)
IF scriptret < 0 THEN showbug "menuitemtrueslot: dlist corruption"
END IF
CASE 619'--menu item at pixel
FOR menuslot = topmenu TO 0 STEP -1
mislot = find_menu_item_at_point(mstates(menuslot), XY(retvals(0), retvals(1)))
IF mislot >= mstates(menuslot).first THEN
scriptret = menu_item_handle_by_slot(menuslot, mislot)
EXIT FOR
END IF
NEXT
CASE 623, 624'--check wall collision x/y (pixel x, pixel y, width, height, xgo, ygo, friction)
' It's fine for X/Y to be over the map edge, whether wrapping or not.
IF retvals(2) < 0 OR retvals(3) < 0 THEN
scripterr current_command_name() & ": negative width or height not allowed"
ELSE
DIM friction as integer = bound(get_optional_arg(6, 100), 0, 100)
DIM as XYPair startpos = (retvals(0), retvals(1)), pos
sliding_wallmap_collision(startpos, pos, XY(retvals(2), retvals(3)), XY(retvals(4), retvals(5)), NO, YES, friction)
IF cmdid = 623 THEN
scriptret = pos.x - startpos.x
ELSE
scriptret = pos.y - startpos.y
END IF
END IF
CASE 625'--move slice with wallchecking (sl, xgo, ygo, friction)
sl = get_arg_slice(0)
IF sl THEN
DIM friction as integer = bound(get_optional_arg(3, 100), 0, 100)
RefreshSliceScreenPos sl
WITH *sl
' This will work regardless of what the slice is parented to.
DIM as XYPair startpos = .ScreenPos + XY(mapx, mapy), pos
scriptret = sliding_wallmap_collision(startpos, pos, .Size, XY(retvals(1), retvals(2)), NO, YES, friction)
.Pos += pos - startpos
END WITH
END IF
CASE 671 '--menu item selectable
IF valid_menu_item_handle_ptr(retvals(0), mi) THEN
update_menu_item *mi
scriptret = IIF(mi->visible ANDALSO NOT mi->unselectable, 1, 0)
END IF
CASE 672 '--menu item disabled
IF valid_menu_item_handle_ptr(retvals(0), mi) THEN
update_menu_item *mi
scriptret = IIF(mi->disabled, 1, 0)
ELSE
scriptret = 1
END IF
CASE 673 '--menu item visible
IF valid_menu_item_handle_ptr(retvals(0), mi) THEN
update_menu_item *mi
scriptret = IIF(mi->visible, 1, 0)
ELSE
scriptret = 1
END IF
CASE 135'--put hero
IF valid_hero_caterpillar_rank(retvals(0)) THEN
cropposition retvals(1), retvals(2), 20
(herox(retvals(0))) = retvals(1)
(heroy(retvals(0))) = retvals(2)
END IF
CASE 136'--put npc
npcref = getnpcref(retvals(0), 0)
IF npcref >= 0 THEN
cropposition retvals(1), retvals(2), 20
WITH npc(npcref)
.x = retvals(1)
.y = retvals(2)
update_walkabout_pos .sl, .x, .y, .z
END WITH
END IF
CASE 137'--put camera
gen(genCameraMode) = stopcam
mapx = retvals(0)
mapy = retvals(1)
limitcamera mapx, mapy
CASE 138'--hero pixel x
IF valid_hero_caterpillar_rank(retvals(0)) THEN
scriptret = herox(retvals(0))
END IF
CASE 139'--hero pixel y
IF valid_hero_caterpillar_rank(retvals(0)) THEN
scriptret = heroy(retvals(0))
END IF
CASE 140'--npc pixel x
npcref = getnpcref(retvals(0), 0)
IF npcref >= 0 THEN
scriptret = npc(npcref).x
END IF
CASE 141'--npc pixel y
npcref = getnpcref(retvals(0), 0)
IF npcref >= 0 THEN
scriptret = npc(npcref).y
END IF
CASE 142'--camera pixel x
scriptret = mapx
CASE 143'--camera pixel y
scriptret = mapy
CASE 147'--read general
IF retvals(0) >= 0 AND retvals(0) <= UBOUND(gen) THEN
scriptret = gen(retvals(0))
END IF
CASE 148'--write general
IF retvals(0) >= 0 AND retvals(0) <= UBOUND(gen) THEN
gen(retvals(0)) = retvals(1)
END IF
CASE 159'--init mouse
IF havemouse() THEN scriptret = 1 ELSE scriptret = 0
hidemousecursor
gam.mouse_enabled = YES
CASE 160'--mouse pixel x
scriptret = readmouse().x
CASE 161'--mouse pixel y
scriptret = readmouse().y
CASE 162'--mouse button
IF retvals(0) <= 31 THEN
IF readmouse().buttons AND (2 ^ retvals(0)) THEN scriptret = 1 ELSE scriptret = 0
END IF
CASE 163'--put mouse
movemouse bound(retvals(0), 0, get_resolution().w - 1), bound(retvals(1), 0, get_resolution().h - 1)
CASE 164'--mouse region(xmin, xmax, ymin, ymax)
IF retvals(0) = -1 AND retvals(1) = -1 AND retvals(2) = -1 AND retvals(3) = -1 THEN
mouserect -1, -1, -1, -1
ELSE
retvals(0) = bound(retvals(0), 0, get_resolution().w - 1)
retvals(1) = bound(retvals(1), retvals(0), get_resolution().w - 1)
retvals(2) = bound(retvals(2), 0, get_resolution().h - 1)
retvals(3) = bound(retvals(3), retvals(2), get_resolution().h - 1)
mouserect retvals(0), retvals(1), retvals(2), retvals(3)
END IF
CASE 178'--read gmap
'Don't support reading most gmap indices
IF allow_gmap_idx(retvals(0)) THEN
scriptret = gmap(retvals(0))
END IF
CASE 179'--write gmap
'Don't support changing most gmap indices
IF allow_gmap_idx(retvals(0)) THEN
gmap(retvals(0)) = retvals(1)
IF retvals(0) = 2 OR retvals(0) = 3 THEN update_menu_items 'save and minimap menu options
IF retvals(0) = 4 THEN gam.showtext_ticks = 0 'cancel map name display
IF retvals(0) = 16 THEN refresh_walkabout_layer_sort()
IF retvals(0) = 19 THEN refresh_map_slice() 'map layer visibility
'If changing gmap(31) were allowed (position of walkabout layer), would also need to call refresh_map_slice
lump_reloading.gmap.dirty = YES
END IF
CASE 492'--mouse click
IF retvals(0) <= 4 THEN
IF readmouse().clicks AND (2 ^ retvals(0)) THEN scriptret = 1 ELSE scriptret = 0
END IF
CASE 646'--mouse release
IF retvals(0) <= 4 THEN
IF readmouse().release AND (2 ^ retvals(0)) THEN scriptret = 1 ELSE scriptret = 0
END IF
'old scriptmisc
CASE 0'--noop
scripterr "encountered clean noop", serrInfo
CASE 1'--Wait (cycles)
IF retvals(0) > 0 THEN
script_start_waiting(retvals(0))
END IF
CASE 2'--wait for all
script_start_waiting(retvals(0))
CASE 3'--wait for hero
IF valid_hero_caterpillar_rank(retvals(0)) THEN
script_start_waiting(retvals(0))
END IF
CASE 4'--wait for NPC
IF retvals(0) >= -300 AND retvals(0) <= UBOUND(npool(0).npcs) THEN
script_start_waiting(retvals(0), gam.map.id)
END IF
CASE 5'--suspend npcs
setbit gen(), genSuspendBits, suspendnpcs, 1
CASE 6'--suspend player
setbit gen(), genSuspendBits, suspendplayer, 1
CASE 7'--resume npcs
setbit gen(), genSuspendBits, suspendnpcs, 0
CASE 8'--resume player
setbit gen(), genSuspendBits, suspendplayer, 0
CASE 9, 244'--wait for key, wait for scancode
'waitforkey used to take constants upkey, usekey, etc, which had values 0-5,
'but if scripts_use_cc_scancodes is true, these constants now have values <= -1,
'and can be passed to keyval.
DIM scancode as KBScancode = retvals(0)
IF cmdid = 9 ANDALSO scripts_use_cc_scancodes = NO THEN
'Backcompat: constants >= 0 are 'usekey', etc, not key:.../sc... scancodes
IF scancode >= 0 THEN
IF scancode = 99 THEN
scancode = ccAny
ELSEIF scancode > 5 THEN
'Invalid keycode! Probably used a scancode instead of a *key constant.
'This acts like anykey.
scancode = ccAny
'Not much point showing an error, because if you recompile the problem will
'go away! However, the behaviour will change, so better warn people.
scripterr "You wrongly passed a scancode (eg. key:space) to the 'wait for key' command. This was equivalent to 'anykey', but 'wait for key' now genuinely supports scancodes. if you reimport your scripts, this will wait for that key instead of for anykey.", serrBadOp
ELSE
scancode = ccUp - scancode 'Map to cc* constant other than ccAny
END IF
END IF
END IF
IF valid_key(scancode) THEN
script_start_waiting(scancode)
END IF
CASE 10'--walk hero
IF valid_hero_caterpillar_rank(retvals(0)) THEN
SELECT CASE retvals(1)
CASE 0'--north
(herodir(retvals(0))) = dirNorth
herow(retvals(0)).ygo = retvals(2) * 20
CASE 1'--east
(herodir(retvals(0))) = dirEast
herow(retvals(0)).xgo = (retvals(2) * 20) * -1
CASE 2'--south
(herodir(retvals(0))) = dirSouth
herow(retvals(0)).ygo = (retvals(2) * 20) * -1
CASE 3'--west
(herodir(retvals(0))) = dirWest
herow(retvals(0)).xgo = retvals(2) * 20
END SELECT
END IF
CASE 12'--check tag
scriptret = ABS(istag(retvals(0), 0))
CASE 13'--set tag
IF retvals(0) > 1 THEN
IF retvals(0) <= max_tag() THEN
settag tag(), retvals(0), retvals(1)
ELSE
scripterr "Setting onetime tags with the settag command is deprecated", serrInfo
settag onetime(), retvals(0) - (max_tag()+1), retvals(1)
END IF
tag_updates
END IF
CASE 17'--get item
IF valid_item(retvals(0)) THEN
IF retvals(1) >= 1 THEN
IF getitem(retvals(0), retvals(1)) = YES THEN scriptret = 1
evalitemtags
tag_updates
END IF
END IF
CASE 18'--delete item
IF valid_item(retvals(0)) THEN
IF retvals(1) >= 1 THEN
delitem retvals(0), retvals(1)
evalitemtags
tag_updates
END IF
END IF
CASE 19'--leader
scriptret = herobyrank(0)
CASE 20'--get money
gold = gold + retvals(0)
CASE 21'--lose money
gold = gold - retvals(0)
IF gold < 0 THEN gold = 0
CASE 22'--pay money
IF gold - retvals(0) >= 0 THEN
gold = gold - retvals(0)
scriptret = 1
ELSE
scriptret = 0
END IF
CASE 25'--set hero frame
DIM rank as integer = retvals(0)
IF valid_hero_caterpillar_rank(rank) THEN
'It's not important to bound to a currently valid frame (but .wtog should not be < 0),
'and you can defeat this bound by changing the direction/spriteset. We bound for an
'abundance of backcompat (previously clamped to 0/1), and so that "hero frame" is accurate.
herow(rank).wtog = bound(retvals(1) * wtog_ticks(), 0, max_wtog(herow(rank).sl, herodir(rank)))
END IF
CASE 27'--suspend overlay
setbit gen(), genSuspendBits, suspendoverlay, 1
CASE 28'--play song
'loadsong game + "." + STR(retvals(0))
wrappedsong retvals(0)
CASE 29'--stop song
stopsong
CASE 30'--keyval (scancode, player)
'This used to be keyispressed; which undocumentedly reported two bits
'instead of true/false.
a_script_wants_keys()
DIM player as integer = get_optional_arg(1, 0)
'keyval() reports a 3rd bit, but didn't at the time that this command was (re-)documented
scriptret = script_keyval(retvals(0), player) AND 3
CASE 31'--rank in caterpillar
scriptret = rankincaterpillar(retvals(0))
CASE 38'--camera follows hero
gen(genCameraMode) = herocam
gen(genCameraArg1) = bound(retvals(0), 0, active_party_slots - 1)
CASE 40'--pan camera
gen(genCameraMode) = pancam
gen(genCameraArg1) = bound(retvals(0), 0, active_party_slots - 1)
gen(genCameraArg2) = large(retvals(1), 0) * (20 / large(retvals(2), 1))
gen(genCameraArg3) = large(retvals(2), 1)
CASE 41'--focus camera
gen(genCameraMode) = focuscam
gen(genCameraArg1) = (retvals(0) * 20) - (get_resolution().w - 20) / 2
gen(genCameraArg2) = (retvals(1) * 20) - (get_resolution().h - 20) / 2
gen(genCameraArg3) = ABS(retvals(2))
gen(genCameraArg4) = ABS(retvals(2))
limitcamera gen(genCameraArg1), gen(genCameraArg2)
CASE 42'--wait for camera
script_start_waiting(retvals(0))
CASE 43'--hero x
IF valid_hero_caterpillar_rank(retvals(0)) THEN
scriptret = herotx(retvals(0))
END IF
CASE 44'--hero y
IF valid_hero_caterpillar_rank(retvals(0)) THEN
scriptret = heroty(retvals(0))
END IF
CASE 47'--suspend obstruction
setbit gen(), genSuspendBits, suspendobstruction, 1
CASE 48'--resume obstruction
setbit gen(), genSuspendBits, suspendobstruction, 0
CASE 49'--suspend hero walls
setbit gen(), genSuspendBits, suspendherowalls, 1
CASE 50'--suspend NPC walls
setbit gen(), genSuspendBits, suspendnpcwalls, 1
CASE 51'--resume hero walls
setbit gen(), genSuspendBits, suspendherowalls, 0
CASE 53'--set hero direction
IF valid_hero_caterpillar_rank(retvals(0)) THEN
(herodir(retvals(0))) = ABS(retvals(1)) MOD 4
END IF
CASE 57, 118'--suspend caterpillar
setbit gen(), genSuspendBits, suspendcaterpillar, 1
CASE 58, 119'--resume caterpillar
setbit gen(), genSuspendBits, suspendcaterpillar, 0
interpolatecat ()
CASE 59'--wait for text box
IF readbit(gen(), genSuspendBits, suspendboxadvance) = 0 THEN
script_start_waiting(retvals(0))
END IF
CASE 60'--equip where
scriptret = 0
IF valid_item(retvals(1)) THEN
IF valid_hero_party(retvals(0)) THEN
loaditemdata buffer(), retvals(1)
DIM hero_id as integer = gam.hero(retvals(0)).id
IF hero_id >= 0 THEN
IF item_read_equipbit(buffer(), hero_id) THEN
' It's equippable; return slot+1 for the first equippable slot
FOR i as integer = 0 to 4
IF item_is_equippable_in_slot(buffer(), i) THEN scriptret = i + 1
NEXT i
END IF
END IF
END IF
END IF
CASE 62, 168'--suspend random enemies
setbit gen(), genSuspendBits, suspendrandomenemies, 1
'--resume random enemies is not here! it works different!
CASE 65'--resume overlay
setbit gen(), genSuspendBits, suspendoverlay, 0
CASE 70'--room in active party
scriptret = active_party_slots() - active_party_size()
CASE 71'--lock hero
DIM hero_slot as integer = findhero(retvals(0), , serrWarn)
IF hero_slot > -1 THEN gam.hero(hero_slot).locked = YES
CASE 72'--unlock hero
DIM hero_slot as integer = findhero(retvals(0), , serrWarn)
IF hero_slot > -1 THEN gam.hero(hero_slot).locked = NO
CASE 74'--set death script
gen(genGameoverScript) = large(retvals(0), 0)
CASE 75'--fade screen out
FOR i as integer = 0 TO 2
'Convert from 0-63 -> 0-255
retvals(i) = bound(IIF(retvals(i), retvals(i) * 4 + 3, 0), 0, 255)
NEXT
stop_fibre_timing
fadeout retvals(0), retvals(1), retvals(2)
start_fibre_timing
IF gam.need_fade_in ANDALSO gam.fade_in_script_overridable THEN
'For backwards compatibility, if a fade delay has been increased so that a
'fadescreenout that used to occur after a queued fade now happens before,
'that queued fade needs to be cancelled so that the screen stays faded until
'the corresponding fadescreenin.
gam.need_fade_in = NO
END IF
CASE 76'--fade screen in
IF vpages_are_32bit() ANDALSO masterpal_has_changed(master()) THEN
'We can't fade between two master palettes (not even out and in) in 32-bit color mode,
'so bit of a hack to provide good backcompat: an implicit wait, mostly pause the game
'logic, redraw the scene, and blend between old and new page
queue_fade_in
gam.need_fade_page = YES
script_start_waiting(0)
ELSE
stop_fibre_timing
fadein
start_fibre_timing
IF gam.need_fade_in AND gam.fade_in_delay <= 0 THEN
'Avoid unnecessary pause
gam.need_fade_in = NO
END IF
END IF
CASE 81'--set hero speed
IF valid_hero_caterpillar_rank(retvals(0)) THEN
change_hero_speed(retvals(0), bound(retvals(1), 0, 20))
END IF
CASE 82'--inventory
scriptret = countitem(retvals(0))
CASE 84'--suspend box advance
setbit gen(), genSuspendBits, suspendboxadvance, 1
CASE 85'--resume box advance
setbit gen(), genSuspendBits, suspendboxadvance, 0
CASE 87'--set hero position
IF valid_hero_caterpillar_rank(retvals(0)) THEN
cropposition retvals(1), retvals(2), 1
resetcaterpillar_for_one_hero retvals(0), retvals(1) * 20, retvals(2) * 20
END IF
CASE 90'--find hero
scriptret = findhero(retvals(0))
CASE 91'--check equipment
IF valid_hero_party(retvals(0)) THEN
scriptret = gam.hero(retvals(0)).equip(bound(retvals(1) - 1, 0, 4)).id
ELSE
scriptret = 0
END IF
CASE 92'--days of play
scriptret = gen(genDays)
CASE 93'--hours of play
scriptret = gen(genHours)
CASE 94'--minutes of play
scriptret = gen(genMinutes)
CASE 95'--resume NPC walls
setbit gen(), genSuspendBits, suspendnpcwalls, 0
CASE 96'--set hero Z
(heroz(bound(retvals(0), 0, 3))) = retvals(1)
CASE 102'--hero direction
IF valid_hero_caterpillar_rank(retvals(0)) THEN
scriptret = herodir(retvals(0))
END IF
CASE 103'--reset palette
gam.current_master_palette = gen(genMasterPal)
load_master_and_uicol gam.current_master_palette
CASE 104'--tweak palette
IF bound_arg(retvals(3), 0, 255, "start pal index") THEN
IF bound_arg(retvals(4), 0, 255, "end pal index") THEN
tweakpalette retvals(0), retvals(1), retvals(2), retvals(3), retvals(4)
END IF
END IF
CASE 105'--read color
IF retvals(0) >= 0 AND retvals(0) < 256 THEN
IF retvals(1) = 0 THEN scriptret = master(retvals(0)).r / 4
IF retvals(1) = 1 THEN scriptret = master(retvals(0)).g / 4
IF retvals(1) = 2 THEN scriptret = master(retvals(0)).b / 4
END IF
CASE 106'--write color
IF retvals(0) >= 0 AND retvals(0) < 256 THEN
DIM col as integer = bound(retvals(2), 0, 63)
IF retvals(1) = 0 THEN master(retvals(0)).r = iif(col, col * 4 + 3, 0)
IF retvals(1) = 1 THEN master(retvals(0)).g = iif(col, col * 4 + 3, 0)
IF retvals(1) = 2 THEN master(retvals(0)).b = iif(col, col * 4 + 3, 0)
END IF
CASE 107'--update palette
setpal master()
CASE 108'--seed random
IF retvals(0) THEN
reseed_prng retvals(0)
ELSE
reseed_prng TIMER * 1e9
END IF
CASE 109'--greyscale palette
greyscalepal
CASE 114'--read global
IF retvals(0) >= 0 AND retvals(0) <= maxScriptGlobals THEN
scriptret = global(retvals(0))
ELSE
scripterr "readglobal: Cannot read global " & retvals(0) & ". Out of range", serrBadOp
END IF
CASE 115'--write global
IF retvals(0) >= 0 AND retvals(0) <= maxScriptGlobals THEN
global(retvals(0)) = retvals(1)
ELSE
scripterr "writeglobal: Cannot write global " & retvals(0) & ". Out of range", serrBadOp
END IF
CASE 116'--hero is walking
IF valid_hero_caterpillar_rank(retvals(0)) THEN
'Both scripted and user pathfinding count as walking
'Note that when holding down an arrow key we will return false at the end of
'every step, not so when pathfinding or doing a long "walk hero"
IF herow(retvals(0)).xygo <> 0 ORELSE hero_is_pathfinding(retvals(0)) THEN
scriptret = 1
END IF
IF readbit(gen(), genSuspendBits, suspendcaterpillar) = 0 THEN
' Other heroes trail behind the leader automatically without using .xgo and .ygo.
' walkhero partially works when the caterpillar party is enabled too
' (well they move, but don't animate), so combine the two
IF herow(0).xygo <> 0 ORELSE hero_is_pathfinding(0) THEN
scriptret = 1
END IF
END IF
END IF
CASE 127'--teach spell
scriptret = trylearn(bound(retvals(0), 0, 40), retvals(1))
CASE 128'--forget spell
scriptret = 0
retvals(0) = bound(retvals(0), 0, 40)
FOR i as integer = 0 TO 3
FOR j as integer = 0 TO 23
IF gam.hero(retvals(0)).spells(i, j) = retvals(1) THEN
gam.hero(retvals(0)).spells(i, j) = 0
scriptret = 1
END IF
NEXT j
NEXT i
CASE 129'--read spell
IF valid_hero_party(retvals(0)) AND retvals(1) >= 0 AND retvals(1) <= 3 AND retvals(2) >= 0 AND retvals(2) <= 23 THEN
scriptret = gam.hero(retvals(0)).spells(retvals(1), retvals(2))
ELSE
scriptret = 0
END IF
CASE 130'--write spell
IF valid_hero_party(retvals(0)) AND retvals(1) >= 0 AND retvals(1) <= 3 AND retvals(2) >= 0 AND retvals(2) <= 23 AND retvals(3) >= 0 THEN
gam.hero(retvals(0)).spells(retvals(1), retvals(2)) = retvals(3)
END IF
CASE 131'--knows spell
scriptret = 0
retvals(0) = bound(retvals(0), 0, 40)
IF retvals(1) > 0 THEN
FOR i as integer = 0 TO 3
FOR j as integer = 0 TO 23
IF gam.hero(retvals(0)).spells(i, j) = retvals(1) THEN
scriptret = 1
EXIT FOR
END IF
NEXT j
NEXT i
END IF
CASE 132'--can learn spell
scriptret = 0
DIM partyslot as integer
DIM heroID as integer
partyslot = bound(retvals(0), 0, 40)
heroID = gam.hero(partyslot).id
IF heroID = -1 THEN
scripterr "can learn spell: fail on empty party slot " & partyslot, serrBound
ELSE
IF retvals(1) > 0 THEN
DIM her as HeroDef
loadherodata her, heroID
FOR i as integer = 0 TO 3
FOR j as integer = 0 TO 23
IF gam.hero(partyslot).spells(i, j) = 0 THEN
IF her.spell_lists(i,j).attack = retvals(1) AND her.spell_lists(i,j).learned = retvals(2) THEN
scriptret = 1
EXIT FOR
END IF
END IF
NEXT j
NEXT i
END IF
END IF
CASE 133'--hero by slot
IF valid_hero_party(retvals(0)) THEN
scriptret = gam.hero(retvals(0)).id
ELSE
scriptret = -1
END IF
CASE 134'--hero by rank
scriptret = herobyrank(retvals(0))
CASE 145'--pick hero
DIM stringid as integer = get_optional_arg(0, -1)
DIM skip_if_alone as bool = get_optional_arg(1, NO) <> 0
IF stringid = -1 ORELSE valid_plotstr(stringid, serrBadOp) THEN
DIM prompt as string
IF stringid = -1 THEN
prompt = readglobalstring(135, "Which Hero?", 20)
ELSE
prompt = plotstr(stringid).s
END IF
scriptret = onwho(prompt, skip_if_alone)
ELSE
scriptret = -1
END IF
CASE 146'--rename hero by slot
IF valid_hero_party(retvals(0)) THEN
IF gam.hero(retvals(0)).id >= 0 THEN
scriptret = IIF(renamehero(retvals(0), YES), 1, 0)
END IF
END IF
CASE 171'--save slot used
IF valid_save_slot(retvals(0)) THEN
IF save_slot_used(retvals(0) - 1) THEN scriptret = 1 ELSE scriptret = 0
END IF
CASE 172'--import globals
'If the save slot isn't used, this zeroes out the globals, and shows no error
IF valid_save_slot(retvals(0)) THEN
IF retvals(1) = -1 THEN 'importglobals(slot)
retvals(1) = 0
retvals(2) = maxScriptGlobals
END IF
IF retvals(1) >= 0 AND retvals(1) <= maxScriptGlobals THEN
IF retvals(2) = -1 THEN 'importglobals(slot,id)
DIM remval as integer = global(retvals(1))
loadglobalvars retvals(0) - 1, retvals(1), retvals(1)
scriptret = global(retvals(1))
global(retvals(1)) = remval
ELSE 'importglobals(slot,first,last)
IF retvals(2) <= maxScriptGlobals AND retvals(1) <= retvals(2) THEN
loadglobalvars retvals(0) - 1, retvals(1), retvals(2)
END IF
END IF
END IF
END IF
CASE 173'--export globals
IF valid_save_slot(retvals(0)) THEN
IF retvals(1) >= 0 AND retvals(2) <= maxScriptGlobals AND retvals(1) <= retvals(2) THEN
saveglobalvars retvals(0) - 1, retvals(1), retvals(2)
END IF
END IF
CASE 175'--delete save
IF valid_save_slot(retvals(0)) THEN
erase_save_slot retvals(0) - 1
END IF
CASE 176'--run script by id
DIM rsr as RunScriptResult
DIM argc as integer = curcmd->argc 'Must store before calling runscript
rsr = runscript(retvals(0), NO, NO, "runscriptbyid")
IF rsr = rsSuccess THEN
'--fill heap with arguments
FOR i as integer = 1 TO argc - 1 'flexible argument number!
setScriptArg i - 1, retvals(i)
NEXT i
'NOTE: scriptret is not set here when this command is successful. The return value of the called script will be returned.
ELSE
scripterr "run script by id failed loading " & retvals(0), serrMajor
scriptret = -1
END IF
CASE 180'--map width([map])
'map width did not originally have an argument
DIM map_id as integer = get_optional_arg(0, -1)
IF map_id = -1 ORELSE map_id = gam.map.id THEN
scriptret = mapsizetiles.x
ELSE
IF valid_map(map_id) THEN
DIM as TilemapInfo mapsize
GetTilemapInfo maplumpname(map_id, "t"), mapsize
scriptret = mapsize.wide
END IF
END IF
CASE 181'--map height([map])
'map height did not originally have an argument
DIM map_id as integer = get_optional_arg(0, -1)
IF map_id = -1 ORELSE map_id = gam.map.id THEN
scriptret = mapsizetiles.y
ELSE
IF valid_map(map_id) THEN
DIM as TilemapInfo mapsize
GetTilemapInfo maplumpname(map_id, "t"), mapsize
scriptret = mapsize.high
END IF
END IF
CASE 187'--get music volume
scriptret = get_music_volume * 255
CASE 188'--set music volume
set_music_volume bound(retvals(0), 0, 255) / 255
CASE 189, 307'--get formation song
IF retvals(0) >= 0 AND retvals(0) <= gen(genMaxFormation) THEN
DIM form as Formation
LoadFormation form, retvals(0)
scriptret = form.music
IF cmdid = 189 THEN scriptret += 1
END IF
CASE 190'--set formation song
'set formation song never worked, so don't bother with backwards compatibility
IF retvals(0) >= 0 AND retvals(0) <= gen(genMaxFormation) AND retvals(1) >= -2 AND retvals(1) <= gen(genMaxSong) THEN
DIM form as Formation
LoadFormation form, retvals(0)
form.music = retvals(1)
SaveFormation form, retvals(0)
ELSE
scriptret = -1
END IF
CASE 191'--hero frame
IF valid_hero_caterpillar_rank(retvals(0)) THEN
'Note that this can be beyond the last frame, if the direction or spriteset just changed.
scriptret = wtog_to_frame(herow(retvals(0)).wtog)
END IF
CASE 195'--load sound (BACKWARDS COMPATABILITY HACK )
'This opcode is not exposed in plotscr.hsd and should not be used in any new scripts
IF retvals(0) >= 0 AND retvals(0) <= 7 THEN
backcompat_sound_slot_mode = YES
backcompat_sound_slots(retvals(0)) = retvals(1) + 1
END IF
CASE 196'--free sound (BACKWARDS COMPATABILITY HACK)
'This opcode is not exposed in plotscr.hsd and should not be used in any new scripts
IF retvals(0) >= 0 AND retvals(0) <= 7 THEN
backcompat_sound_slots(retvals(0)) = 0
END IF
CASE 197'--play sound
DIM sfxid as integer = backcompat_sound_id(retvals(0))
IF sfxid >= 0 AND sfxid <= gen(genMaxSFX) THEN
if retvals(2) then stopsfx sfxid
playsfx sfxid, IIF(retvals(1) <> 0, -1, 0)
scriptret = -1
END IF
CASE 198'--pause sound
IF retvals(0) >= 0 AND retvals(0) <= gen(genMaxSFX) THEN
pausesfx retvals(0)
scriptret = -1
END IF
CASE 199'--stop sound
IF retvals(0) >= 0 AND retvals(0) <= gen(genMaxSFX) THEN
stopsfx retvals(0)
scriptret = -1
END IF
CASE 200'--system hour (TIME is always hh:mm:ss)
scriptret = str2int(MID(TIME, 1, 2))
CASE 201'--system minute
scriptret = str2int(MID(TIME, 4, 2))
CASE 202'--system second
scriptret = str2int(MID(TIME, 7, 2))
CASE 203'--current song
IF gam.music_change_delay > 0 THEN
'If a music change is queued pretend it has already happened, to avoid confusion and
'problems (including compatability) in map autorun scripts
scriptret = gam.delayed_music
ELSE
scriptret = presentsong
END IF
CASE 204'--get hero name(str,her)
IF valid_plotstr(retvals(0)) ANDALSO valid_hero_party(retvals(1)) THEN
plotstr(retvals(0)).s = gam.hero(retvals(1)).name
scriptret = 1
ELSE
scriptret = 0
END IF
CASE 205'--set hero name
IF valid_plotstr(retvals(0)) ANDALSO valid_hero_party(retvals(1)) THEN
gam.hero(retvals(1)).name = plotstr(retvals(0)).s
scriptret = 1
ELSE
scriptret = 0
END IF
CASE 206'--get item name(str,itm)
scriptret = 0
IF valid_plotstr(retvals(0)) THEN
IF valid_item(retvals(1)) THEN
plotstr(retvals(0)).s = readitemname(retvals(1))
scriptret = 1
END IF
END IF
CASE 207'--get map name(str,map)
IF valid_plotstr(retvals(0)) = NO ORELSE valid_map(retvals(1)) = NO THEN
scriptret = 0
ELSE
plotstr(retvals(0)).s = getmapname(retvals(1))
scriptret = 1
END IF
CASE 208'--get attack name(str,atk)
'WARNING: backcompat only. new games should prefer read attack name
IF valid_plotstr(retvals(0)) = NO OR retvals(1) + 1 < 0 OR retvals(1) + 1 > gen(genMaxAttack) THEN
scriptret = 0
ELSE
plotstr(retvals(0)).s = readattackname(retvals(1) + 1)
scriptret = 1
END IF
CASE 209'--get global string(str,glo)
'This command is basically unusable without a table of constants, it has almost certainly never been used.
'Maybe someday it will be replaced - we can't add 'setglobalstring' unless the length is encoded in the offset constant.
IF valid_plotstr(retvals(0)) = NO OR retvals(1) < 0 OR retvals(1) > 309 THEN
scriptret = 0
ELSE
plotstr(retvals(0)).s = readglobalstring(retvals(1), "", 255)
scriptret = 1
END IF
CASE 211'--clear string
IF valid_plotstr(retvals(0)) THEN plotstr(retvals(0)).s = ""
CASE 212'--append ascii
IF valid_plotstr(retvals(0)) ANDALSO retvals(1) >= 0 ANDALSO retvals(1) <= 255 THEN
WITH plotstr(retvals(0))
.s &= CHR(retvals(1))
scriptret = LEN(.s)
END WITH
END IF
CASE 213'--append number (id, value, minlength, zeropad)
IF valid_plotstr(retvals(0)) THEN
DIM byref thestring as string = plotstr(retvals(0)).s
DIM minlength as integer = get_optional_arg(2, 0) 'Can be negative
IF ABS(minlength) > 1 THEN
DIM zeropad as bool = get_optional_arg(3, NO)
DIM fmt as string = "%"
IF zeropad THEN fmt &= "0" ' This has no effect if minlength is negative
fmt &= minlength & "d"
thestring &= strprintf(fmt, retvals(1))
ELSE
thestring &= retvals(1)
END IF
scriptret = LEN(thestring)
END IF
CASE 214'--copy string
IF valid_plotstr(retvals(0)) ANDALSO valid_plotstr(retvals(1)) THEN
plotstr(retvals(0)).s = plotstr(retvals(1)).s
END IF
CASE 215'--concatenate strings
IF valid_plotstr(retvals(0)) ANDALSO valid_plotstr(retvals(1)) THEN
plotstr(retvals(0)).s += plotstr(retvals(1)).s
scriptret = LEN(plotstr(retvals(0)).s)
END IF
CASE 216'--string length
IF valid_plotstr(retvals(0)) THEN
scriptret = LEN(plotstr(retvals(0)).s)
END IF
CASE 217'--delete char
IF valid_plotstr(retvals(0)) THEN
IF retvals(1) >= 1 AND retvals(1) <= LEN(plotstr(retvals(0)).s) THEN
WITH plotstr(retvals(0))
.s = LEFT(.s, retvals(1) - 1) & MID(.s, retvals(1) + 1)
END WITH
END IF
END IF
CASE 218'--replace char
IF valid_plotstr(retvals(0)) ANDALSO retvals(2) >= 0 ANDALSO retvals(2) <= 255 THEN
IF retvals(1) >= 1 AND retvals(1) <= LEN(plotstr(retvals(0)).s) THEN
MID(plotstr(retvals(0)).s, retvals(1), 1) = CHR(retvals(2))
END IF
END IF
CASE 219'--ascii from string
IF valid_plotstr(retvals(0)) ANDALSO retvals(1) >= 1 ANDALSO retvals(1) <= LEN(plotstr(retvals(0)).s) THEN
scriptret = plotstr(retvals(0)).s[retvals(1)-1]'you can index strings a la C
END IF
CASE 220'--position string
IF valid_plotstr(retvals(0)) THEN
plotstr(retvals(0)).X = retvals(1)
plotstr(retvals(0)).Y = retvals(2)
END IF
CASE 221'--set string bit
IF valid_plotstr(retvals(0)) ANDALSO retvals(1) >= 0 ANDALSO retvals(1) <= 15 THEN
IF retvals(2) THEN
plotstr(retvals(0)).bits OR= 2 ^ retvals(1)
ELSE
plotstr(retvals(0)).bits AND= NOT 2 ^ retvals(1)
END IF
END IF
CASE 222'--get string bit
IF valid_plotstr(retvals(0)) ANDALSO retvals(1) >= 0 ANDALSO retvals(1) <= 15 THEN
'scriptret = readbit(plotstrBits(), retvals(0), retvals(1))
scriptret = IIF(plotstr(retvals(0)).bits AND 2 ^ retvals(1), 1, 0)
END IF
CASE 223'--string color
IF valid_plotstr(retvals(0)) THEN
plotstr(retvals(0)).col = bound(retvals(1), -1, 255) 'Allow -1 for default
plotstr(retvals(0)).bgcol = bound(retvals(2), 0, 255)
END IF
CASE 224'--string X
IF valid_plotstr(retvals(0)) THEN
scriptret = plotstr(retvals(0)).X
END IF
CASE 225'--string Y
IF valid_plotstr(retvals(0)) THEN
scriptret = plotstr(retvals(0)).Y
END IF
CASE 226'--system day (date is always mm-dd-yyyy)
scriptret = str2int(MID(DATE, 4, 2))
CASE 227'--system month
scriptret = str2int(MID(DATE, 1, 2))
CASE 228'--system year
scriptret = str2int(MID(DATE, 7, 4))
CASE 229'--string compare
IF valid_plotstr(retvals(0)) AND valid_plotstr(retvals(1)) THEN
scriptret = IIF(plotstr(retvals(0)).s = plotstr(retvals(1)).s, 1, 0)
END IF
CASE 230'--read enemy data
'Boy, was this command a bad idea!
'106 was the largest used offset until very recently, so we'll limit it there to
'prevent further damage
'Note: elemental/enemytype bits no longer exist (should still be able to read them
'from old games, though)
'Note: this used to be used by "get enemy name" script to read names, could become
'a problem when the name storage changes
IF valid_enemy(retvals(0)) ANDALSO bound_arg(retvals(1), 0, 106, "data index", , serrBadOp) THEN
scriptret = ReadShort(tmpdir & "dt1.tmp", retvals(0) * getbinsize(binDT1) + retvals(1) * 2 + 1)
END IF
CASE 231'--write enemy data
'Boy, was this command a bad idea!
'106 was the largest used offset until very recently, so we'll limit it there to
'prevent further damage
'Note: writing elemental/enemytype bits no longer works
'Note: this used to be used by "set enemy name" script to write names, could become
'a problem when the name storage changes
IF valid_enemy(retvals(0)) ANDALSO bound_arg(retvals(1), 0, 106, "data index", , serrBadOp) THEN
'Show an error if out of range, but be lenient and continue anyway, capping
'stats (and other data...) to 32767
bound_arg(retvals(2), -32768, 32767, "value")
retvals(2) = bound(retvals(2), -32768, 32767)
WriteShort(tmpdir & "dt1.tmp", retvals(0) * getbinsize(binDT1) + retvals(1) * 2 + 1, retvals(2))
END IF
CASE 737'--reset enemy data
IF valid_enemy(retvals(0)) ANDALSO bound_arg(retvals(1), 0, 106, "data index", , serrBadOp) THEN
DIM offset as integer = retvals(0) * getbinsize(binDT1) + retvals(1) * 2 + 1
WriteShort(tmpdir & "dt1.tmp", offset, ReadShort(game & ".dt1", offset))
END IF
CASE 232'--trace
IF valid_plotstr(retvals(0)) THEN
'PRINT will print to the window if using gfx_fb, so use puts instead
IF gam.print_trace THEN puts cstring(plotstr(retvals(0)).s)
IF gam.print_trace_only = NO THEN debug "TRACE: " + plotstr(retvals(0)).s
END IF
CASE 233'--get song name
IF valid_plotstr(retvals(0)) AND retvals(1) >= 0 THEN
plotstr(retvals(0)).s = getsongname(retvals(1))
END IF
CASE 235'--key is pressed (scancode, player)
a_script_wants_keys()
IF script_keyval(retvals(0), retvals(1)) THEN scriptret = 1 ELSE scriptret = 0
CASE 236'--sound is playing
DIM sfxid as integer = backcompat_sound_id(retvals(0))
IF sfxid >= 0 AND sfxid <= gen(genMaxSFX) THEN
scriptret = sfxisplaying(sfxid)
END IF
CASE 237'--sound slots (BACKWARDS COMPATABILITY HACK)
'This opcode is not exposed in plotscr.hsd and should not be used in any new scripts
IF backcompat_sound_slot_mode THEN
scriptret = 8
END IF
CASE 238'--search string
IF valid_plotstr(retvals(0)) ANDALSO valid_plotstr(retvals(1)) THEN
WITH plotstr(retvals(0))
scriptret = INSTR(bound(retvals(2), 1, LEN(.s)), .s, plotstr(retvals(1)).s)
END WITH
ELSE
scriptret = 0
END IF
CASE 239'--trim string (id, start, len) or (id)
IF valid_plotstr(retvals(0)) THEN
WITH plotstr(retvals(0))
DIM start as integer = retvals(1)
IF start = -1 THEN 'start/len omitted
'Note: don't trim \r, because we can still use that character for any purpose
.s = TRIM(.s, ANY !" \n\t")
ELSE
start = large(start, 1) 'TRIM returns "" if start <= 0
.s = MID(.s, start, retvals(2))
END IF
END WITH
END IF
CASE 240'-- string from textbox (string, box, line, ignored) [obsolete]
IF valid_plotstr(retvals(0)) THEN
DIM box as TextBox
retvals(1) = bound(retvals(1), 0, gen(genMaxTextbox))
LoadTextBox box, retvals(1)
retvals(2) = bound(retvals(2), 0, UBOUND(box.text))
plotstr(retvals(0)).s = TRIM(box.text(retvals(2)))
embedtext plotstr(retvals(0)).s
END IF
CASE 241'-- expand string(id, saveslot)
retvals(1) = get_optional_arg(1, 0)
IF valid_plotstr(retvals(0)) THEN
'Retvals(1) can be 0 for the default of using current game state, or a save slot 1-maxSaveSlotCount
IF retvals(1) = 0 ORELSE valid_save_slot(retvals(1)) THEN
embedtext plotstr(retvals(0)).s, , retvals(1) - 1
END IF
scriptret = retvals(0)
END IF
CASE 242'-- joystick button(button, player)
DIM button as integer = retvals(0)
IF button >= scJoyButton1 ANDALSO button <= scJoyButton32 THEN button -= scJoyOFFSET
IF bound_arg(button, 1, 32, "button number 1-32 or joy:... scancode") ANDALSO valid_player_num(retvals(1)) THEN
DIM key as KeyBits = player_keyval(scJoyOFFSET + button, retvals(1))
scriptret = IIF(key > 0, 1, 0)
END IF
CASE 243'-- joystick axis(axis, scale, player)
IF valid_player_num(retvals(2)) THEN
scriptret = (joystick_axis(retvals(0), retvals(2)) / 1000) * retvals(1)
END IF
CASE 249'--party money
scriptret = gold
CASE 250'--set money
IF retvals(0) >= 0 THEN gold = retvals(0)
CASE 251'--set string from table
IF bound_arg(retvals(0), 0, UBOUND(plotstr), "string ID", !"$# = \"...\"") THEN
plotstr(retvals(0)).s = script_string_constant(nowscript, retvals(1))
scriptret = retvals(0)
END IF
CASE 252'--append string from table
IF bound_arg(retvals(0), 0, UBOUND(plotstr), "string ID", !"$# + \"...\"") THEN
plotstr(retvals(0)).s += script_string_constant(nowscript, retvals(1))
scriptret = retvals(0)
END IF
CASE 256'--suspend map music
setbit gen(), genSuspendBits, suspendambientmusic, 1
CASE 257'--resume map music
setbit gen(), genSuspendBits, suspendambientmusic, 0
CASE 260'--set timer(id, count, speed, trigger, string, flags)
'All args except id default to -1 (default)
IF bound_arg(retvals(0), 0, UBOUND(timers), "timer ID") THEN
WITH timers(retvals(0))
IF retvals(1) > -1 THEN .count = retvals(1): .ticks = 0
IF retvals(2) > -1 THEN
.speed = retvals(2)
ELSEIF retvals(2) = -1 AND .speed = 0 THEN
.speed = 18
END IF
IF retvals(3) <> -1 ANDALSO .trigger <> retvals(3) THEN
'When changing the trigger, any script args are forgotten
ERASE .script_args
.trigger = retvals(3)
END IF
IF retvals(4) <> -1 THEN
IF valid_plotstr(retvals(4)) THEN .st = retvals(4) + 1
END IF
IF .st > 0 THEN plotstr(.st - 1).s = seconds2str(.count)
IF retvals(5) <> -1 THEN .flags = retvals(5)
IF .speed < -1 THEN .speed *= -1: .speed -= 1
END WITH
END IF
CASE 261'--stop timer
IF bound_arg(retvals(0), 0, UBOUND(timers), "timer ID") THEN
timers(retvals(0)).speed = 0
END IF
CASE 262'--read timer
IF bound_arg(retvals(0), 0, UBOUND(timers), "timer ID") THEN
scriptret = timers(retvals(0)).count
END IF
CASE 263'--get color
IF retvals(0) >= 0 AND retvals(0) < 256 THEN
scriptret = master(retvals(0)).col
END IF
CASE 264'--set color
IF retvals(0) >= 0 AND retvals(0) < 256 THEN
WITH master(retvals(0))
.col = retvals(1)
.a = 255 'just in case, set the alpha
END WITH
END IF
CASE 265'--rgb
scriptret = RGB(bound(retvals(0),0,255), bound(retvals(1),0,255), bound(retvals(2),0,255))
CASE 266'--extract color
DIM c as RGBcolor = TYPE(retvals(0))
SELECT CASE retvals(1)
CASE 0 : scriptret = c.r
CASE 1 : scriptret = c.g
CASE 2 : scriptret = c.b
CASE 3 : scriptret = c.a 'No use yet
END SELECT
CASE 268'--load palette
IF retvals(0) >= 0 AND retvals(0) <= gen(genMaxMasterPal) THEN
gam.current_master_palette = retvals(0)
load_master_and_uicol gam.current_master_palette
END IF
CASE 273'--milliseconds
' We shift the zero point so that negative return values don't occur unless the
' game has been open 24 days. Do this because on Windows TIMER seems to reset when
' you reboot, making it unlikely that people will ever test their game with negative
' milliseconds.
scriptret = fmod(((TIMER - gam.timer_offset) * 1000) + 2147483648.0, 4294967296.0) - 2147483648.0
CASE 308'--add enemy to formation (formation, enemy id, x, y, slot = -1)
scriptret = -1
IF valid_formation(retvals(0)) ANDALSO valid_enemy(retvals(1)) THEN
DIM form as Formation
LoadFormation form, retvals(0)
DIM slot as integer = -1
FOR i as integer = 0 TO 7
IF form.slots(i).id = -1 THEN slot = i: EXIT FOR
NEXT
IF retvals(4) >= 0 AND retvals(4) <= 7 THEN
IF form.slots(retvals(4)).id = -1 THEN slot = retvals(4)
END IF
IF slot >= 0 THEN
DIM size as XYPair = get_enemy_sprite_size(retvals(1))
WITH form.slots(slot)
.id = retvals(1)
' Convert to top-left coord
.pos.x = retvals(2) - size.w \ 2
.pos.y = retvals(3) - size.h
' These are the same limits as used in the formation editors;
' they allow placing an enemy anywhere onscreen (or just off).
' Note: 0,0 is not necessarily the top-left of the screen
DIM bounds as RectPoints = get_formation_bounds()
.pos = bound(.pos, bounds.topleft - size, bounds.bottomright)
END WITH
END IF
SaveFormation form, retvals(0)
scriptret = slot
END IF
CASE 309'--find enemy in formation (formation, enemy id, number)
IF valid_formation(retvals(0)) THEN
DIM form as Formation
LoadFormation form, retvals(0)
DIM slot as integer = 0
scriptret = -1
FOR i as integer = 0 TO UBOUND(form.slots)
IF form.slots(i).id >= 0 AND (retvals(1) = form.slots(i).id OR retvals(1) = -1) THEN
IF retvals(2) = slot THEN scriptret = i: EXIT FOR
slot += 1
END IF
NEXT
IF retvals(2) = -1 THEN scriptret = slot
END IF
CASE 310'--delete enemy from formation (formation, slot)
IF valid_formation_slot(retvals(0), retvals(1)) THEN
DIM form as Formation
LoadFormation form, retvals(0)
form.slots(retvals(1)).id = -1
SaveFormation form, retvals(0)
END IF
CASE 311'--formation slot enemy (formation, slot)
scriptret = -1
IF valid_formation_slot(retvals(0), retvals(1)) THEN
DIM form as Formation
LoadFormation form, retvals(0)
scriptret = form.slots(retvals(1)).id
END IF
CASE 312, 313'--formation slot x (formation, slot), formation slot y (formation, slot)
IF valid_formation_slot(retvals(0), retvals(1)) THEN
DIM form as Formation
LoadFormation form, retvals(0)
DIM enemy_id as integer = form.slots(retvals(1)).id
scriptret = form.slots(retvals(1)).pos.n(cmdid - 312)
'now find the position of the bottom center of the enemy sprite
IF enemy_id >= 0 THEN
DIM size as XYPair = get_enemy_sprite_size(enemy_id)
IF cmdid = 312 THEN scriptret += size.x \ 2 ELSE scriptret += size.y
END IF
END IF
CASE 314'--set formation background (formation, background, animation frames, animation ticks)
IF valid_formation(retvals(0)) AND retvals(1) >= 0 AND retvals(1) <= gen(genNumBackdrops) - 1 THEN
DIM form as Formation
LoadFormation form, retvals(0)
form.background = retvals(1)
form.background_frames = bound(retvals(2), 1, 50)
form.background_ticks = bound(retvals(3), 0, 1000)
SaveFormation form, retvals(0)
END IF
CASE 315'--get formation background (formation)
IF valid_formation(retvals(0)) THEN
DIM form as Formation
LoadFormation form, retvals(0)
scriptret = form.background
END IF
CASE 316'--last formation
scriptret = lastformation
CASE 317'--random formation (formation set)
IF retvals(0) >= 1 AND retvals(0) <= 255 THEN
scriptret = random_formation(retvals(0))
END IF
CASE 318'--formation set frequency (formation set)
IF retvals(0) >= 1 AND retvals(0) <= 255 THEN
DIM formset as FormationSet
LoadFormationSet formset, retvals(0)
scriptret = formset.frequency
END IF
CASE 319'--formation probability (formation set, formation)
IF retvals(0) >= 1 AND retvals(0) <= 255 THEN
DIM formset as FormationSet
LoadFormationSet formset, retvals(0)
DIM slot as integer = 0
scriptret = 0
FOR i as integer = 0 TO UBOUND(formset.formations)
IF formset.formations(i) = retvals(1) THEN scriptret += 1
IF formset.formations(i) >= 0 THEN slot += 1
NEXT
'probability in percentage points
IF slot > 0 THEN scriptret = (scriptret * 100) / slot
END IF
CASE 321'--get hero speed (hero)
IF valid_hero_caterpillar_rank(retvals(0)) THEN
scriptret = herow(retvals(0)).speed
END IF
CASE 322'--load hero sprite
scriptret = load_sprite_plotslice(0, retvals(0), retvals(1))
CASE 323, 361'--free sprite, free slice
IF retvals(0) = 0 THEN
'No warning
ELSE
'serrWarn causes get_arg_slice/get_handle_slice to not show an error if already freed
sl = get_arg_slice(0, serrWarn)
IF sl THEN
IF sl->Protect THEN
slice_bad_op sl, "is protected, can't be deleted"
ELSEIF cmdid = 323 ANDALSO sl->SliceType <> slSprite THEN
slice_bad_op sl, "isn't a sprite"
ELSE
DeleteSlice @sl
END IF
END IF
END IF
CASE 324 '--put slice (previously place sprite, which is now a separate command)
sl = get_arg_slice(0)
IF sl THEN
sl->X = retvals(1)
sl->Y = retvals(2)
END IF
CASE 326 '--set sprite palette
sl = get_arg_slice(0)
IF sl THEN
ChangeSpriteSlice sl, , , retvals(1)
END IF
CASE 327 '--replace hero sprite
replace_sprite_plotslice 0, 0, retvals(1), retvals(2)
CASE 328 '--set sprite frame
sl = get_arg_slice(0)
IF sl THEN
ChangeSpriteSlice sl, , , , retvals(1)
END IF
CASE 558'--set sprite set number
sl = get_arg_slice(0)
IF sl THEN
ChangeSpriteSlice sl, , retvals(1)
END IF
CASE 329'--load walkabout sprite
scriptret = load_sprite_plotslice(4, retvals(0), retvals(1))
CASE 330 '--replace walkabout sprite
replace_sprite_plotslice 0, 4, retvals(1), retvals(2)
CASE 331'--load weapon sprite
scriptret = load_sprite_plotslice(5, retvals(0), retvals(1))
CASE 332 '--replace weapon sprite
replace_sprite_plotslice 0, 5, retvals(1), retvals(2)
CASE 333'--load small enemy sprite
scriptret = load_sprite_plotslice(1, retvals(0), retvals(1))
CASE 334 '--replace small enemy sprite
replace_sprite_plotslice 0, 1, retvals(1), retvals(2)
CASE 335'--load medium enemy sprite
scriptret = load_sprite_plotslice(2, retvals(0), retvals(1))
CASE 336 '--replace medium enemy sprite
replace_sprite_plotslice 0, 2, retvals(1), retvals(2)
CASE 337'--load large enemy sprite
scriptret = load_sprite_plotslice(3, retvals(0), retvals(1))
CASE 338 '--replace large enemy sprite
replace_sprite_plotslice 0, 3, retvals(1), retvals(2)
CASE 339'--load attack sprite
scriptret = load_sprite_plotslice(6, retvals(0), retvals(1))
CASE 340 '--replace attack sprite
replace_sprite_plotslice 0, 6, retvals(1), retvals(2)
CASE 341'--load border sprite
scriptret = load_sprite_plotslice(7, retvals(0), retvals(1))
CASE 342 '--replace border sprite
replace_sprite_plotslice 0, 7, retvals(1), retvals(2)
CASE 343'--load portrait sprite
scriptret = load_sprite_plotslice(8, retvals(0), retvals(1))
CASE 344 '--replace portrait sprite
replace_sprite_plotslice 0, 8, retvals(1), retvals(2)
CASE 345 '--clone sprite
sl = get_arg_spritesl(0)
IF sl THEN
DIM newsl as Slice Ptr
newsl = NewSliceOfType(slSprite, SliceTable.scriptsprite)
'Only sprite data is copied!
sl->Clone(sl, newsl)
scriptret = create_plotslice_handle(newsl)
END IF
CASE 346 '--get sprite frame
sl = get_arg_spritesl(0)
IF sl THEN
scriptret = sl->SpriteData->frame
END IF
CASE 347 '--sprite frame count
sl = get_arg_spritesl(0)
IF sl THEN
scriptret = sl->SpriteData->get_num_frames(sl)
END IF
CASE 348 '--slice x
sl = get_arg_slice(0)
IF sl THEN scriptret = sl->X
CASE 349 '--slice y
sl = get_arg_slice(0)
IF sl THEN scriptret = sl->Y
CASE 350 '--set slice x
sl = get_arg_slice(0)
IF sl THEN sl->X = retvals(1)
CASE 351 '--set slice y
sl = get_arg_slice(0)
IF sl THEN sl->Y = retvals(1)
CASE 352 '--slice width
sl = get_arg_slice(0)
IF sl THEN scriptret = sl->Width
CASE 353 '--slice height
sl = get_arg_slice(0)
IF sl THEN scriptret = sl->Height
CASE 354 '--set horiz align
sl = get_arg_slice(0)
IF sl THEN
IF bound_arg(retvals(1), 0, 2, "edge:... constant", , serrBadOp) THEN
sl->AlignHoriz = retvals(1)
END IF
END IF
CASE 355 '--set vert align
sl = get_arg_slice(0)
IF sl THEN
IF bound_arg(retvals(1), 0, 2, "edge:... constant", , serrBadOp) THEN
sl->AlignVert = retvals(1)
END IF
END IF
CASE 356 '--set horiz anchor
sl = get_arg_slice(0)
IF sl THEN
IF bound_arg(retvals(1), 0, 2, "edge:... constant", , serrBadOp) THEN
sl->AnchorHoriz = retvals(1)
END IF
END IF
CASE 357 '--set vert anchor
sl = get_arg_slice(0)
IF sl THEN
IF bound_arg(retvals(1), 0, 2, "edge:... constant", , serrBadOp) THEN
sl->AnchorVert = retvals(1)
END IF
END IF
CASE 358 '--number from string
IF valid_plotstr(retvals(0)) THEN
scriptret = str2int(plotstr(retvals(0)).s, retvals(1))
END IF
CASE 359 '--slice is sprite
sl = get_arg_slice(0)
IF sl THEN
scriptret = IIF(sl->SliceType = slSprite, 1, 0)
END IF
CASE 360 '--sprite layer
scriptret = find_plotslice_handle(SliceTable.ScriptSprite)
CASE 362 '--first child
sl = get_arg_slice(0)
IF sl THEN
scriptret = find_plotslice_handle(sl->FirstChild)
END IF
CASE 363 '--next sibling
sl = get_arg_slice(0)
IF sl THEN
scriptret = find_plotslice_handle(sl->NextSibling)
END IF
CASE 364 '--create container
sl = NewSliceOfType(slContainer, SliceTable.scriptsprite)
sl->Width = retvals(0)
sl->Height = retvals(1)
scriptret = create_plotslice_handle(sl)
CASE 365 '--set parent
DIM parent as Slice ptr
sl = get_arg_slice(0)
parent = get_arg_slice(1)
IF sl ANDALSO parent THEN
IF sl->Protect THEN
slice_bad_op sl, "is protected, can't be reparented"
ELSE
SetSliceParent sl, parent
END IF
END IF
CASE 366 '--check parentage
DIM ancestor as Slice ptr
sl = get_arg_slice(0)
ancestor = get_arg_slice(1)
IF sl ANDALSO ancestor THEN
IF IsAncestor(sl, ancestor) THEN scriptret = 1
END IF
CASE 367 '--slice screen x
sl = get_arg_slice(0)
IF sl THEN
RefreshSliceScreenPos sl
scriptret = sl->ScreenX + SliceXAnchor(sl)
END IF
CASE 368 '--slice screen y
sl = get_arg_slice(0)
IF sl THEN
RefreshSliceScreenPos sl
scriptret = sl->ScreenY + SliceYAnchor(sl)
END IF
CASE 369 '--slice is container
sl = get_arg_slice(0)
IF sl THEN
scriptret = IIF(sl->SliceType = slContainer, 1, 0)
END IF
CASE 370 '--create rect
sl = NewSliceOfType(slRectangle, SliceTable.scriptsprite)
sl->Width = retvals(0)
sl->Height = retvals(1)
IF bound_arg(retvals(2), -1, 14, "style") THEN
ChangeRectangleSlice sl, retvals(2)
END IF
scriptret = create_plotslice_handle(sl)
CASE 371 '--slice is rect
sl = get_arg_slice(0)
IF sl THEN
scriptret = IIF(sl->SliceType = slRectangle, 1, 0)
END IF
CASE 372 '--set slice width
sl = get_arg_resizeable_slice(0, NO, YES)
IF sl THEN
sl->Width = retvals(1)
END IF
CASE 373 '--set slice height
sl = get_arg_resizeable_slice(0, YES, NO)
IF sl THEN
sl->Height = retvals(1)
END IF
CASE 374 '--get rect style
sl = get_arg_rectsl(0)
IF sl THEN
scriptret = sl->RectData->style
END IF
CASE 375 '--set rect style
sl = get_arg_rectsl(0)
IF sl ANDALSO bound_arg(retvals(1), -1, 14, "style") THEN
ChangeRectangleSlice sl, retvals(1)
END IF
CASE 376 '--get rect fgcol
sl = get_arg_rectsl(0)
IF sl THEN
scriptret = sl->RectData->fgcol
END IF
CASE 377 '--set rect fgcol
sl = get_arg_rectsl(0)
IF sl ANDALSO valid_color(retvals(1)) THEN
ChangeRectangleSlice sl, , , retvals(1)
END IF
CASE 378 '--get rect bgcol
sl = get_arg_rectsl(0)
IF sl THEN
scriptret = sl->RectData->bgcol
END IF
CASE 379 '--set rect bgcol
sl = get_arg_rectsl(0)
IF sl ANDALSO valid_color(retvals(1)) THEN
ChangeRectangleSlice sl, , retvals(1)
END IF
CASE 380 '--get rect border
sl = get_arg_rectsl(0)
IF sl THEN
IF sl->RectData->use_raw_box_border THEN
scriptret = -99 'border:raw
ELSE
scriptret = sl->RectData->border
END IF
END IF
CASE 381 '--set rect border
sl = get_arg_rectsl(0)
IF sl ANDALSO bound_arg(retvals(1), -2, 14, "border") THEN 'border:raw not allowed
ChangeRectangleSlice sl, , , , retvals(1)
END IF
CASE 382 '--get rect trans
sl = get_arg_rectsl(0)
IF sl THEN
scriptret = sl->RectData->translucent
END IF
CASE 383 '--set rect trans
sl = get_arg_rectsl(0)
IF sl ANDALSO bound_arg(retvals(1), 0, transLAST, "trans:... transparency setting") THEN
ChangeRectangleSlice sl, , , , , retvals(1)
END IF
CASE 384 '--slice collide point
sl = get_arg_slice(0)
IF sl THEN
RefreshSliceScreenPos sl
scriptret = ABS(SliceCollidePoint(sl, XY(retvals(1), retvals(2))))
END IF
CASE 385 '--slice collide
DIM sl2 as Slice ptr
sl = get_arg_slice(0)
sl2 = get_arg_slice(1)
IF sl ANDALSO sl2 THEN
RefreshSliceScreenPos sl
RefreshSliceScreenPos sl2
scriptret = IIF(SliceCollide(sl, sl2), 1, 0)
END IF
CASE 386 '--slice contains
DIM sl2 as Slice ptr
sl = get_arg_slice(0)
sl2 = get_arg_slice(1)
IF sl ANDALSO sl2 THEN
scriptret = IIF(SliceContains(sl, sl2), 1, 0)
END IF
CASE 387 '--clamp slice (sl, within sl)
DIM within_sl as Slice ptr
sl = get_arg_slice(0)
within_sl = get_arg_slice(1)
IF sl ANDALSO within_sl THEN
SliceClamp within_sl, sl 'Opposite arg order...
END IF
CASE 388 '--horiz flip sprite
sl = get_arg_spritesl(0)
IF sl THEN
ChangeSpriteSlice sl, , , , , retvals(1)
END IF
CASE 389 '--vert flip sprite
sl = get_arg_spritesl(0)
IF sl THEN
ChangeSpriteSlice sl, , , , , , retvals(1)
END IF
CASE 390 '--sprite is horiz flipped
sl = get_arg_spritesl(0)
IF sl THEN
scriptret = IIF(sl->SpriteData->flipHoriz, 1, 0)
END IF
CASE 391 '--sprite is vert flipped
sl = get_arg_spritesl(0)
IF sl THEN
scriptret = IIF(sl->SpriteData->flipVert, 1, 0)
END IF
CASE 392 '--set top padding
sl = get_arg_slice(0)
IF sl THEN
sl->PaddingTop = retvals(1)
END IF
CASE 393 '--get top padding
sl = get_arg_slice(0)
IF sl THEN
scriptret = sl->PaddingTop
END IF
CASE 394 '--set left padding
sl = get_arg_slice(0)
IF sl THEN
sl->PaddingLeft = retvals(1)
END IF
CASE 395 '--get left padding
sl = get_arg_slice(0)
IF sl THEN
scriptret = sl->PaddingLeft
END IF
CASE 396 '--set bottom padding
sl = get_arg_slice(0)
IF sl THEN
sl->PaddingBottom = retvals(1)
END IF
CASE 397 '--get bottom padding
sl = get_arg_slice(0)
IF sl THEN
scriptret = sl->PaddingBottom
END IF
CASE 398 '--set right padding
sl = get_arg_slice(0)
IF sl THEN
sl->PaddingRight = retvals(1)
END IF
CASE 399 '--get right padding
sl = get_arg_slice(0)
IF sl THEN
scriptret = sl->PaddingRight
END IF
CASE 400 '--fill parent
sl = get_arg_resizeable_slice(0, YES, YES)
IF sl THEN
'FIXME: need to ensure we don't clash with Cover Children by disabling
'that as appropriate. See SliceLegalCoverModes.
'TODO: there's no command to change slice fill mode!
sl->Fill = (retvals(1) <> 0)
END IF
CASE 401 '--is filling parent
sl = get_arg_slice(0)
IF sl THEN
scriptret = IIF(sl->Fill, 1, 0)
END IF
CASE 402 '--slice to front
sl = get_arg_slice(0)
IF sl THEN
SetSliceParent sl, sl->Parent
END IF
CASE 403 '--slice to back
sl = get_arg_slice(0)
IF sl THEN
IF sl->Parent = 0 THEN
scripterr "slice to back: invalid on root slice", serrBadOp
ELSE
InsertSliceBefore sl->Parent->FirstChild, sl
END IF
END IF
CASE 404 '--last child
sl = get_arg_slice(0)
IF sl THEN
scriptret = find_plotslice_handle(sl->LastChild)
END IF
CASE 405 '--y sort children
sl = get_arg_slice(0)
IF sl THEN
YSortChildSlices sl
END IF
CASE 406 '--set sort order
sl = get_arg_slice(0)
IF sl THEN
sl->Sorter = retvals(1)
END IF
CASE 407 '--sort children
sl = get_arg_slice(0)
IF sl THEN
CustomSortChildSlices sl, retvals(1)
END IF
CASE 408 '--previous sibling
sl = get_arg_slice(0)
IF sl THEN
scriptret = find_plotslice_handle(sl->PrevSibling)
END IF
CASE 409 '--get sort order
sl = get_arg_slice(0)
IF sl THEN
scriptret = sl->Sorter
END IF
CASE 410 '--get slice extra (sl, extra)
sl = get_arg_slice(0)
'More efficient to call get_extra directly than use sl->Extra wrapper
IF sl THEN scriptret = get_extra(sl->ExtraVec, retvals(1))
CASE 411 '--set slice extra (sl, extra, val)
sl = get_arg_slice(0)
IF sl THEN set_extra sl->ExtraVec, retvals(1), retvals(2)
CASE 412 '--get sprite type
sl = get_arg_slice(0)
IF sl THEN
IF sl->SliceType = slSprite THEN
scriptret = sl->SpriteData->spritetype
ELSE
scriptret = -1
END IF
END IF
CASE 413 '--get sprite set number
sl = get_arg_spritesl(0)
IF sl THEN
scriptret = sl->SpriteData->record
END IF
CASE 414 '--get sprite palette
sl = get_arg_spritesl(0)
IF sl THEN
IF sl->SpriteData->paletted = NO THEN
slice_bad_op sl, "is unpaletted", serrWarn
scriptret = -1
ELSE
scriptret = sl->SpriteData->pal
END IF
END IF
CASE 415 '--suspend timers
setbit gen(), genSuspendBits, suspendtimers, 1
CASE 416 '--resume timers
setbit gen(), genSuspendBits, suspendtimers, 0
CASE 325, 417 '--set sprite visible, set slice visible
sl = get_arg_slice(0)
IF sl THEN
sl->Visible = (retvals(1) <> 0)
END IF
CASE 418 '--get slice visible
sl = get_arg_slice(0)
IF sl THEN
scriptret = IIF(sl->Visible, 1, 0)
END IF
CASE 419 '--slice edge x
sl = get_arg_slice(0)
IF sl THEN
IF bound_arg(retvals(1), 0, 2, "edge") THEN
scriptret = sl->X - SliceXAnchor(sl) + SliceEdgeX(sl, retvals(1))
END IF
END IF
CASE 420 '--slice edge y
sl = get_arg_slice(0)
IF sl THEN
IF bound_arg(retvals(1), 0, 2, "edge") THEN
scriptret = sl->Y - SliceYAnchor(sl) + SliceEdgeY(sl, retvals(1))
END IF
END IF
CASE 421 '--create text
sl = NewSliceOfType(slText, SliceTable.scriptsprite)
scriptret = create_plotslice_handle(sl)
CASE 422 '--set slice text (slice, string)
sl = get_arg_textsl(0)
IF sl ANDALSO valid_plotstr(retvals(1)) THEN
ChangeTextSlice sl, plotstr(retvals(1)).s
END IF
CASE 423 '--get text color
sl = get_arg_textsl(0)
IF sl THEN
scriptret = sl->TextData->col
END IF
CASE 424 '--set text color
sl = get_arg_textsl(0)
IF sl ANDALSO valid_color(retvals(1)) THEN
ChangeTextSlice sl, , retvals(1)
END IF
CASE 425 '--get wrap
sl = get_arg_textsl(0)
IF sl THEN
scriptret = IIF(sl->TextData->wrap, 1, 0)
END IF
CASE 426 '--set wrap
sl = get_arg_textsl(0)
IF sl THEN
ChangeTextSlice sl, , , , (retvals(1) <> 0)
END IF
CASE 427 '--slice is text
sl = get_arg_slice(0)
IF sl THEN
scriptret = IIF(sl->SliceType = slText, 1, 0)
END IF
CASE 428 '--get text bg
sl = get_arg_textsl(0)
IF sl THEN
scriptret = sl->TextData->bgcol
END IF
CASE 429 '--set text bg
sl = get_arg_textsl(0)
IF sl ANDALSO valid_color(retvals(1)) THEN
ChangeTextSlice sl, , , , , retvals(1)
END IF
CASE 430 '--get outline
sl = get_arg_textsl(0)
IF sl THEN
scriptret = IIF(sl->TextData->outline, 1, 0)
END IF
CASE 431 '--set outline
sl = get_arg_textsl(0)
IF sl THEN
ChangeTextSlice sl, , , (retvals(1) <> 0)
END IF
CASE 433'--slice at pixel(parent, x, y, num, descend, visibleonly)
sl = get_arg_slice(0)
'visibleonly is recent addition
retvals(5) = get_optional_arg(5, 0)
IF sl THEN
' We update sl and its ancestors, FindSliceAtPoint updates its descendents.
RefreshSliceScreenPos sl
IF retvals(3) <= -1 THEN
DIM slnum as integer = -1
FindSliceAtPoint(sl, XY(retvals(1), retvals(2)), slnum, retvals(4), retvals(5))
scriptret = -slnum - 1
ELSE
DIM slnum as integer = retvals(3) ' Avoid modification to retvals
scriptret = find_plotslice_handle(FindSliceAtPoint(sl, XY(retvals(1), retvals(2)), slnum, retvals(4), retvals(5)))
END IF
END IF
CASE 434'--find colliding slice(parent, sl, num, descend, visibleonly)
DIM parent as Slice ptr
parent = get_arg_slice(0)
sl = get_arg_slice(1)
retvals(4) = get_optional_arg(4, 0)
IF parent ANDALSO sl THEN
' We update the slices and their ancestors, FindSliceCollision updates parent's descendents.
RefreshSliceScreenPos parent
RefreshSliceScreenPos sl
IF retvals(2) <= -1 THEN
DIM slnum as integer = -1
FindSliceCollision(parent, sl, slnum, retvals(3), retvals(4))
scriptret = -slnum - 1
ELSE
DIM slnum as integer = retvals(2) ' Avoid modification to retvals
scriptret = find_plotslice_handle(FindSliceCollision(parent, sl, slnum, retvals(3), retvals(4)))
END IF
END IF
CASE 435'--parent slice, aka slice parent
sl = get_arg_slice(0)
IF sl THEN
scriptret = find_plotslice_handle(sl->Parent)
END IF
CASE 436'--child count
sl = get_arg_slice(0)
IF sl THEN
scriptret = sl->NumChildren
END IF
CASE 437'--lookup slice (lookup, root)
IF retvals(1) = 0 THEN
'--search the whole slice tree
scriptret = find_plotslice_handle(LookupSlice(retvals(0), SliceTable.Root))
ELSE
'--search starting from a certain slice
sl = get_arg_slice(1)
IF sl THEN
scriptret = find_plotslice_handle(LookupSlice(retvals(0), sl))
END IF
END IF
CASE 439'--slice is valid
sl = get_arg_slice(0, serrIgnore)
scriptret = IIF(sl, 1, 0)
CASE 440'--item in slot
IF valid_item_slot(retvals(0)) THEN
IF inventory(retvals(0)).used = NO THEN
scriptret = -1
ELSE
scriptret = inventory(retvals(0)).id
END IF
END IF
CASE 441'--set item in slot
IF valid_item_slot(retvals(0)) THEN
IF retvals(1) = -1 THEN
WITH inventory(retvals(0))
.used = NO
.id = 0
.num = 0
END WITH
ELSEIF valid_item(retvals(1)) THEN
WITH inventory(retvals(0))
.id = retvals(1)
IF .num < 1 OR .used = NO THEN .num = 1
.used = YES
DIM stacksize as integer = get_item_stack_size(.id)
IF .num > stacksize THEN 'overflow the stack
DIM spare as integer = .num - stacksize
.num = stacksize
getitem retvals(1), spare
END IF
END WITH
END IF
update_inventory_caption retvals(0)
evalitemtags
tag_updates
END IF
CASE 442'--item count in slot
IF valid_item_slot(retvals(0)) THEN
IF inventory(retvals(0)).used = NO THEN
scriptret = 0
ELSE
scriptret = inventory(retvals(0)).num
END IF
END IF
CASE 443'--set item count in slot
IF valid_item_slot(retvals(0)) THEN
WITH inventory(retvals(0))
IF retvals(1) = 0 THEN
.used = NO
.id = 0
.num = 0
ELSEIF .used = NO THEN
scripterr "set item count in slot: can't set count for empty slot " & retvals(0), serrBound
ELSE
DIM stacksize as integer = get_item_stack_size(.id)
IF bound_arg(retvals(1), 1, stacksize, "item count") THEN
.num = retvals(1)
END IF
END IF
END WITH
update_inventory_caption retvals(0)
evalitemtags
tag_updates
END IF
CASE 444 '--put sprite, place sprite
sl = get_arg_spritesl(0)
IF sl THEN
sl->X = retvals(1)
sl->Y = retvals(2)
END IF
CASE 446 '--move slice below
DIM as Slice ptr sl0 = get_arg_slice(0), sl1 = get_arg_slice(1)
IF sl0 ANDALSO sl1 THEN
IF sl0 = sl1 THEN
slice_bad_op sl0, "tried to move $SL below itself"
ELSEIF sl0->Protect ANDALSO sl0->Parent <> sl1->Parent THEN
slice_bad_op sl0, "tried to change the parent of protected $SL"
ELSEIF sl1->Parent = NULL THEN
scripterr "moveslicebelow: Root can't have siblings"
ELSE
InsertSliceBefore sl1, sl0
END IF
END IF
CASE 447 '--move slice above
DIM as Slice ptr sl0 = get_arg_slice(0), sl1 = get_arg_slice(1)
IF sl0 ANDALSO sl1 THEN
IF sl0 = sl1 THEN
slice_bad_op sl0, "tried to move $SL above itself"
ELSEIF sl0->Protect ANDALSO sl0->Parent <> sl1->Parent THEN
slice_bad_op sl0, "tried to change the parent of protected $SL"
ELSEIF sl1->Parent = NULL THEN
scripterr "movesliceabove: Root can't have siblings"
ELSE
InsertSliceAfter sl1, sl0
END IF
END IF
CASE 448 '--slice child
sl = get_arg_slice(0)
IF sl THEN
scriptret = find_plotslice_handle(SliceChildByIndex(sl, retvals(1)))
END IF
CASE 451 '--set slice clipping
sl = get_arg_slice(0)
IF sl THEN
sl->Clip = (retvals(1) <> 0)
END IF
CASE 452 '--get slice clipping
sl = get_arg_slice(0)
IF sl THEN
scriptret = IIF(sl->Clip, 1, 0)
END IF
CASE 453 '--create grid
sl = NewSliceOfType(slGrid, SliceTable.scriptsprite)
scriptret = create_plotslice_handle(sl)
sl->Width = retvals(0)
sl->Height = retvals(1)
ChangeGridSlice sl, retvals(2), retvals(3)
CASE 454 '--slice is grid
sl = get_arg_slice(0)
IF sl THEN
scriptret = IIF(sl->SliceType = slGrid, 1, 0)
END IF
CASE 455 '--set grid columns
sl = get_arg_gridsl(0)
IF sl THEN
ChangeGridSlice sl, , retvals(1)
END IF
CASE 456 '--get grid columns
sl = get_arg_gridsl(0)
IF sl THEN
scriptret = sl->GridData->cols
END IF
CASE 457 '--set grid rows
sl = get_arg_gridsl(0)
IF sl THEN
ChangeGridSlice sl, retvals(1)
END IF
CASE 458 '--get grid rows
sl = get_arg_gridsl(0)
IF sl THEN
scriptret = sl->GridData->rows
END IF
CASE 459 '--show grid
sl = get_arg_gridsl(0)
IF sl THEN
sl->GridData->show = (retvals(1) <> 0)
END IF
CASE 460 '--grid is shown
sl = get_arg_gridsl(0)
IF sl THEN
scriptret = IIF(sl->GridData->show, 1, 0)
END IF
CASE 461 '--load slice collection
IF bound_arg(retvals(0), 0, 32767, "id") THEN
sl = LoadSliceCollection(SL_COLLECT_USERDEFINED, retvals(0))
IF sl THEN
'If the collection was partially loaded, we showed an error but continue
SetSliceParent sl, SliceTable.scriptsprite
scriptret = create_plotslice_handle(sl)
END IF
END IF
CASE 462 '--set slice edge x
sl = get_arg_slice(0)
IF sl THEN
IF bound_arg(retvals(1), 0, 2, "edge") THEN
sl->X = retvals(2) + SliceXAnchor(sl) - SliceEdgeX(sl, retvals(1))
END IF
END IF
CASE 463 '--set slice edge y
sl = get_arg_slice(0)
IF sl THEN
IF bound_arg(retvals(1), 0, 2, "edge") THEN
sl->Y = retvals(2) + SliceYAnchor(sl) - SliceEdgeY(sl, retvals(1))
END IF
END IF
CASE 464 '--get slice lookup
sl = get_arg_slice(0)
IF sl THEN
scriptret = sl->Lookup
END IF
CASE 465 '--set slice lookup
sl = get_arg_slice(0)
IF sl THEN
IF retvals(1) < 0 THEN
scripterr current_command_name() & ": negative lookup codes are reserved, they can't be set.", serrBadOp
ELSEIF sl->Lookup < 0 THEN
slice_bad_op sl, "is a special slice, can't modify its lookup"
ELSE
sl->Lookup = retvals(1)
END IF
END IF
CASE 466 '--trace value internal (string, value, ...)
DIM result as string
FOR i as integer = 0 TO curcmd->argc - 1
IF i MOD 2 = 0 THEN
IF i <> 0 THEN result &= ", "
result &= script_string_constant(nowscript, retvals(i)) & " = "
ELSE
result &= retvals(i)
END IF
NEXT
IF gam.print_trace THEN puts cstring(result)
IF gam.print_trace_only = NO THEN debug "TRACE: " & result
CASE 467 '--map cure (replaces "outside battle cure")
IF bound_arg(retvals(0), 1, gen(genMaxAttack)+1, "attack ID") THEN
IF valid_hero_party(retvals(1)) THEN
IF valid_hero_party(retvals(2), -1) THEN
'If the attack can not target dead heroes, then this fails and returns false
scriptret = ABS(outside_battle_cure(retvals(0) - 1, retvals(1), retvals(2), NO))
END IF
END IF
END IF
CASE 468 '--read attack name(str, id+1) (replaces "get attack name")
scriptret = 0
IF valid_plotstr(retvals(0)) AND valid_attack(retvals(1)) THEN
plotstr(retvals(0)).s = readattackname(retvals(1) - 1)
scriptret = 1
END IF
CASE 470'--allocate timers
IF bound_arg(retvals(0), 0, 100000, "number of timers", , serrBadOp) THEN
REDIM PRESERVE timers(large(0, retvals(0) - 1))
IF retvals(0) = 0 THEN
'Unfortunately, have to have at least one timer. Deactivate/blank it, in case the user
'wants "allocate timers(0)" to kill all timers.
REDIM timers(0)
END IF
END IF
/' Disabled until an alternative ("new timer") is decided upon
CASE 471'--unused timer
scriptret = -1
FOR i as integer = 0 TO UBOUND(timers)
IF timers(i).speed <= 0 THEN
scriptret = i
WITH timers(scriptret)
.speed = 0
.ticks = 0
.count = 0
.st = 0
.trigger = 0
.flags = 0
END WITH
EXIT FOR
END IF
NEXT
IF scriptret = -1 THEN
scriptret = UBOUND(timers) + 1
IF scriptret < 100000 THEN
REDIM PRESERVE timers(scriptret)
END IF
END IF
'/
CASE 480'--read zone (id, x, y)
id = get_arg_zoneid(0)
IF id THEN
IF valid_tile_pos(retvals(1), retvals(2)) THEN
scriptret = IIF(CheckZoneAtTile(zmap, id, retvals(1), retvals(2)), 1, 0)
END IF
END IF
CASE 481'--write zone (id, x, y, value)
id = get_arg_zoneid(0)
IF id THEN
IF valid_tile_pos(retvals(1), retvals(2)) THEN
scriptret = 1
IF WriteZoneTile(zmap, id, retvals(1), retvals(2), retvals(3)) = 0 THEN
scriptret = 0
scripterr "writezone: the maximum number of zones, 15, already overlap at " & XY(retvals(1), retvals(2)) & "; attempt to add another failed"
END IF
lump_reloading.zonemap.dirty = YES
END IF
END IF
CASE 482'--zone at spot (x, y, count)
IF valid_tile_pos(retvals(0), retvals(1)) THEN
REDIM zoneshere() as integer
GetZonesAtTile(zmap, zoneshere(), retvals(0), retvals(1))
IF retvals(2) = -1 THEN 'getcount
scriptret = UBOUND(zoneshere) + 1
ELSEIF retvals(2) < -1 THEN
scripterr "zone at spot: bad 'count' argument " & retvals(2), serrBadOp
ELSE
IF retvals(2) <= UBOUND(zoneshere) THEN scriptret = zoneshere(retvals(2))
END IF
END IF
CASE 483'--zone number of tiles (id)
id = get_arg_zoneid(0)
IF id THEN
scriptret = GetZoneInfo(zmap, id)->numtiles
END IF
/' Unimplemented
CASE 484'--draw with zone (id, layer)
CASE 485'--zone next tile x (id, x, y)
CASE 486'--zone next tile y (id, x, y)
'/
CASE 487'--get zone name (string, id)
id = get_arg_zoneid(1)
IF id ANDALSO valid_plotstr(retvals(0)) THEN
plotstr(retvals(0)).s = GetZoneInfo(zmap, id)->name
END IF
CASE 488'--get zone extra (id, extra)
id = get_arg_zoneid(0)
IF id THEN
scriptret = get_extra(GetZoneInfo(zmap, id)->extravec, retvals(1))
END IF
CASE 489'--set zone extra (id, extra, value)
id = get_arg_zoneid(0)
IF id THEN
set_extra GetZoneInfo(zmap, id)->extravec, retvals(1), retvals(2)
lump_reloading.zonemap.dirty = YES
END IF
CASE 493'--load backdrop sprite (record)
scriptret = load_sprite_plotslice(sprTypeBackdrop, retvals(0))
CASE 494 '--replace backdrop sprite (handle, record)
replace_sprite_plotslice 0, sprTypeBackdrop, retvals(1)
CASE 495 '--get sprite trans (handle)
sl = get_arg_spritesl(0)
IF sl THEN
scriptret = IIF(sl->SpriteData->trans, 1, 0)
END IF
CASE 496 '--set sprite trans (handle, bool)
sl = get_arg_spritesl(0)
IF sl THEN
ChangeSpriteSlice sl, , , , , , , retvals(1)
END IF
CASE 500 '--set slice velocity x (handle, pixels per tick, ticks)
sl = get_arg_slice(0)
IF sl THEN
WITH *sl
.Velocity.X = retvals(1)
.VelTicks.X = retvals(2)
.TargTicks = 0
END WITH
END IF
CASE 501 '--set slice velocity y (handle, pixels per tick, ticks)
sl = get_arg_slice(0)
IF sl THEN
WITH *sl
.Velocity.Y = retvals(1)
.VelTicks.Y = retvals(2)
.TargTicks = 0
END WITH
END IF
CASE 502 '--get slice velocity x (handle)
sl = get_arg_slice(0)
IF sl THEN
scriptret = sl->Velocity.X
END IF
CASE 503 '--get slice velocity y (handle)
sl = get_arg_slice(0)
IF sl THEN
scriptret = sl->Velocity.Y
END IF
CASE 504 '--set slice velocity (handle, x pixels per tick, y pixels per tick, ticks)
sl = get_arg_slice(0)
IF sl THEN
WITH *sl
.Velocity.X = retvals(1)
.Velocity.Y = retvals(2)
.VelTicks.X = retvals(3)
.VelTicks.Y = retvals(3)
.TargTicks = 0
END WITH
END IF
CASE 505 '--stop slice (handle)
sl = get_arg_slice(0)
IF sl THEN
WITH *sl
.Velocity.X = 0
.Velocity.Y = 0
.VelTicks.X = 0
.VelTicks.Y = 0
.TargTicks = 0
END WITH
END IF
CASE 506 '--move slice to (handle, x, y, ticks)
sl = get_arg_slice(0)
IF sl THEN
IF retvals(3) < 1 THEN
scripterr current_command_name() & ": ticks arg " & retvals(3) & " mustn't be < 1", serrBadOp
ELSE
SetSliceTarg sl, retvals(1), retvals(2), retvals(3)
END IF
END IF
CASE 507 '--move slice by (handle, rel x, rel y, ticks)
sl = get_arg_slice(0)
IF sl THEN
IF retvals(3) < 1 THEN
scripterr current_command_name() & ": ticks arg " & retvals(3) & " mustn't be < 1", serrBadOp
ELSE
SetSliceTarg sl, sl->X + retvals(1), sl->Y + retvals(2), retvals(3)
END IF
END IF
CASE 508'--wait for slice
sl = get_arg_slice(0)
IF sl THEN
script_start_waiting(retvals(0)) 'TODO: needs replacement
END IF
CASE 509'--slice is moving
sl = get_arg_slice(0)
IF sl THEN
IF SliceIsMoving(sl) THEN scriptret = 1
END IF
CASE 510 '--create ellipse
sl = NewSliceOfType(slEllipse, SliceTable.scriptsprite)
sl->Width = retvals(0)
sl->Height = retvals(1)
IF retvals(2) <> -1 ANDALSO bound_arg(retvals(2), 0, 255, "bordercol") THEN
ChangeEllipseSlice sl, retvals(2)
END IF
IF retvals(3) <> -1 ANDALSO bound_arg(retvals(3), 0, 255, "fillcol") THEN
ChangeEllipseSlice sl, , retvals(3)
END IF
scriptret = create_plotslice_handle(sl)
CASE 511 '--slice is ellipse
sl = get_arg_slice(0)
IF sl THEN
scriptret = IIF(sl->SliceType = slEllipse, 1, 0)
END IF
CASE 512 '--set ellipse border col
sl = get_arg_ellipsesl(0)
IF sl ANDALSO valid_color(retvals(1)) THEN
ChangeEllipseSlice sl, retvals(1)
END IF
CASE 513 '--set ellipse fill col
sl = get_arg_ellipsesl(0)
IF sl ANDALSO valid_color(retvals(1)) THEN
ChangeEllipseSlice sl, , retvals(1)
END IF
CASE 514 '--get ellipse border col
sl = get_arg_ellipsesl(0)
IF sl THEN
scriptret = sl->EllipseData->bordercol
END IF
CASE 515 '--get ellipse fill col
sl = get_arg_ellipsesl(0)
IF sl THEN
scriptret = sl->EllipseData->fillcol
END IF
CASE 516 '--_checkpoint
IF autotestmode = YES THEN
write_checkpoint
ELSE
debug "_checkpoint ignored"
END IF
CASE 519 '--get hero slice
IF valid_hero_caterpillar_rank(retvals(0)) THEN
scriptret = find_plotslice_handle(herow(retvals(0)).sl) 'May be NULL (empty ranks)
END IF
CASE 520 '--get NPC slice
npcref = get_valid_npc(retvals(0))
IF npcref >= 0 THEN
scriptret = find_plotslice_handle(npc(npcref).sl) 'May be NULL (tag-disabled NPCs)
END IF
CASE 521 '--get door x (doorid, [mapid])
scriptret = -1
DIM map_id as integer = get_optional_arg(1, -1)
DIM thisdoor as Door
IF get_door_on_map(thisdoor, retvals(0), map_id) THEN
IF valid_door(thisdoor, retvals(0)) THEN
scriptret = thisdoor.pos.x
END IF
END IF
CASE 522 '--get door y (doorid, [mapid])
scriptret = -1
DIM map_id as integer = get_optional_arg(1, -1)
DIM thisdoor as Door
IF get_door_on_map(thisdoor, retvals(0), map_id) THEN
IF valid_door(thisdoor, retvals(0)) THEN
scriptret = thisdoor.pos.y
END IF
END IF
CASE 523 '--get door destination id (doorid, [mapid])
'Documented to return -1 without error for invalid door/doorlink
'(Only throws error on bad map ID)
scriptret = -1
DIM map_id as integer = get_optional_arg(1, -1)
IF map_id = -1 ORELSE valid_map(map_id) THEN
DIM dlink as DoorLink
'Returns NO if the door is unused
IF find_doorlink(dlink, retvals(0), map_id) THEN
scriptret = dlink.dest
END IF
END IF
CASE 524 '--get door destination map (doorid, [mapid])
'Documented to return -1 without error for invalid door/doorlink
'(Only throws error on bad map ID)
scriptret = -1
DIM map_id as integer = get_optional_arg(1, -1)
IF map_id = -1 ORELSE valid_map(map_id) THEN
DIM dlink as DoorLink
'Returns NO if the door is unused
IF find_doorlink(dlink, retvals(0), map_id) THEN
scriptret = dlink.dest_map
END IF
END IF
CASE 525 '--door exists (doorid, [mapid])
DIM map_id as integer = get_optional_arg(1, -1)
DIM thisdoor as Door
IF get_door_on_map(thisdoor, retvals(0), map_id) THEN
scriptret = iif(thisdoor.exists, 1, 0)
END IF
CASE 526 '--get attack caption
IF valid_plotstr(retvals(0), serrBadOp) ANDALSO valid_attack(retvals(1)) THEN
plotstr(retvals(0)).s = readattackcaption(retvals(1) - 1)
scriptret = 1
END IF
CASE 527, 701 '--527: get rect fuzziness (slice), 701: get rect opacity (slice)
sl = get_arg_rectsl(0)
IF sl THEN
WITH *sl->RectData
IF .translucent = transFuzzy ORELSE .translucent = transBlend THEN
scriptret = .fuzzfactor
ELSEIF .translucent = transHollow THEN
scriptret = 0
ELSEIF .translucent = transOpaque THEN
scriptret = 100
END IF
END WITH
END IF
CASE 528, 702 '--528: set rect fuzziness (slice, percent), 702: set rect opacity (slice, percent)
sl = get_arg_rectsl(0)
IF sl THEN
'Allow out of bounds percentages, just like "set opacity"
DIM opacity as integer = bound(retvals(1), 0, 100)
DIM trans as RectTransTypes
IF opacity = 0 THEN
'Reset fuzzfactor to default 50% for future "set rect trans (sl, trans:fuzzy)";
'the trans setting overrides the opacity
trans = transHollow
opacity = 50
ELSEIF opacity = 100 THEN
'Ditto
trans = transOpaque
opacity = 50
ELSEIF cmdid = 528 THEN 'set rect fuzziness
trans = transFuzzy
ELSE 'set rect opacity
trans = transBlend
END IF
ChangeRectangleSlice sl, , , , , trans, opacity
END IF
CASE 529 '-- textbox line (string, box, line, expand, strip)
IF valid_plotstr(retvals(0), serrBadOp) ANDALSO _
bound_arg(retvals(1), 0, gen(genMaxTextbox), "textbox", , serrBadOp) THEN
IF retvals(2) < 0 THEN
scripterr "textbox line: invalid line number " & retvals(2), serrBadOp
ELSE
DIM box as TextBox
LoadTextBox box, retvals(1)
WITH plotstr(retvals(0))
'There's no upper bound on valid textbox line numbers
IF retvals(2) <= UBOUND(box.text) THEN
.s = box.text(retvals(2))
ELSE
.s = ""
END IF
IF retvals(4) THEN .s = TRIM(.s)
IF retvals(3) THEN embedtext .s
END WITH
END IF
END IF
CASE 530 '--get slice text (string, slice)
IF valid_plotstr(retvals(0), serrBadOp) THEN
sl = get_arg_textsl(1)
IF sl THEN
plotstr(retvals(0)).s = sl->TextData->s
END IF
END IF
CASE 531 '--get input text (string)
IF valid_plotstr(retvals(0)) THEN
IF gam.getinputtext_enabled = NO THEN
scripterr "'get input text' needs to be enabled with 'enable input text'", serrBadOp
ELSE
plotstr(retvals(0)).s = getinputtext()
END IF
END IF
CASE 532 '--enable input text (enable)
gam.getinputtext_enabled = retvals(0)
CASE 533 '--input text enabled
scriptret = gam.getinputtext_enabled
CASE 534 '--set hero hand x
IF valid_hero_party(retvals(0)) THEN
IF bound_arg(retvals(1), 0, 1, "attack frame", , serrBadOp) THEN
WITH gam.hero(retvals(0))
.hand_pos(retvals(1)).x = retvals(2)
.hand_pos_overridden = YES
END WITH
END IF
END IF
CASE 535 '--set hero hand y
IF valid_hero_party(retvals(0)) THEN
IF bound_arg(retvals(1), 0, 1, "attack frame", , serrBadOp) THEN
WITH gam.hero(retvals(0))
.hand_pos(retvals(1)).y = retvals(2)
.hand_pos_overridden = YES
END WITH
END IF
END IF
CASE 536 '--get hero hand x
IF valid_hero_party(retvals(0)) THEN
IF bound_arg(retvals(1), 0, 1, "attack frame", , serrBadOp) THEN
scriptret = gam.hero(retvals(0)).hand_pos(retvals(1)).x
END IF
END IF
CASE 537 '--get hero hand y
IF valid_hero_party(retvals(0)) THEN
IF bound_arg(retvals(1), 0, 1, "attack frame", , serrBadOp) THEN
scriptret = gam.hero(retvals(0)).hand_pos(retvals(1)).y
END IF
END IF
CASE 538 '--get default hero hand x
IF valid_hero_party(retvals(0)) THEN
IF bound_arg(retvals(1), 0, 1, "attack frame", , serrBadOp) THEN
scriptret = GetHeroHandPos(gam.hero(retvals(0)).id, retvals(1)).x
END IF
END IF
CASE 539 '--get default hero hand y
IF valid_hero_party(retvals(0)) THEN
IF bound_arg(retvals(1), 0, 1, "attack frame", , serrBadOp) THEN
scriptret = GetHeroHandPos(gam.hero(retvals(0)).id, retvals(1)).y
END IF
END IF
CASE 540'--check onetime
IF bound_arg(retvals(0), 1, max_onetime, "onetime use tag") THEN
scriptret = ABS(istag(onetime(), retvals(0), 0))
END IF
CASE 541'--set onetime
IF bound_arg(retvals(0), 1, max_onetime, "onetime use tag") THEN
settag onetime(), retvals(0), retvals(1)
tag_updates
END IF
CASE 542 '--microseconds
' TIMER, as a double, only has 53 bits of precision, and on Unix the first ~31
' bits are used up with the seconds since the Epoch, leaving barely enough
' bits for microsecond precision.
scriptret = fmod((TIMER * 1e6) + 2147483648.0, 4294967296.0) - 2147483648.0
CASE 543 '--enemy elemental resist as int (enemy, element)
IF valid_enemy(retvals(0)) THEN
IF bound_arg(retvals(1), 0, gen(genNumElements) - 1, "element number") THEN
DIM enemy as EnemyDef
loadenemydata enemy, retvals(0)
scriptret = 100 * enemy.elementals(retvals(1)) 'rounds to nearest int
END IF
END IF
CASE 544 '--hero Z
IF valid_hero_caterpillar_rank(retvals(0)) THEN
scriptret = heroz(retvals(0))
END IF
CASE 547 '--item maximum stack size (item id)
IF valid_item(retvals(0)) THEN
scriptret = get_item_stack_size(retvals(0))
END IF
CASE 548 '--npc Z
npcref = get_valid_npc(retvals(0))
IF npcref >= 0 THEN
scriptret = npc(npcref).z
END IF
CASE 549 '--set npc Z
npcref = get_valid_npc(retvals(0))
IF npcref >= 0 THEN
npc(npcref).z = retvals(1)
END IF
CASE 550 '--door at spot
scriptret = find_door(XY(retvals(0), retvals(1)))
CASE 551 '--suspend doors
setbit gen(), genSuspendBits, suspenddoors, 1
CASE 552 '--resume doors
setbit gen(), genSuspendBits, suspenddoors, 0
CASE 553 '--running on desktop
'The web port could be run on a phone, so return false
#IF defined(__FB_ANDROID__) OR defined(__FB_JS__) OR defined(__FB_BLACKBOX__)
scriptret = 0
#ELSE
scriptret = 1
#ENDIF
CASE 554 '--running on mobile
scriptret = IIF(running_on_mobile(), 1, 0)
CASE 555 '--running on console
scriptret = IIF(running_on_console(), 1, 0)
CASE 565 '--string sprintf (dest string id, format string id, args...)
IF valid_plotstr(retvals(0), serrBadOp) AND valid_plotstr(retvals(1), serrBadOp) THEN
plotstr(retvals(0)).s = script_sprintf()
scriptret = retvals(0)
END IF
CASE 566 '--script error (string id, [hide frame])
'What if we want to renumber error levels? I think I'll leave this arg for now
DIM errlvl as scriptErrEnum = serrBadOp 'get_optional_arg(2, serrBadOp)
IF retvals(0) = -1 THEN
scripterr "(Triggered with ""scripterror"", no message)", errlvl
ELSEIF valid_plotstr(retvals(0), serrBadOp) THEN
IF get_optional_arg(1, 0) THEN
'For script commands in plotscr.hsd.
'TODO: report line number in the parent script instead, or
'n frames up the stack.
scripterr plotstr(retvals(0)).s, errlvl
ELSE
scripterr !"(Triggered with ""scripterror""):\n" & plotstr(retvals(0)).s, errlvl
END IF
END IF
CASE 567 '--get script name (string id, script id)
IF valid_plotstr(retvals(0), serrBadOp) THEN
' Should be safe to call with any invalid ID number
DIM scrname as string = scriptname(retvals(1))
' Real script names can't start with [, this indicates an invalid ID
IF scrname[0] = ASC("[") THEN
scripterr "getscriptname: invalid script ID " & retvals(1), serrBadOp
ELSE
plotstr(retvals(0)).s = scrname
END IF
END IF
CASE 568 '--get calling script id (depth)
IF retvals(0) < 1 THEN
scripterr "get calling script id: expected a depth of at least 1", serrBadOp
ELSE
' Returns 0 if non-existent
scriptret = ancestor_script_id(nowscript, retvals(0))
END IF
CASE 595'--running on windows
#IFDEF __FB_WIN32__
scriptret = 1
#ENDIF
CASE 596'--running on mac
#IFDEF __FB_DARWIN__
scriptret = 1
#ENDIF
CASE 597'--running on linux
#IFDEF __GNU_LINUX__
scriptret = 1
#ENDIF
CASE 618'--debug menu
stop_fibre_timing
debug_menu
start_fibre_timing
CASE 620'--run game (string id)
run_game
CASE 627'--check game exists (string id)
scriptret = check_game_exists
CASE 674'--set last save slot
IF retvals(0) = 0 ORELSE valid_save_slot(retvals(0)) THEN
lastsaveslot = retvals(0)
END IF
'old scriptnpc
CASE 26'--set NPC frame
npcref = getnpcref(retvals(0), 0)
IF npcref >= 0 THEN
WITH npc(npcref)
'See comments on "set hero frame"
.wtog = bound(retvals(1) * wtog_ticks(), 0, max_wtog(.sl, .dir))
END WITH
END IF
CASE 39'--camera follows NPC
npcref = getnpcref(retvals(0), 0)
IF npcref >= 0 THEN
gen(genCameraMode) = npccam
gen(genCameraArg1) = npcref
END IF
CASE 45'--NPC x
npcref = getnpcref(retvals(0), 0)
IF npcref >= 0 THEN scriptret = npc(npcref).x \ 20
CASE 46'--NPC y
npcref = getnpcref(retvals(0), 0)
IF npcref >= 0 THEN scriptret = npc(npcref).y \ 20
CASE 52'--walk NPC
npcref = getnpcref(retvals(0), 0)
IF npcref >= 0 THEN
SELECT CASE retvals(1)
CASE 0'--north
npc(npcref).dir = 0
npc(npcref).ygo = retvals(2) * 20
CASE 1'--east
npc(npcref).dir = 1
npc(npcref).xgo = retvals(2) * -20
CASE 2'--south
npc(npcref).dir = 2
npc(npcref).ygo = retvals(2) * -20
CASE 3'--west
npc(npcref).dir = 3
npc(npcref).xgo = retvals(2) * 20
END SELECT
END IF
CASE 54'--set NPC direction
npcref = getnpcref(retvals(0), 0)
IF npcref >= 0 THEN npc(npcref).dir = ABS(retvals(1)) MOD 4
CASE 88'--set NPC position
npcref = getnpcref(retvals(0), 0)
IF npcref >= 0 THEN
cropposition retvals(1), retvals(2), 1
WITH npc(npcref)
.x = retvals(1) * 20
.y = retvals(2) * 20
update_walkabout_pos .sl, .x, .y, .z
END WITH
END IF
CASE 101'--NPC direction
npcref = getnpcref(retvals(0), 0)
IF npcref >= 0 THEN scriptret = npc(npcref).dir
CASE 117, 177'--NPC is walking
npcref = getnpcref(retvals(0), 0)
IF npcref >= 0 THEN
'Only scripted pathfinding, not 'Chase You (Pathfinding)', counts as walking,
'so at the end of a step the NPC isn't walking. During a step it is, of course.
IF npc(npcref).xygo = 0 ANDALSO npc(npcref).pathover.override = NO THEN
scriptret = 0
ELSE
scriptret = 1
END IF
IF cmdid = 117 THEN scriptret = scriptret XOR 1 'Backcompat hack
END IF
CASE 120'--NPC reference
scriptret = 0
DIM pool as integer = get_optional_arg(3, 0)
IF bound_arg(pool, 0, 1, "pool (local/global)") THEN
IF retvals(0) >= 0 AND retvals(0) <= UBOUND(npool(pool).npcs) THEN
DIM find_disabled as bool = get_optional_arg(2, 0) <> 0
DIM found as integer = 0
FOR i as integer = 0 TO UBOUND(npc)
DIM id as integer = npc(i).id
IF find_disabled THEN id = ABS(id)
IF id - 1 = retvals(0) ANDALSO npc(i).pool = pool THEN
IF found = retvals(1) THEN
scriptret = (i + 1) * -1
EXIT FOR
END IF
found = found + 1
END IF
NEXT i
END IF
END IF
CASE 121'--NPC at spot
IF retvals(2) = -1 THEN
scriptret = count_npcs_at_spot(XY(retvals(0), retvals(1)))
ELSE
DIM npcidx as NPCIndex = npc_at_spot(XY(retvals(0), retvals(1)), retvals(2))
'convert the npc() index number into a script npc reference
'(also converts -1 failure value into 0 failure value)
scriptret = (npcidx + 1) * -1
END IF
CASE 122'--get NPC ID
' Note: this command can be given an ID, effectively checking whether any NPCs with that ID exist
npcref = getnpcref(retvals(0), 0)
IF npcref >= 0 THEN
scriptret = ABS(npc(npcref).id) - 1
ELSE
scriptret = -1
END IF
CASE 123'--NPC copy count
scriptret = 0
DIM pool as integer = get_optional_arg(1, 0)
IF bound_arg(pool, 0, 1, "pool (local/global)") THEN
IF retvals(0) >= 0 AND retvals(0) <= UBOUND(npool(pool).npcs) THEN
FOR i as integer = 0 TO UBOUND(npc)
IF npc(i).id - 1 = retvals(0) ANDALSO npc(i).pool = pool THEN
scriptret = scriptret + 1
END IF
NEXT i
END IF
END IF
CASE 124'--change NPC ID (npcref, newid, [pool])
DIM pool as integer = get_optional_arg(2, -1)
'Quirk: npcref is allowed to be an NPC ID, changing the first instance of that ID;
'in that case the old and pools are the same.
npcref = getnpcref(retvals(0), 0, IIF(pool=-1, 0, pool))
IF npcref >= 0 THEN
IF pool = -1 THEN pool = npc(npcref).pool
IF bound_arg(pool, 0, 1, "pool (local/global)") THEN
IF retvals(1) < 0 ORELSE retvals(1) > UBOUND(npool(pool).npcs) THEN
scripterr "change NPC ID: " & npc_pool_name(pool) & " NPC ID " & retvals(1) & " doesn't exist"
ELSE
npc(npcref).id = retvals(1) + 1
npc(npcref).pool = pool
'--update the walkabout sprite for the changed NPC
set_walkabout_sprite npc(npcref).sl, npool(pool).npcs(retvals(1)).picture, npool(pool).npcs(retvals(1)).palette
'--run visnpc to apply any changes to the NPCs tag-visibility
visnpc
END IF
END IF
END IF
CASE 125'--create NPC
scriptret = 0
DIM pool as integer = get_optional_arg(4, 0)
IF bound_arg(pool, 0, 1, "pool (local/global)") THEN
IF retvals(0) >= 0 AND retvals(0) <= UBOUND(npool(pool).npcs) THEN
DIM i as integer
FOR i = UBOUND(npc) TO 0 STEP -1
IF npc(i).id = 0 THEN EXIT FOR
NEXT
'for backwards compatibility with games that max out the number of NPCs, try to overwrite tag-disabled NPCs
'FIXME: delete this bit once we raise the NPC limit
IF i = -1 THEN
FOR i = UBOUND(npc) TO 0 STEP -1
IF npc(i).id <= 0 THEN EXIT FOR
NEXT
DIM msgtemp as string = "create NPC: trying to create NPC id " & retvals(0) & " at " & XY(retvals(1), retvals(2)) * 20
IF i = -1 THEN
scripterr msgtemp & "; failed: too many NPCs exist"
ELSE
scripterr msgtemp & "; warning: had to overwrite tag-disabled NPC id " & ABS(npc(i).id)-1 & " at " & npc(i).pos & ": too many NPCs exist", serrWarn
END IF
END IF
IF i > -1 THEN
'This deletes the walkabout slice
DIM byref npci as NPCInst = npc(i)
CleanNPCInst npci
DIM npc_id as integer = retvals(0)
npci.id = npc_id + 1
npci.pool = pool
cropposition retvals(1), retvals(2), 1
npci.x = retvals(1) * 20
npci.y = retvals(2) * 20
npci.dir = ABS(retvals(3)) MOD 4
npci.sl = create_npc_slices(i) 'Calls set_walkabout_sprite
'Although not guaranteed to be up to date before the screen is drawn (e.g. due to map wrapping),
'try to keep the slice position accurate
update_walkabout_pos npci.sl, npci.x, npci.y, npci.z
'debug "npc(" & i & ").sl=" & npci.sl & " [create npc(" & retvals(0) & ")]"
update_npc_zones i
scriptret = (i + 1) * -1
END IF
END IF
END IF
CASE 126 '--destroy NPC (aka delete NPC)
npcref = getnpcref(retvals(0), 0)
IF npcref >= 0 THEN
'Don't run zone exit triggers.
'This deletes the walkabout slice
CleanNPCInst npc(npcref)
END IF
CASE 165'--NPC at pixel
scriptret = 0
DIM found as integer = 0
FOR i as integer = 0 TO UBOUND(npc)
IF npc(i).id > 0 THEN
IF npc(i).x <= retvals(0) AND npc(i).x > (retvals(0) - 20) THEN
IF npc(i).y <= retvals(1) AND npc(i).y > (retvals(1) - 20) THEN
IF found = retvals(2) THEN
scriptret = (i + 1) * -1
EXIT FOR
END IF
found = found + 1
END IF
END IF
END IF
NEXT i
IF retvals(2) = -1 THEN scriptret = found
CASE 182'--read NPC (npcref, npcstat, [pool])
IF bound_arg(retvals(1), 0, maxNPCDataField, "NPCstat: constant", , serrBadOp) THEN
DIM npcid as NPCTypeID
DIM pool as integer
IF get_valid_npc_id_pool(retvals(0), get_optional_arg(2, -1), npcid, pool) THEN
scriptret = GetNPCD(npool(pool).npcs(npcid), retvals(1))
IF retvals(1) = 12 THEN 'NPCstat:script
scriptret = decodetrigger(scriptret, NO) 'showerr=NO
END IF
END IF
END IF
CASE 192'--NPC frame
npcref = getnpcref(retvals(0), 0)
'Note that this can be beyond the last frame, if the direction or spriteset just changed.
IF npcref >= 0 THEN scriptret = wtog_to_frame(npc(npcref).wtog)
CASE 193'--NPC extra
npcref = getnpcref(retvals(0), 0)
IF npcref >= 0 THEN scriptret = get_extra(npc(npcref).extravec, retvals(1))
CASE 194'--set NPC extra
npcref = getnpcref(retvals(0), 0)
IF npcref >= 0 THEN set_extra npc(npcref).extravec, retvals(1), retvals(2)
CASE 472'--set NPC ignores walls (npc, value)
npcref = get_valid_npc(retvals(0))
IF npcref >= 0 THEN
npc(npcref).ignore_walls = (retvals(1) <> 0)
END IF
CASE 473'--get NPC ignores walls (npc)
npcref = get_valid_npc(retvals(0))
IF npcref >= 0 THEN
scriptret = iif(npc(npcref).ignore_walls, 1, 0)
END IF
CASE 474'--set NPC obstructs (npc, value)
npcref = get_valid_npc(retvals(0))
IF npcref >= 0 THEN
npc(npcref).not_obstruction = (retvals(1) = 0)
END IF
CASE 475'--get NPC obstructs (npc)
npcref = get_valid_npc(retvals(0))
IF npcref >= 0 THEN
scriptret = iif(npc(npcref).not_obstruction, 0, 1)
END IF
CASE 476'--set NPC usable (npc, value)
npcref = get_valid_npc(retvals(0))
IF npcref >= 0 THEN
npc(npcref).suspend_use = (retvals(1) = 0)
END IF
CASE 477'--get NPC usable (npc)
npcref = get_valid_npc(retvals(0))
IF npcref >= 0 THEN
scriptret = iif(npc(npcref).suspend_use, 0, 1)
END IF
CASE 478'--set NPC moves (npc, value)
npcref = get_valid_npc(retvals(0))
IF npcref >= 0 THEN
npc(npcref).suspend_ai = (retvals(1) = 0)
END IF
CASE 479'--get NPC moves (npc)
npcref = get_valid_npc(retvals(0))
IF npcref >= 0 THEN
scriptret = iif(npc(npcref).suspend_ai, 0, 1)
END IF
CASE 559'--get sprite default pal
sl = get_arg_spritesl(0)
IF sl THEN
DIM dat as SpriteSliceData ptr = sl->SpriteData
IF dat->paletted = NO OR dat->spritetype = sprTypeFrame THEN
'Only paletted sprites have default palettes
scriptret = -1
ELSE
scriptret = getdefaultpal(dat->spritetype, dat->record)
END IF
END IF
CASE 560'--NPC is disabled
npcref = getnpcref(retvals(0), 0)
scriptret = 0
IF npcref >= 0 THEN
IF npc(npcref).id < 0 THEN
scriptret = 1
END IF
ELSE
scriptret = 1
END IF
CASE 569'--camera follows slice
sl = get_arg_slice(0)
IF sl THEN
gen(genCameraMode) = slicecam
gen(genCameraArg1) = retvals(0) 'TODO: needs replacement
END IF
CASE 570'--get active battle pause on all menus
scriptret = IIF(prefbit(13), 1, 0) '"Pause on all battle menus & targeting"
CASE 571'--set active battle pause on all menus
setprefbit 13, retvals(0)
CASE 572'--dissolve sprite
sl = get_arg_spritesl(0)
IF sl THEN
DissolveSpriteSlice sl, retvals(1), retvals(2), retvals(3), retvals(4), retvals(5)
END IF
CASE 573'--cancel dissolve
sl = get_arg_spritesl(0)
IF sl THEN
CancelSpriteSliceDissolve sl
END IF
CASE 574'--sprite is dissolving
scriptret = 0
sl = get_arg_spritesl(0)
IF sl THEN
'Note that unlike "wait for dissolve", this isn't restricted to auto-dissolve
IF SpriteSliceIsDissolving(sl, NO) THEN scriptret = 1
END IF
CASE 575'--wait for dissolve
IF get_arg_spritesl(0) THEN
script_start_waiting(retvals(0)) 'TODO: this will need to be a script object ptr
END IF
CASE 576'--hide virtual gamepad
gam.pad.script_hide_virtual_gamepad = YES
gam.pad.script_show_virtual_gamepad = NO
update_virtual_gamepad_display()
CASE 577'--show virtual gamepad
gam.pad.script_hide_virtual_gamepad = NO
gam.pad.script_show_virtual_gamepad = YES
update_virtual_gamepad_display()
CASE 578'--auto virtual gamepad
gam.pad.script_hide_virtual_gamepad = NO
gam.pad.script_show_virtual_gamepad = NO
update_virtual_gamepad_display()
CASE 579'--get vert align
sl = get_arg_slice(0)
IF sl THEN
scriptret = sl->AlignVert
END IF
CASE 580'--get horiz align
sl = get_arg_slice(0)
IF sl THEN
scriptret = sl->AlignHoriz
END IF
CASE 581'--get vert anchor
sl = get_arg_slice(0)
IF sl THEN
scriptret = sl->AnchorVert
END IF
CASE 582'--get horiz anchor
sl = get_arg_slice(0)
IF sl THEN
scriptret = sl->AnchorHoriz
END IF
CASE 583'--set select slice index
sl = get_arg_selectsl(0)
IF sl THEN
sl->SelectData->index = retvals(1) 'An invalid index just means that no child slice is visible.
END IF
CASE 584'--get select slice index
sl = get_arg_selectsl(0)
IF sl THEN
scriptret = sl->SelectData->index
END IF
CASE 585 '--create select
sl = NewSliceOfType(slSelect, SliceTable.scriptsprite)
scriptret = create_plotslice_handle(sl)
sl->Width = retvals(0)
sl->Height = retvals(1)
CASE 586 '--slice is select
sl = get_arg_slice(0)
IF sl THEN
scriptret = IIF(sl->SliceType = slSelect, 1, 0)
END IF
CASE 587 '--slice child index
sl = get_arg_slice(0)
IF sl THEN
scriptret = SliceIndexAmongSiblings(sl)
END IF
CASE 588 '--create scroll
sl = NewSliceOfType(slScroll, SliceTable.scriptsprite)
scriptret = create_plotslice_handle(sl)
sl->Width = retvals(0)
sl->Height = retvals(1)
CASE 589 '--slice is scroll
sl = get_arg_slice(0)
IF sl THEN
scriptret = IIF(sl->SliceType = slScroll, 1, 0)
END IF
CASE 590'--set scroll bar style
sl = get_arg_scrollsl(0)
IF sl ANDALSO valid_box_style(retvals(1)) THEN
ChangeScrollSlice sl, retvals(1)
END IF
CASE 591'--get scroll bar style
sl = get_arg_scrollsl(0)
IF sl THEN
scriptret = sl->ScrollData->style
END IF
CASE 592'--set scroll check depth
sl = get_arg_scrollsl(0)
IF sl THEN
ChangeScrollSlice sl, , retvals(1)
END IF
CASE 593'--get scroll check depth
sl = get_arg_scrollsl(0)
IF sl THEN
scriptret = sl->ScrollData->check_depth
END IF
CASE 594'--scroll to child (parent, descendent, apply_padding) aka scroll to slice
DIM as Slice ptr parent, descendent
parent = get_arg_slice(0)
descendent = get_arg_slice(1)
IF parent ANDALSO descendent THEN
ScrollToChild parent, descendent, get_optional_arg(2, NO)
END IF
CASE 598'--next npc reference
'Argument should be 0 or an NPC reference (< 0)
IF retvals(0) > 0 THEN
scripterr current_command_name() & ": invalid npc reference " & retvals(0)
scriptret = 0
ELSE
'Default to 0 if no more NPCs
scriptret = 0
'OK if this is past end of the array
DIM first_npcref as integer = (-retvals(0) - 1) + 1
FOR i as integer = first_npcref TO UBOUND(npc)
IF npc(i).id > 0 THEN
scriptret = (i + 1) * -1
EXIT FOR
END IF
NEXT i
END IF
CASE 64'--get hero stat (hero, stat, type)
'TODO: unfortunately this can also access hero level & "hero levelled" which will suck
'when we want to add more stats. Backcompat bit needed.
DIM slot as integer = bound(retvals(0), 0, 40) 'Might want to keep this bound() for backcompat?
DIM statnum as integer = retvals(1)
IF statnum = 12 ORELSE valid_stat(statnum) THEN
WITH gam.hero(slot)
IF retvals(2) = 0 THEN 'current stat
IF statnum = 12 THEN
'This is backcompat for a somewhat documented feature (used in a lot of games)
scriptret = .lev
ELSE
scriptret = .stat.cur.sta(statnum)
END IF
ELSEIF retvals(2) = 1 THEN 'maximum stat
IF statnum = 12 THEN
'This is backcompat for a barely documented feature (used in a lot of games)
scriptret = .lev_gain
ELSE
scriptret = .stat.max.sta(statnum)
END IF
ELSEIF retvals(2) = 2 THEN 'base stat
IF statnum <> 12 THEN
scriptret = .stat.base.sta(statnum)
END IF
ELSE
scripterr "get hero stat: stat type not 'current stat', 'maximum stat' or 'base stat'"
END IF
END WITH
END IF
CASE 66'--add hero
IF bound_arg(retvals(0), 0, gen(genMaxHero), "hero ID") THEN
DIM slot as integer = first_free_slot_in_party()
IF slot >= 0 THEN
addhero retvals(0), slot
END IF
scriptret = slot
END IF
CASE 67'--delete hero (hero ID)
IF party_size() > 1 AND retvals(0) >= 0 THEN
DIM slot as integer = findhero(retvals(0), , serrWarn)
IF slot > -1 THEN deletehero slot
END IF
CASE 68'--swap out hero
DIM i as integer = findhero(retvals(0), , serrWarn)
IF i > -1 THEN
FOR o as integer = 40 TO 4 STEP -1
IF gam.hero(o).id = -1 THEN
doswap i, o
IF active_party_size() = 0 THEN forceparty
EXIT FOR
END IF
NEXT o
END IF
CASE 69'--swap in hero
DIM i as integer = findhero(retvals(0), -1, serrWarn)
IF i > -1 THEN
FOR o as integer = 0 TO 3
IF gam.hero(o).id = -1 THEN
doswap i, o
EXIT FOR
END IF
NEXT o
END IF
CASE 83'--set hero stat (hero, stat, value, type)
'TODO: this command can also set hero level (without updating stats)
' which sucks for when we want to add more stats. Need backcompat bit.
DIM slot as integer = bound(retvals(0), 0, 40) 'Might want to keep this bound() for backcompat?
DIM statnum as integer = retvals(1)
IF statnum = 12 ORELSE valid_stat(statnum) THEN
WITH gam.hero(slot)
IF retvals(3) = 0 THEN 'current stat
IF statnum = 12 THEN
'This is backcompat for a mostly undocumented feature (used in several games)
.lev = retvals(2)
ELSE
.stat.cur.sta(statnum) = retvals(2)
IF statnum = statHP THEN
evalherotags
tag_updates
END IF
END IF
ELSEIF retvals(3) = 1 THEN 'maximum stat
IF statnum = 12 THEN
'This is backcompat for an undocumented feature (nonetheless used in several games)
.lev_gain = retvals(2)
ELSE
.stat.base.sta(statnum) += retvals(2) - .stat.max.sta(statnum)
.stat.max.sta(statnum) = retvals(2)
END IF
ELSEIF retvals(3) = 2 THEN 'base stat
IF statnum <> 12 THEN
.stat.base.sta(statnum) = retvals(2)
recompute_hero_max_stats slot
END IF
ELSE
scripterr "set hero stat: stat type not 'current stat', 'maximum stat' or 'base stat'"
END IF
END WITH
END IF
CASE 89'--swap by position
doswap bound(retvals(0), 0, 40), bound(retvals(1), 0, 40)
'FIXME: missing forceparty call! (bug #1111)
CASE 110'--set hero picture
DIM heronum as integer = retvals(0)
IF valid_hero_party(heronum) THEN
DIM whichsprite as integer = bound(retvals(2), 0, 2)
SELECT CASE whichsprite
CASE 0:
gam.hero(heronum).battle_pic = bound(retvals(1), 0, gen(genMaxHeroPic))
CASE 1:
gam.hero(heronum).pic = bound(retvals(1), 0, gen(genMaxNPCPic))
IF heronum < 4 THEN vishero
CASE 2:
gam.hero(heronum).portrait_pic = bound(retvals(1), -1, gen(genMaxPortrait))
END SELECT
END IF
CASE 111'--set hero palette
DIM heronum as integer = retvals(0)
IF valid_hero_party(heronum) THEN
DIM whichsprite as integer = bound(retvals(2), 0, 2)
SELECT CASE whichsprite
CASE 0:
gam.hero(heronum).battle_pal = bound(retvals(1), -1, 32767)
CASE 1:
gam.hero(heronum).pal = bound(retvals(1), -1, 32767)
IF heronum < 4 THEN vishero
CASE 2:
gam.hero(heronum).portrait_pal = bound(retvals(1), -1, 32767)
END SELECT
END IF
CASE 112'--get hero picture
SELECT CASE retvals(1)
CASE 0:
scriptret = gam.hero(bound(retvals(0), 0, 40)).battle_pic
CASE 1:
scriptret = gam.hero(bound(retvals(0), 0, 40)).pic
CASE 2:
scriptret = gam.hero(bound(retvals(0), 0, 40)).portrait_pic
END SELECT
CASE 113'--get hero palette
SELECT CASE retvals(1)
CASE 0:
scriptret = gam.hero(bound(retvals(0), 0, 40)).battle_pal
CASE 1:
scriptret = gam.hero(bound(retvals(0), 0, 40)).pal
CASE 2:
scriptret = gam.hero(bound(retvals(0), 0, 40)).portrait_pal
END SELECT
CASE 150'--status screen
stop_fibre_timing
IF retvals(0) >= 0 AND retvals(0) <= 3 THEN
IF gam.hero(retvals(0)).id >= 0 THEN
status_screen retvals(0)
END IF
END IF
start_fibre_timing
CASE 152'--spells menu
stop_fibre_timing
IF retvals(0) >= 0 AND retvals(0) <= 3 THEN
IF gam.hero(retvals(0)).id >= 0 THEN
old_spells_menu retvals(0)
END IF
END IF
start_fibre_timing
CASE 154'--equip menu(who [, allow_switch])
retvals(1) = get_optional_arg(1, 1)
stop_fibre_timing
DIM allow_switch as bool
allow_switch = (retvals(1) <> 0)
'Can explicitly choose a hero to equip
IF retvals(0) >= 0 AND retvals(0) <= 3 THEN
IF gam.hero(retvals(0)).id >= 0 THEN
equip_menu retvals(0), allow_switch
END IF
ELSEIF retvals(0) = -1 THEN
'Or pass -1 to equip the first hero in the party
equip_menu rank_to_party_slot(0), allow_switch
END IF
start_fibre_timing
CASE 157'--order menu
stop_fibre_timing
hero_swap_menu 0
start_fibre_timing
CASE 158'--team menu
stop_fibre_timing
hero_swap_menu 1
start_fibre_timing
CASE 183'--set hero level (who, what, allow forgetting spells)
IF valid_hero_party(retvals(0)) AND retvals(1) >= 0 THEN 'we should make the regular level limit customisable anyway
gam.hero(retvals(0)).lev_gain = retvals(1) - gam.hero(retvals(0)).lev
gam.hero(retvals(0)).lev = retvals(1)
gam.hero(retvals(0)).exp_next = exptolevel(retvals(1) + 1, gam.hero(retvals(0)).exp_mult)
gam.hero(retvals(0)).exp_cur = 0 'XP attained towards the next level
updatestatslevelup retvals(0), retvals(2) <> 0 'updates stats and spells
evalherotags
tag_updates
END IF
CASE 184'--give experience (who, how much)
'who = -1 targets battle party
IF retvals(0) <> -1 THEN
IF valid_hero_party(retvals(0)) THEN
giveheroexperience retvals(0), retvals(1)
updatestatslevelup retvals(0), NO
END IF
ELSE
'This sets the level gain and learnt spells and calls updatestatslevelup for every hero
distribute_party_experience retvals(1)
END IF
evalherotags
tag_updates
CASE 185'--hero levelled (who)
scriptret = gam.hero(bound(retvals(0), 0, 40)).lev_gain
CASE 186 /'spells learnt'/, 469 /'spells learned'/
'NOTE: 'spells learnt' is deprecated but will remain for backcompat. New games should use "spells learned".
'spells learned returns the spell ID offset by 1, for consistency with other attack commands and atk:name
'constants, which are all consistently wrong!
DIM found as integer = 0
IF valid_hero_party(retvals(0)) THEN
WITH gam.hero(retvals(0))
FOR i as integer = 0 TO 4 * 24 - 1
IF readbit(.learnmask(), 0, i) THEN
IF retvals(1) = found THEN
scriptret = .spells(i \ 24, i MOD 24) 'Attack ID + 1
IF cmdid = 186 THEN scriptret -= 1
EXIT FOR
END IF
found += 1
END IF
NEXT
IF retvals(1) = -1 THEN scriptret = found 'getcount
END WITH
END IF
CASE 269'--total experience
IF valid_hero_party(retvals(0)) THEN
scriptret = hero_total_exp(retvals(0))
END IF
CASE 270'--experience to level
retvals(1) = get_optional_arg(1, -1)
IF retvals(1) = -1 ORELSE valid_hero_party(retvals(1)) THEN
IF retvals(1) = -1 THEN
'Default experience curve
scriptret = total_exp_to_level(retvals(0))
ELSEIF gam.hero(retvals(1)).id >= 0 THEN
scriptret = total_exp_to_level(retvals(0), gam.hero(retvals(1)).exp_mult)
ELSE
scripterr interpreter_context_name() + "empty hero slot " & retvals(1)
END IF
END IF
CASE 271'--experience to next level
IF valid_hero_party(retvals(0)) THEN
scriptret = gam.hero(retvals(0)).exp_next - gam.hero(retvals(0)).exp_cur
END IF
CASE 272'--set experience (who, what, allowforget)
IF valid_hero_party(retvals(0)) AND retvals(1) >= 0 THEN
setheroexperience retvals(0), retvals(1), (retvals(2) <> 0)
END IF
CASE 445'--update level up learning(who, allowforget)
IF valid_hero_party(retvals(0)) THEN
learn_spells_for_current_level retvals(0), (retvals(1) <> 0)
END IF
CASE 449'--reset hero picture
DIM heronum as integer = retvals(0)
DIM whichsprite as integer = retvals(1)
IF really_valid_hero_party(heronum, , serrBound) THEN
IF bound_arg(whichsprite, 0, 2, "hero picture type") THEN
DIM her as HeroDef
loadherodata her, gam.hero(heronum).id
SELECT CASE whichsprite
CASE 0:
gam.hero(heronum).battle_pic = her.sprite
CASE 1:
gam.hero(heronum).pic = her.walk_sprite
IF heronum < 4 THEN vishero
CASE 2:
gam.hero(heronum).portrait_pic = her.portrait
END SELECT
END IF
END IF
CASE 450'--reset hero palette
DIM heronum as integer = retvals(0)
DIM whichsprite as integer = retvals(1)
IF really_valid_hero_party(heronum, , serrBound) THEN
IF bound_arg(whichsprite, 0, 2, "hero picture type") THEN
DIM her as HeroDef
loadherodata her, gam.hero(heronum).id
SELECT CASE whichsprite
CASE 0:
gam.hero(heronum).battle_pal = her.sprite_pal
CASE 1:
gam.hero(heronum).pal = her.walk_sprite_pal
IF heronum < 4 THEN vishero
CASE 2:
gam.hero(heronum).portrait_pal = her.portrait_pal
END SELECT
END IF
END IF
CASE 497'--set hero base elemental resist (hero, element, percent)
IF really_valid_hero_party(retvals(0)) THEN
IF bound_arg(retvals(1), 0, gen(genNumElements) - 1, "element number") THEN
gam.hero(retvals(0)).elementals(retvals(1)) = 0.01 * retvals(2)
END IF
END IF
CASE 498'--hero base elemental resist as int (hero, element)
IF really_valid_hero_party(retvals(0)) THEN
IF bound_arg(retvals(1), 0, gen(genNumElements) - 1, "element number") THEN
scriptret = 100 * gam.hero(retvals(0)).elementals(retvals(1)) 'rounds to nearest int
END IF
END IF
CASE 499'--hero total elemental resist as int (hero, element)
IF really_valid_hero_party(retvals(0)) THEN
IF bound_arg(retvals(1), 0, gen(genNumElements) - 1, "element number") THEN
REDIM elementals(gen(genNumElements) - 1) as single
calc_hero_elementals elementals(), retvals(0)
scriptret = 100 * elementals(retvals(1)) 'rounds to nearest int
END IF
END IF
CASE 545 '--get hero stat cap (stat)
'Replaces a plotscr.hsd script
IF valid_stat(retvals(0)) THEN
scriptret = gen(genStatCap + retvals(0))
END IF
CASE 546 '--set hero stat cap (stat, value)
IF valid_stat(retvals(0)) THEN
IF retvals(1) < 0 THEN
scripterr "set hero stat cap: invalid negative cap value " & retvals(1)
ELSE
gen(genStatCap + retvals(0)) = retvals(1)
FOR hero_slot as integer = 0 TO UBOUND(gam.hero)
'This is maybe a bit heavy handed, because it caps all stats to the caps.
update_hero_max_and_cur_stats hero_slot
NEXT
END IF
END IF
CASE 556 '--input string with virtual keyboard (string ID, maxlen, onlyplayer=-1)
'This command tries to guess the best method for your current platform
IF valid_plotstr(retvals(0)) THEN
IF running_on_mobile() THEN
'Mobile with touchscreen. Player argument ignored for now.
hide_virtual_gamepad()
gam.pad.being_shown = NO
plotstr(retvals(0)).s = touch_virtual_keyboard(plotstr(retvals(0)).s, retvals(1))
update_virtual_gamepad_display()
ELSE
'Desktop (arrow keys) and console (d-pad)
plotstr(retvals(0)).s = gamepad_virtual_keyboard(plotstr(retvals(0)).s, retvals(1), retvals(2))
END IF
END IF
CASE 557'--get item description(str,itm)
scriptret = 0
IF valid_plotstr(retvals(0)) THEN
IF valid_item(retvals(1)) THEN
plotstr(retvals(0)).s = readitemdescription(retvals(1))
scriptret = 1
END IF
END IF
CASE 599 '--input string with mouse keyboard (string ID, maxlen)
IF valid_plotstr(retvals(0)) THEN
hide_virtual_gamepad()
plotstr(retvals(0)).s = touch_virtual_keyboard(plotstr(retvals(0)).s, retvals(1))
update_virtual_gamepad_display()
END IF
CASE 600 '--running on ouya
'See also "running on console"
scriptret = IIF(running_on_ouya(), 1, 0)
CASE 601 '--unhide mouse cursor/show mouse cursor
showmousecursor
mouserect -1, -1, -1, -1
CASE 602 '--hide mouse cursor
hidemousecursor
CASE 603'--pixel focus camera
gen(genCameraMode) = focuscam
gen(genCameraArg1) = retvals(0) - get_resolution().w / 2
gen(genCameraArg2) = retvals(1) - get_resolution().h / 2
gen(genCameraArg3) = ABS(retvals(2))
gen(genCameraArg4) = ABS(retvals(2))
limitcamera gen(genCameraArg1), gen(genCameraArg2)
CASE 604 '--send email (save slot, subject string id, body string id)
IF retvals(0) = 0 ORELSE valid_save_slot(retvals(0)) THEN
DIM as string subject, body
IF retvals(1) <> -1 ANDALSO valid_plotstr(retvals(1)) THEN 'subject string id
subject = plotstr(retvals(1)).s
END IF
IF retvals(2) <> -1 ANDALSO valid_plotstr(retvals(2)) THEN 'body string id
body = plotstr(retvals(2)).s
END IF
email_save_to_developer retvals(0) - 1, "", subject, body
END IF
CASE 605 '--dump slice tree
IF retvals(0) = 0 THEN
SliceDebugDumpTree SliceTable.Root
ELSE
sl = get_arg_slice(0)
IF sl THEN SliceDebugDumpTree sl
END IF
CASE 606 '--create panel
sl = NewSliceOfType(slPanel, SliceTable.scriptsprite)
scriptret = create_plotslice_handle(sl)
sl->Width = retvals(0)
sl->Height = retvals(1)
CASE 607 '--slice is panel
sl = get_arg_slice(0)
IF sl THEN
scriptret = IIF(sl->SliceType = slPanel, 1, 0)
END IF
CASE 608'--get panel is vertical
sl = get_arg_panelsl(0)
IF sl THEN
scriptret = IIF(sl->PanelData->vertical, 1, 0)
END IF
CASE 609'--set panel is vertical
sl = get_arg_panelsl(0)
IF sl THEN
ChangePanelSlice sl, retvals(1) <> 0
END IF
CASE 610'--get panel primary index
sl = get_arg_panelsl(0)
IF sl THEN
scriptret = sl->PanelData->primary
END IF
CASE 611'--set panel primary index
sl = get_arg_panelsl(0)
IF sl THEN
IF bound_arg(retvals(1), 0, 1, "panel child index") THEN
ChangePanelSlice sl, , retvals(1)
END IF
END IF
CASE 612'--get panel percent as int
sl = get_arg_panelsl(0)
IF sl THEN
scriptret = CINT(sl->PanelData->percent * 100)
END IF
CASE 613'--set panel percent
sl = get_arg_panelsl(0)
IF sl THEN
ChangePanelSlice sl, , , , bound(retvals(1), 0, 100) * 0.01
END IF
CASE 614'--get panel pixels
sl = get_arg_panelsl(0)
IF sl THEN
scriptret = sl->PanelData->pixels
END IF
CASE 615'--set panel pixels
sl = get_arg_panelsl(0)
IF sl THEN
ChangePanelSlice sl, , , retvals(1)
END IF
CASE 616'--get panel padding
sl = get_arg_panelsl(0)
IF sl THEN
scriptret = sl->PanelData->padding
END IF
CASE 617'--set panel padding
sl = get_arg_panelsl(0)
IF sl THEN
ChangePanelSlice sl, , , , , retvals(1)
END IF
CASE 621'--get battle countdown
scriptret = gam.random_battle_countdown
CASE 622'--set battle countdown
gam.random_battle_countdown = large(0, retvals(0))
CASE 626 '--textbox text (string, box, expand, strip)
IF valid_plotstr(retvals(0), serrBadOp) ANDALSO _
bound_arg(retvals(1), 0, gen(genMaxTextbox), "textbox", , serrBadOp) THEN
DIM box as TextBox
LoadTextBox box, retvals(1)
plotstr(retvals(0)).s = textbox_lines_to_string(box)
IF retvals(3) THEN plotstr(retvals(0)).s = trim(plotstr(retvals(0)).s)
IF retvals(2) THEN embedtext plotstr(retvals(0)).s
END IF
CASE 628'--pathfind npc to
DIM npcref as NPCIndex = get_valid_npc(retvals(0), serrBadOp)
IF npcref >= 0 THEN
cancel_npc_movement_override (npc(npcref))
npc(npcref).pathover.override = NPCOverrideMove.POS
npc(npcref).pathover.dest_pos = XY(retvals(1), retvals(2))
npc(npcref).pathover.stop_after_stillticks = retvals(3)
IF npc(npcref).pathover.stop_after_stillticks THEN
npc(npcref).stillticks = 0
END IF
END IF
CASE 629'--npc chases npc
DIM npcref as NPCIndex = get_valid_npc(retvals(0), serrBadOp)
DIM dest_npcref as NPCIndex = get_valid_npc(retvals(1), serrBadOp)
IF npcref >= 0 ANDALSO dest_npcref <> -1 THEN
cancel_npc_movement_override (npc(npcref))
npc(npcref).pathover.override = NPCOverrideMove.NPC
npc(npcref).pathover.dest_npc = dest_npcref
npc(npcref).pathover.stop_when_npc_reached = (retvals(2) <> 0)
npc(npcref).pathover.stop_after_stillticks = retvals(3)
IF npc(npcref).pathover.stop_after_stillticks THEN
npc(npcref).stillticks = 0
END IF
END IF
CASE 630'--cancel npc walk
DIM npcref as NPCIndex = get_valid_npc(retvals(0), serrBadOp)
IF npcref >= 0 THEN
cancel_npc_movement_override (npc(npcref))
cancel_npc_walk (npc(npcref))
END IF
CASE 631'--player is suspended
scriptret = IIF(readbit(gen(), genSuspendBits, suspendplayer), 1, 0)
CASE 632'--npcs are suspended
scriptret = IIF(readbit(gen(), genSuspendBits, suspendnpcs), 1, 0)
CASE 633'--obstruction is suspended
scriptret = IIF(readbit(gen(), genSuspendBits, suspendobstruction), 1, 0)
CASE 634'--hero walls are suspended
scriptret = IIF(readbit(gen(), genSuspendBits, suspendherowalls), 1, 0)
CASE 635'--npc walls are suspended
scriptret = IIF(readbit(gen(), genSuspendBits, suspendnpcwalls), 1, 0)
CASE 636'--caterpillar is suspended
scriptret = IIF(readbit(gen(), genSuspendBits, suspendcaterpillar), 1, 0)
CASE 637'--doors are suspended
scriptret = IIF(readbit(gen(), genSuspendBits, suspenddoors), 1, 0)
CASE 638'--random enemies are suspended
scriptret = IIF(readbit(gen(), genSuspendBits, suspendrandomenemies), 1, 0)
CASE 639'--box advance is suspended
scriptret = IIF(readbit(gen(), genSuspendBits, suspendboxadvance), 1, 0)
CASE 640'--overlay is suspended
scriptret = IIF(readbit(gen(), genSuspendBits, suspendoverlay), 1, 0)
CASE 641'--map music is suspended
scriptret = IIF(readbit(gen(), genSuspendBits, suspendambientmusic), 1, 0)
CASE 642'--timers are suspended
scriptret = IIF(readbit(gen(), genSuspendBits, suspendtimers), 1, 0)
CASE 643'--get screen width
scriptret = gen(genResolutionX)
CASE 644'--get screen height
scriptret = gen(genResolutionY)
CASE 645'--set screen resolution
'FIXME: this is secret and undocumented until the gfx_directx backends supports resolution changing
IF bound_arg(retvals(0), MinResolutionX, MaxResolutionX, "width") ANDALSO bound_arg(retvals(1), MinResolutionY, MaxResolutionY, "height") THEN
gen(genResolutionX) = retvals(0)
gen(genResolutionY) = retvals(1)
apply_game_window_settings()
END IF
CASE 647'--_cancel runfast
use_speed_control = YES
CASE 648'--_runfast
use_speed_control = NO
CASE 649'--multdiv
'Return int(float(a)*b/c), clamped to a 32-bit int, and rounded
'(Break ties towards +inf, since that's what JS does; FB/x86 breaks ties towards even)
IF retvals(2) = 0 THEN
scripterr strprintf("division by zero: %d*%d/0", retvals(0), retvals(1)), serrBadOp
ELSE
scriptret = INT(bound(CDBL(retvals(0)) * retvals(1) / retvals(2), CDBL(INT_MIN), CDBL(INT_MAX)) + 0.5)
END IF
CASE 650 '--set rect raw border
sl = get_arg_rectsl(0)
IF sl ANDALSO bound_arg(retvals(1), -2, gen(genMaxBoxBorder), "raw border") THEN
ChangeRectangleSlice sl, , , , , , , retvals(1)
END IF
CASE 651 '--get rect raw border
sl = get_arg_rectsl(0)
IF sl THEN
WITH *sl->RectData
IF .use_raw_box_border THEN
scriptret = .raw_box_border
ELSEIF .border >= 0 THEN
scriptret = boxlook(.border).border - 1 'possibly border:line
ELSE
scriptret = .border 'border:line or border:none
END IF
END WITH
END IF
CASE 652 '--clone slice(slice, recurse)
sl = get_arg_slice(0)
IF sl THEN
DIM ret as Slice ptr
'Not using CloneTemplate here due to lacking args
'Note that we don't perform a deep copy of slice-specific animations for efficiency, which
'you'll notice if you enter the script debugger and edit them. Doesn't seem very harmful
'as long as there are no commands for editing animations.
IF sl->Parent THEN ret = CloneSliceTree(sl, retvals(1) <> 0, NO)
IF ret = 0 THEN 'Returned in the following case:
scripterr "cloneslice: Can't copy a Map layer slice or the Root slice"
ELSE
'CloneTemplate does the following automatically
ret->Template = NO
'sl has a parent
InsertSliceBefore sl, ret
scriptret = create_plotslice_handle(ret)
END IF
END IF
CASE 653 '--reset formation
IF valid_formation(retvals(0)) THEN
DIM form as Formation
LoadFormation form, game & ".for", retvals(0)
SaveFormation form, tmpdir & "for.tmp", retvals(0)
END IF
CASE 654 '--reset formation slot
IF valid_formation_slot(retvals(0), retvals(1)) THEN
DIM orig_form as Formation
LoadFormation orig_form, game & ".for", retvals(0)
DIM cur_form as Formation
LoadFormation cur_form, tmpdir & "for.tmp", retvals(0)
cur_form.slots(retvals(1)) = orig_form.slots(retvals(1))
SaveFormation cur_form, tmpdir & "for.tmp", retvals(0)
END IF
CASE 655 '--slice is map layer
sl = get_arg_slice(0)
IF sl THEN
scriptret = IIF(sl->SliceType = slMap, 1, 0)
END IF
CASE 656 '--npc reference from slice
sl = get_arg_slice(0)
IF sl THEN
scriptret = 0
IF *sl->Context IS NPCSliceContext THEN scriptret = -1 * (1 + CAST(NPCSliceContext ptr, sl->Context)->npcindex)
END IF
CASE 657 '--hero rank from slice
sl = get_arg_slice(0)
IF sl THEN
scriptret = -1
IF *sl->Context IS HeroSliceContext THEN
scriptret = party_slot_to_rank(CAST(HeroSliceContext ptr, sl->Context)->slot)
END IF
END IF
CASE 658 '--slice type
sl = get_arg_slice(0)
IF sl THEN
scriptret = sl->SliceType
END IF
CASE 659 '--_asserteq(x, y, stringid, stringoffset)
IF retvals(0) <> retvals(1) THEN
IF bound_arg(retvals(2), 0, UBOUND(plotstr), "string ID", "assert expression string") THEN
plotstr(retvals(2)).s = script_string_constant(nowscript, retvals(3)) & _
" [actual values were " & retvals(0) & " == " & retvals(1) & "]"
scriptret = 1
END IF
END IF
CASE 660 '--save screenshot
screenshot
CASE 661 '--slice is line
sl = get_arg_slice(0)
IF sl THEN
scriptret = IIF(sl->SliceType = slLine, 1, 0)
END IF
CASE 662 '--create line
IF valid_color(retvals(2)) THEN
sl = NewSliceOfType(slLine, SliceTable.scriptsprite)
scriptret = create_plotslice_handle(sl)
sl->Width = retvals(0)
sl->Height = retvals(1)
sl->LineData->SetColor(retvals(2))
END IF
CASE 663 '--get line color
sl = get_arg_linesl(0)
IF sl THEN
scriptret = sl->LineData->col
END IF
CASE 664 '--set line color
sl = get_arg_linesl(0)
IF sl ANDALSO valid_color(retvals(1)) THEN
sl->LineData->SetColor(retvals(1))
END IF
CASE 665 '--force mount vehicle
npcref = get_valid_npc(retvals(0))
IF npcref >= 0 THEN
forcemountvehicle npcref
END IF
CASE 666 '--current vehicle id
IF vstate.active THEN
scriptret = vstate.id
ELSE
scriptret = -1
END IF
CASE 667 '--current vehicle npc
IF vstate.active THEN
'Return an NPC reference
scriptret = (vstate.npc + 1) * -1
ELSE
'Not riding
scriptret = 0
END IF
CASE 668 '--pathfind hero to
IF valid_hero_caterpillar_rank(retvals(0)) THEN
cancel_hero_pathfinding(retvals(0))
path_hero_to_tile(retvals(0), XY(retvals(1), retvals(2)), retvals(3))
END IF
CASE 669 '--hero chases npc
DIM dest_npcref as NPCIndex = get_valid_npc(retvals(1), serrBadOp)
IF valid_hero_caterpillar_rank(retvals(0)) THEN
cancel_hero_pathfinding(retvals(0))
path_hero_to_npc(retvals(0), dest_npcref, retvals(2) <> 0, retvals(3))
END IF
CASE 670 '--cancel hero walk
IF valid_hero_caterpillar_rank(retvals(0)) THEN
cancel_hero_pathfinding(retvals(0))
cancel_hero_walk(retvals(0))
END IF
CASE 675 '--speaking npc
scriptret = -1 - txt.sayer '0 if no textbox or not triggered by an NPC
CASE 676 '--keypress (scancode, player)
a_script_wants_keys()
scriptret = IIF(script_keyval(retvals(0), retvals(1)) > 1, 1, 0)
CASE 677 '--new keypress (scancode, player)
a_script_wants_keys()
scriptret = IIF(script_keyval(retvals(0), retvals(1)) AND 4, 1, 0)
CASE 678 '--get joystick name (stringid, player)
IF valid_plotstr(retvals(0), serrBadOp) THEN
plotstr(retvals(0)).s = ""
IF valid_player_num(retvals(1)) THEN
DIM info as JoystickInfo ptr = joystick_info(retvals(1))
IF info THEN
plotstr(retvals(0)).s = info->name
END IF
END IF
END IF
CASE 679 '--joystick button count (player)
IF valid_player_num(retvals(0)) THEN
DIM info as JoystickInfo ptr = joystick_info(retvals(0))
IF info THEN
scriptret = info->num_buttons
END IF
END IF
CASE 680 '--joystick axis count (player)
IF valid_player_num(retvals(0)) THEN
DIM info as JoystickInfo ptr = joystick_info(retvals(0))
IF info THEN
scriptret = info->num_axes
END IF
END IF
CASE 681 '--joystick hat count (player)
IF valid_player_num(retvals(0)) THEN
DIM info as JoystickInfo ptr = joystick_info(retvals(0))
IF info THEN
scriptret = info->num_hats
END IF
END IF
CASE 682 '--find color(r, g, b, searchstart)
'r, g, b don't have to be in the range 0-255.
scriptret = nearcolor(master(), retvals(0), retvals(1), retvals(2), retvals(3))
CASE 683 '--override tick milliseconds(ms)
IF bound_arg(retvals(0), 5, 200, "milliseconds") THEN
set_speedcontrol retvals(0)
set_animation_framerate retvals(0)
END IF
CASE 684 '--cancel override tick milliseconds
set_speedcontrol gen(genMillisecPerFrame)
set_animation_framerate gen(genMillisecPerFrame)
CASE 685'--suspend textbox controls
setbit gen(), genSuspendBits, suspendtextboxcontrols, 1
CASE 686'--resume textbox controls
setbit gen(), genSuspendBits, suspendtextboxcontrols, 0
CASE 687'--textbox controls are suspended
scriptret = readbit(gen(), genSuspendBits, suspendtextboxcontrols)
CASE 688'--menu item count (menu)
IF valid_menu_handle(retvals(0), menuslot) THEN
scriptret = menus(menuslot).numitems
END IF
CASE 689'--visible menu item count (menu)
IF valid_menu_handle(retvals(0), menuslot) THEN
scriptret = count_visible_menu_items(menus(menuslot))
END IF
CASE 690 '-- replace substring (in string ID, replace what ID, with what ID, max replacements, case insensitive)
IF valid_plotstr(retvals(0), serrBadOp) ANDALSO _
valid_plotstr(retvals(1), serrBadOp) ANDALSO _
valid_plotstr(retvals(2), serrBadOp) THEN
scriptret = replacestr(plotstr(retvals(0)).s, plotstr(retvals(1)).s, plotstr(retvals(2)).s, retvals(3), (retvals(4) <> 0))
END IF
CASE 691 '--decode trigger
scriptret = decodetrigger(retvals(0), NO) 'showerr=NO
CASE 692 '--get scancode name (string id, scancode, long name)
'TODO: doesn't support joystick scancodes
IF valid_plotstr(retvals(0)) ANDALSO valid_key(retvals(1)) THEN
plotstr(retvals(0)).s = scancodename(retvals(1), retvals(2) <> 0)
END IF
CASE 693 '--get hero slice by slot
'Empty party slots are OK, returns 0
IF valid_hero_party(retvals(0)) THEN
scriptret = find_plotslice_handle(gam.hero(retvals(0)).sl)
END IF
CASE 694 '--hero slot from slice
sl = get_arg_slice(0)
IF sl THEN
scriptret = -1
IF *sl->Context IS HeroSliceContext THEN
scriptret = CAST(HeroSliceContext ptr, sl->Context)->slot
END IF
END IF
CASE 695 '--get opacity (slice)
sl = get_arg_slice(0)
IF sl THEN
'Non-blendable slice types allowed
DIM drawopts as DrawOptions ptr = SliceDrawOpts(sl, NO)
IF drawopts <> NULL ANDALSO drawopts->with_blending THEN
scriptret = 100 * drawopts->opacity
ELSE
scriptret = 100
END IF
END IF
CASE 696 '--set opacity (slice, opacity)
sl = get_arg_slice(0)
IF sl THEN
DIM drawopts as DrawOptions ptr = SliceDrawOpts(sl)
IF drawopts THEN
'Setting opacity to a value outside 0-100% is not an error
drawopts->opacity = bound(retvals(1), 0, 100) * 0.01
IF retvals(1) < 100 THEN drawopts->with_blending = YES
END IF
END IF
CASE 697 '--get blending enabled (slice)
scriptret = 0
sl = get_arg_slice(0)
IF sl THEN
'Non-blendable slice types allowed
DIM drawopts as DrawOptions ptr = SliceDrawOpts(sl, NO)
IF drawopts <> NULL ANDALSO drawopts->with_blending THEN
scriptret = 1
END IF
END IF
CASE 698 '--set blending enabled (slice, bool)
sl = get_arg_slice(0)
IF sl THEN
DIM drawopts as DrawOptions ptr = SliceDrawOpts(sl)
IF drawopts THEN drawopts->with_blending = retvals(1) <> 0
END IF
CASE 699 '--get blend mode (slice)
sl = get_arg_slice(0)
IF sl THEN
'Non-blendable slice types allowed
DIM drawopts as DrawOptions ptr = SliceDrawOpts(sl, NO)
IF drawopts <> NULL ANDALSO drawopts->with_blending THEN
scriptret = drawopts->blend_mode
ELSE
scriptret = blendModeNormal
END IF
END IF
CASE 700 '--set blend mode (slice, blendmode)
sl = get_arg_slice(0)
IF sl ANDALSO bound_arg(retvals(1), 0, blendModeLast, "blend mode", , serrBadOp) THEN
DIM drawopts as DrawOptions ptr = SliceDrawOpts(sl)
IF drawopts THEN
drawopts->blend_mode = retvals(1)
drawopts->with_blending = YES
END IF
END IF
CASE 703 '--set timer args (id, args...)
IF curcmd->argc = 0 THEN
scripterr "set_timer_args needs at least one argument: ID", serrBadOp
ELSEIF bound_arg(retvals(0), 0, UBOUND(timers), "timer ID") THEN
WITH timers(retvals(0))
IF .trigger <= 0 THEN
scripterr "Timer " & retvals(0) & " isn't set to trigger a script. Call ""set timer"" before ""set timer args"".", serrBadOp
ELSE
'The number of args passed can be 0, in which case we REDIM -1 TO -1,
'which is different from an un-DIM'd arraay which is 0 TO -1 and causes
'the default timer ID arg to be passed.
REDIM .script_args(-1 TO curcmd->argc - 2)
FOR i as integer = 1 TO curcmd->argc - 1
.script_args(i - 1) = retvals(i)
NEXT
END IF
END WITH
END IF
CASE 704'-- expand strings in slices(sl, saveslot)
sl = get_arg_slice(0)
retvals(1) = get_optional_arg(1, 0)
IF sl THEN
'Retvals(1) can be 0 for the default of using current game state, or a save slot 1-maxSaveSlotCount
IF retvals(1) = 0 ORELSE valid_save_slot(retvals(1)) THEN
embedslicetree sl, retvals(1) - 1
END IF
scriptret = retvals(0)
END IF
CASE 705'-- hero is chasing
IF valid_hero_caterpillar_rank(retvals(0)) THEN
IF hero_is_pathfinding(retvals(0)) THEN
IF gam.hero_pathing(retvals(0)).mode = HeroPathingMode.NPC THEN
'If the hero is actually chasing an NPC, convert the NPC number into an NPC reference
scriptret = (gam.hero_pathing(retvals(0)).dest_npc + 1) * -1
END IF
END IF
END IF
CASE 706'-- npc is chasing
DIM npcref as NPCIndex = get_valid_npc(retvals(0), serrBadOp)
IF npcref >= 0 THEN
IF npc(npcref).pathover.override = NPCOverrideMove.NPC THEN
'If the npc is actualy chasing another NPC, convert the target NPC number into an NPC reference
scriptret = (npc(npcref).pathover.dest_npc + 1) * -1
END IF
END IF
CASE 707'-- max map id
scriptret = gen(genMaxMap)
CASE 708'-- get slice lookup name (string, code, use default)
IF valid_plotstr(retvals(0)) THEN
plotstr(retvals(0)).s = SliceLookupCodename(retvals(1), retvals(2))
scriptret = retvals(0)
END IF
CASE 709'-- get npc pool
IF retvals(0) >= 0 THEN
scripterr current_command_name() & ": invalid npc reference " & retvals(0) & " (NPC IDs not allowed)"
scriptret = 0
ELSE
DIM npcref as NPCIndex = get_valid_npc(retvals(0), serrBound)
IF npcref >= 0 THEN
scriptret = npc(npcref).pool
END IF
END IF
CASE 710'--gracefully dismount vehicle
vehicle_graceful_dismount()
CASE 711 '--read foe map
scriptret = readblock(foemap, bound(retvals(0), 0, mapsizetiles.x-1), bound(retvals(1), 0, mapsizetiles.y-1), 0)
CASE 712 '--get enemy name (enemy, stringid)
IF valid_plotstr(retvals(1)) THEN
WITH plotstr(retvals(1))
IF valid_enemy(retvals(0)) THEN
.s = readenemyname(retvals(0))
ELSE
.s = ""
END IF
END WITH
END IF
CASE 713 '--set enemy name (enemy, stringid)
IF valid_enemy(retvals(0)) ANDALSO valid_plotstr(retvals(1)) THEN
writeenemyname retvals(0), plotstr(retvals(1)).s
END IF
CASE 738 '--reset enemy name (enemy)
IF valid_enemy(retvals(0)) THEN
writeenemyname retvals(0), readenemyname(retvals(0), NO)
END IF
CASE 714 '--breakpoint
stop_fibre_timing
IF gam.debug_scripts < 2 THEN gam.debug_scripts = 2
scriptwatcher gam.debug_scripts
next_interpreter_check_time = TIMER + scriptCheckDelay
start_fibre_timing
CASE 715 '--delete hero by slot (slot)
IF valid_hero_party(retvals(0)) THEN
IF gam.hero(retvals(0)).id >= 0 THEN
'slot is occupied
deletehero retvals(0)
scriptret = 0
ELSE
' slot is empty, do nothing
scriptret = -1
END IF
ELSE
scriptret = -1
END IF
CASE 716 '--get ui color (color code, autotoggle)
DIM c as integer = retvals(0)
IF valid_color(c) THEN
scriptret = ColorIndex(c, retvals(1))
END IF
CASE 717 '--set ui color (color code, color index)
DIM uicol as integer = (retvals(0) * -1) - 1
DIM index as integer = retvals(1)
IF bound_arg(uicol, 0, uiColorLast, "UI color constant", , serrBadOp) ANDALSO valid_color(index) THEN
uilook(uicol) = ColorIndex(index, NO)
END IF
CASE 718 '--get box style color (box style)
IF valid_box_style(retvals(0)) THEN
scriptret = boxlook(retvals(0)).bgcol
END IF
CASE 719 '--get box style edge color (box style)
IF valid_box_style(retvals(0)) THEN
scriptret = boxlook(retvals(0)).edgecol
END IF
CASE 720 '--get box style border (box style)
IF valid_box_style(retvals(0)) THEN
scriptret = boxlook(retvals(0)).border - 1
END IF
CASE 721 '--get child autosort (slice)
sl = get_arg_slice(0)
IF sl THEN
scriptret = sl->Autosort
END IF
CASE 722 '--set child autosort (slice, autosort)
sl = get_arg_slice(0)
IF sl ANDALSO bound_arg(retvals(1), 0, slAutoSortLAST, "autosort:... constant", , serrBadOp) THEN
sl->Autosort = retvals(1)
END IF
CASE 723 '--last layer id
scriptret = UBOUND(maptiles)
CASE 724 '--layer id under walkabouts
'When gmap(31) = 0 then it defaults to 2, but that is enforced at loading time in gmap_updates()
scriptret = bound(gmap(31) - 1, 0, UBOUND(maptiles))
CASE 725 '--get global sound volume
scriptret = get_global_sfx_volume * 255
CASE 726 '--set global sound volume (volume)
set_global_sfx_volume bound(retvals(0), 0, 255) / 255
CASE 727 '--heal party ([revive dead heroes])
innRestore retvals(0) '-2 means default
CASE 728 '--set hero auto battle (who, bool)
DIM heronum as integer = retvals(0)
IF really_valid_hero_party(heronum) THEN
gam.hero(heronum).auto_battle = retvals(1) <> 0
END IF
CASE 729 '--get hero auto battle (who)
DIM heronum as integer = retvals(0)
IF really_valid_hero_party(heronum) THEN
scriptret = IIF(gam.hero(heronum).auto_battle, 1, 0)
END IF
CASE 730 '--resize extra (handle, length)
extravec_ptr = get_arg_extravec(0)
IF extravec_ptr THEN resize_extra *extravec_ptr, retvals(1)
CASE 731 '--extra length (handle)
extravec_ptr = get_arg_extravec(0)
IF extravec_ptr THEN scriptret = IIF(*extravec_ptr, v_len(*extravec_ptr), 3)
CASE 732 '--append extra (handle, value)
extravec_ptr = get_arg_extravec(0)
IF extravec_ptr THEN
DIM byref extravec as integer vector = *extravec_ptr
IF extravec = NULL THEN v_new extravec, 3
DIM length as integer = v_len(extravec)
IF length = maxExtraLength THEN
scripterr "Can't expand extra array, reached max length, " & maxExtraLength
ELSE
v_append extravec, retvals(1)
length += 1
END IF
scriptret = length
END IF
CASE 733 '--lookup next slice (lookupcode, current, root)
DIM current as Slice ptr
DIM root as Slice ptr
IF retvals(1) <> 0 THEN current = get_arg_slice(1)
IF retvals(2) = 0 THEN
root = SliceTable.Root
ELSE
root = get_arg_slice(2)
END IF
IF (current ORELSE retvals(1) = 0) ANDALSO (root ORELSE retvals(2) = 0) THEN
scriptret = find_plotslice_handle(LookupSlice(retvals(0), root, , current))
END IF
CASE 734 '--next slice in tree (current, root, visit children)
DIM current as Slice ptr
DIM root as Slice ptr
IF retvals(0) <> 0 THEN current = get_arg_slice(0)
IF retvals(1) = 0 THEN
root = SliceTable.Root
ELSE
root = get_arg_slice(1)
END IF
IF (current ORELSE retvals(0) = 0) ANDALSO (root ORELSE retvals(1) = 0) THEN
IF current = NULL THEN
sl = root
ELSE
sl = NextDescendent(current, root, retvals(2) <> 0)
END IF
scriptret = find_plotslice_handle(sl)
END IF
CASE 735 '--window is focused
DIM winstate as WindowState ptr
winstate = gfx_getwindowstate()
IF winstate = NULL ORELSE winstate->focused THEN
scriptret = 1
END IF
CASE 736 '--show value of internal (string, value, ...)
DIM result as string
FOR i as integer = 0 TO curcmd->argc - 1
IF i MOD 2 = 0 THEN
IF i <> 0 THEN result &= ", "
result &= script_string_constant(nowscript, retvals(i)) & "="
ELSE
result &= STR(retvals(i))
END IF
NEXT
gam.showstring = result
CASE 739 '--get extra (handle, index)
extravec_ptr = get_arg_extravec(0)
IF extravec_ptr THEN scriptret = get_extra(*extravec_ptr, retvals(1))
CASE 740 '--set extra (handle, index, value)
extravec_ptr = get_arg_extravec(0)
IF extravec_ptr THEN set_extra *extravec_ptr, retvals(1), retvals(2)
CASE 741 '--hero uses level mp
IF valid_hero_party(retvals(0)) THEN
scriptret = IIF(hero_uses_lmp(retvals(0)), 1, 0)
END IF
CASE 742 '--get zone (zone id)
id = get_arg_zoneid(0)
IF id THEN
'If zone id is already a zone handle then this is a noop because the HandleType
'gets stripped and re-added.
scriptret = make_handle(HandleType.Zone, id)
END IF
CASE 743 '--get rect fuzzy zoom(sl)
sl = get_arg_rectsl(0)
IF sl THEN
scriptret = sl->RectData->fuzz_zoom
END IF
CASE 744 '--set rect fuzzy zoom(sl, zoom)
sl = get_arg_rectsl(0)
DIM zoom as integer = retvals(1)
IF sl ANDALSO bound_arg(zoom, 1, INT_MAX, "zoom", , serrBadOp) THEN
sl->RectData->fuzz_zoom = zoom
END IF
CASE 745 '--get rect stationary pattern(sl)
sl = get_arg_rectsl(0)
IF sl THEN
scriptret = IIF(sl->RectData->fuzz_stationary, 1, 0)
END IF
CASE 746 '--set rect stationary pattern(sl, bool)
sl = get_arg_rectsl(0)
IF sl THEN
sl->RectData->fuzz_stationary = retvals(1) <> 0
END IF
CASE 747 '--keypress time(scancode, player)
a_script_wants_keys()
script_keyval(retvals(0), retvals(1), scriptret)
CASE 748 '--random choice(...)
IF curcmd->argc > 0 THEN
scriptret = retvals(randint(curcmd->argc))
END IF
CASE 749 '--get stat name(stringid, stat)
IF valid_plotstr(retvals(0)) THEN
IF retvals(1) >= 0 ANDALSO retvals(1) <= statLastRegister THEN
plotstr(retvals(0)).s = battle_statnames(retvals(1))
scriptret = 1
ELSE
'Don't show an error, because in future the number of stats will be variable
plotstr(retvals(0)).s = ""
END IF
END IF
CASE 750 '--suspend walkabouts
setbit gen(), genSuspendBits, suspendwalkabouts, 1
CASE 751 '--resume walkabouts
setbit gen(), genSuspendBits, suspendwalkabouts, 0
CASE 752 '--walkabouts are suspended
scriptret = readbit(gen(), genSuspendBits, suspendwalkabouts)
CASE 753 '--forward x
IF valid_hero_caterpillar_rank(retvals(0)) THEN
DIM fx as integer = herotx(retvals(0))
DIM fy as integer '= heroty(retvals(0)) 'Not actually needed
wrapaheadxy fx, fy, herodir(retvals(0)), 1, 1
scriptret = fx
END IF
CASE 754 '--forward y
IF valid_hero_caterpillar_rank(retvals(0)) THEN
DIM fx as integer '= herotx(retvals(0))
DIM fy as Integer = heroty(retvals(0))
wrapaheadxy fx, fy, herodir(retvals(0)), 1, 1
scriptret = fy
END IF
CASE 755 '--get attack extra
IF valid_attack(retvals(0)) ANDALSO bound_arg(retvals(1), 0, 2, "extra number", , serrBadOp) THEN
DIM attack as AttackData
loadattackdata attack, retvals(0) - 1
scriptret = attack.extra(retvals(1))
END IF
CASE 756 '--pathfind into extra as npc
extravec_ptr = get_arg_extravec(0)
DIM npcref as NPCIndex = get_valid_npc(retvals(1), serrBadOp)
DIM startpos as XYPair = XY(retvals(2), retvals(3))
DIM destpos as XYPair = XY(retvals(4), retvals(5))
DIM maxsearch as integer = retvals(6)
DIM append_extra as bool = retvals(7) <> 0
DIM skip_start as bool = retvals(8) <> 0
IF extravec_ptr <> NULL ANDALSO npcref >= 0 THEN
DIM pf as AStarPathfinder = AStarPathfinder(startpos, destpos, maxsearch)
pf.calculate(@npc(npcref), YES, , YES)
scriptret = IIF(copy_path_data_into_extra(extravec_ptr, pf, destpos, append_extra, skip_start), 1, 0)
END IF
CASE 757 '--pathfind into extra as hero
extravec_ptr = get_arg_extravec(0)
DIM startpos as XYPair = XY(retvals(1), retvals(2))
DIM destpos as XYPair = XY(retvals(3), retvals(4))
DIM maxsearch as integer = retvals(5)
DIM append_extra as bool = retvals(6) <> 0
DIM skip_start as bool = retvals(7) <> 0
IF extravec_ptr <> NULL THEN
DIM pf as AStarPathfinder = AStarPathfinder(startpos, destpos, maxsearch)
pf.calculate(NULL, NO, YES)
scriptret = IIF(copy_path_data_into_extra(extravec_ptr, pf, destpos, append_extra, skip_start), 1, 0)
END IF
CASE 758 '--insert extra
extravec_ptr = get_arg_extravec(0)
IF extravec_ptr THEN
insert_extra *extravec_ptr, retvals(1), retvals(2)
END IF
CASE 759 '--delete extra
extravec_ptr = get_arg_extravec(0)
IF extravec_ptr THEN
DIM as integer index = retvals(1), inext = index + 1
IF index = -1 THEN
'Special case to avoid [-1, 0)
inext = IIF(*extravec_ptr, v_len(*extravec_ptr), 3)
END IF
scriptret = delete_extra_range(*extravec_ptr, index, inext)
END IF
CASE 760 '--delete extra range
extravec_ptr = get_arg_extravec(0)
IF extravec_ptr THEN
scriptret = delete_extra_range(*extravec_ptr, retvals(1), retvals(2))
END IF
CASE 761 '--is shop buy menu empty
IF bound_arg(retvals(0), 0, gen(genMaxShop), "Shop ID") THEN
scriptret = IIF(is_shop_empty(retvals(0), 0), 1, 0)
END IF
CASE 762 '--is shop hire menu empty
IF bound_arg(retvals(0), 0, gen(genMaxShop), "Shop ID") THEN
scriptret = IIF(is_shop_empty(retvals(0), 1), 1, 0)
END IF
CASE 763 '--inn screen
scriptret = inn_screen(retvals(0), retvals(1) <> 0)
CASE 764 '--read environment(dest_strid, key_strid)
'Get data from Blackbox, overridable with a config key for testing.
IF valid_plotstr(retvals(0)) ANDALSO valid_plotstr(retvals(1)) THEN
DIM byref dest as string = plotstr(retvals(0)).s
DIM byref key as string = plotstr(retvals(1)).s
dest = read_environment_key(key)
'For convenience
scriptret = str2int(dest, 0)
END IF
CASE 765 '--xbox request account picker
#IFDEF __FB_BLACKBOX__
blackbox_request_account_picker()
#ENDIF
CASE 766 '--ps5 start story
#IFDEF __FB_BLACKBOX__
blackbox_start_story()
#ENDIF
CASE 767 '--ps5 end story
#IFDEF __FB_BLACKBOX__
blackbox_end_story()
#ENDIF
CASE 768 '--set rich presence(token name, substitution = -1)
'Steam or Blackbox
DIM as zstring ptr token_id, substitution
IF retvals(1) > -1 ANDALSO valid_plotstr(retvals(1)) THEN
substitution = strptr(plotstr(retvals(1)).s)
END IF
IF valid_plotstr(retvals(0)) THEN
token_id = strptr(plotstr(retvals(0)).s)
#IFDEF __FB_BLACKBOX__
blackbox_set_rich_presence(token_id, substitution)
#ELSE
Steam.set_rich_presence(token_id, substitution)
#ENDIF
END IF
CASE 769 '--find extra (handle, value, startindex)
extravec_ptr = get_arg_extravec(0)
scriptret = -1
IF extravec_ptr THEN
scriptret = find_extra(*extravec_ptr, retvals(1), retvals(2))
END IF
CASE 770 '--running on web
scriptret = IIF(running_on_web(), 1, 0)
'CASE 771-772 unused
CASE 773 '--playstation controller
'TODO
DIM sys as string = read_environment_key("sys")
scriptret = IIF(starts_with(sys, "PS"), 1, 0)
CASE 774 '--xbox controller
'TODO
DIM sys as string = read_environment_key("sys")
scriptret = IIF(sys = "XBOXONE" ORELSE sys = "SERIESX", 1, 0)
CASE 775 '--nintendo controller
'TODO
DIM sys as string = read_environment_key("sys")
scriptret = IIF(sys = "SWITCH", 1, 0)
CASE 776 '--get sprite frame id
sl = get_arg_spritesl(0)
IF sl THEN
scriptret = sl->SpriteData->get_frameid(sl)
ELSE
scriptret = -1
END IF
CASE 777 '--set sprite frame id (handle, frameid, exact=false)
sl = get_arg_spritesl(0)
IF sl THEN
scriptret = sl->SpriteData->set_frameid(sl, retvals(1), retvals(2))
ELSE
scriptret = -1
END IF
CASE 778 '--find sprite frame id (handle, frameid)
sl = get_arg_spritesl(0)
IF sl THEN
scriptret = sl->SpriteData->find_frameid(sl, retvals(1), YES)
ELSE
scriptret = -1
END IF
CASE 779 '--sprite frame group size (handle, group = -1)
sl = get_arg_spritesl(0)
IF sl THEN
scriptret = sl->SpriteData->get_num_frames_in_group(sl, retvals(1))
END IF
CASE 780 '--hero is locked
DIM hero_slot as integer = findhero(retvals(0), , serrWarn)
IF hero_slot > -1 THEN scriptret = IIF(gam.hero(hero_slot).locked, 1, 0)
CASE ELSE
'We also check the HSP header at load time to check there aren't unsupported commands
scripterr "Unsupported script command " & cmdid & " " & commandname(cmdid) & ". " _
"Try downloading the latest version of the OHRRPGCE.", serrError
END SELECT
END SUB
'==========================================================================================
' Music commands
'==========================================================================================
SUB wrappedsong (byval songnumber as integer)
IF songnumber <> presentsong THEN
playsongnum songnumber
presentsong = songnumber
ELSE
'Has this ever worked? Maybe in old DOS versions
'resumesong
END IF
'Cancel any queued music change
gam.music_change_delay = 0
END SUB
SUB stopsong
presentsong = -1
music_stop
'Cancel any queued music change
gam.music_change_delay = 0
END SUB
FUNCTION backcompat_sound_id (byval id as integer) as integer
IF backcompat_sound_slot_mode THEN
'BACKWARDS COMPATABILITY HACK
IF id >= 0 AND id <= 7 THEN
RETURN backcompat_sound_slots(id) - 1
END IF
ELSE
'Normal playsound mode
RETURN id
END IF
END FUNCTION
'==========================================================================================
' Generic script handles
'==========================================================================================
'Decode a handle to a pointer to an object, returned in ret, and return the type,
'or else NULL and HandleType.Error.
'This is not suitable if you want the index of the object (E.g. NPCIndex, Menu number).
'Doesn't handle the range 1 to &h7FFFFFF: returns HandleType.None without setting ret.
'Returns HandleType.Slice for all slice handles, not Slice2/3/4
FUNCTION decode_handle(byref ret as any ptr, handle as integer, errlvl as scriptErrEnum = serrBadOp) as HandleType
'DIM index as uinteger = get_handle_payload(handle)
DIM htype as HandleType = get_handle_type(handle)
SELECT CASE htype
CASE IS >= HandleType.Slice
ret = get_handle_slice(handle, errlvl)
IF ret THEN RETURN HandleType.Slice
CASE HandleType.NPC
DIM index as integer = -1 - handle
IF index > UBOUND(npc) THEN
IF errlvl > serrIgnore THEN
scripterr current_command_name() & ": invalid NPC handle " & handle, errlvl
END IF
RETURN HandleType.Error
END IF
ret = @npc(index)
RETURN HandleType.NPC
CASE HandleType.Zone
DIM id as integer = get_handle_zoneid(handle, errlvl)
IF id THEN
ret = GetZoneInfo(zmap, id)
RETURN HandleType.Zone
END IF
CASE HandleType.Menu
DIM menuslot as integer
IF valid_menu_handle(handle, menuslot, errlvl) THEN
ret = @menus(menuslot)
RETURN HandleType.Menu
END IF
CASE HandleType.MenuItem
DIM menuslot as integer
DIM mislot as integer
IF valid_menu_item_handle(handle, menuslot, mislot, errlvl) THEN
ret = menus(menuslot).items[mislot]
RETURN HandleType.MenuItem
END IF
CASE ELSE
IF htype = 0 ANDALSO handle > 0 THEN RETURN HandleType.None
IF errlvl > serrIgnore THEN
scripterr current_command_name() & ": invalid handle " & handle, errlvl
END IF
END SELECT
RETURN HandleType.Error
END FUNCTION
DIM SHARED handle_type_names(-16 TO 16) as string
handle_type_names(HandleType.Zone) = "zone"
handle_type_names(HandleType.NPC) = "NPC"
handle_type_names(HandleType.None) = "unrecognised"
handle_type_names(HandleType.Slice) = "slice"
handle_type_names(HandleType.Menu) = "menu"
handle_type_names(HandleType.MenuItem) = "menu item"
handle_type_names(HandleType.Error) = "ERROR"
'Try to recognise a value as a handle, returning a string for debugging and error messages such
'as "0" or "1610612736 (Map slice 3 (map layer0))" or "-10 (copy of NPC 3)".
'Pass succinct = true to get a much shorter description.
FUNCTION describe_handle(handle as integer, succinct as bool = NO) as string
' DIM htype as HandleType = get_handle_type(handle)
'Call decode_handle to tell apart valid from invalid handles
DIM obj as any ptr
DIM htype as HandleType = decode_handle(obj, handle, serrIgnore)
DIM info as string
SELECT CASE htype
CASE HandleType.Error, HandleType.None
'Treat as not a handle, unless can identify as a free handle
IF get_handle_type(handle) >= HandleType.Slice THEN
IF slice_handle_is_freed(handle) THEN
info = IIF(succinct, "Freed sl ", "Freed slice ") & (handle AND SLICE_HANDLE_SLOT_MASK)
END IF
END IF
CASE HandleType.Slice
info = DescribeSlice(CAST(Slice ptr, obj), succinct)
CASE HandleType.NPC
' Too dubious, small negative integers could mean anything.
'info = "reference for NPC " & ABS(CAST(NPCInst ptr, obj)->id) - 1 & " instance"
CASE HandleType.Menu
DIM index as integer = get_handle_payload(handle)
IF succinct THEN
info = "menu inst " & index & " (ID " & CAST(MenuDef ptr, obj)->record & ")"
ELSE
info = "menu handle " & index & " (menu ID " & CAST(MenuDef ptr, obj)->record & ")"
END IF
CASE ELSE
DIM typename as string = handle_type_names(htype)
IF LEN(typename) THEN
DIM index as integer = get_handle_payload(handle)
info = typename & " " & index & " handle"
'info = typename & " handle"
END IF
END SELECT
IF LEN(info) THEN
IF succinct THEN
RETURN info
ELSE
RETURN handle & " (" & info & ")"
END IF
ELSE
RETURN STR(handle)
END IF
END FUNCTION
'Give a script handle for an object, return the pointer to its ExtraVec array if
'it has one, else show an error and return NULL.
FUNCTION get_handle_extravec(handle as integer) as integer vector ptr
DIM obj as any ptr
DIM htype as HandleType = decode_handle(obj, handle)
SELECT CASE htype
CASE HandleType.Slice
RETURN @(cast(Slice ptr, obj)->ExtraVec)
CASE HandleType.NPC
RETURN @(cast(NPCInst ptr, obj)->extravec)
CASE HandleType.Zone
RETURN @(cast(ZoneInfo ptr, obj)->extravec)
CASE HandleType.MenuItem
RETURN @(cast(MenuDefItem ptr, obj)->extravec)
CASE HandleType.Error
'Showed an error already
CASE ELSE
scripterr current_command_name() & ": " & handle_type_names(htype) & "s don't have variable length extra data arrays"
END SELECT
RETURN NULL
END FUNCTION
'==========================================================================================
' NPC references
'==========================================================================================
'Implementation of "npc reference".
'Deprecated; Use get_valid_npc for all new NPC commands
FUNCTION getnpcref (byval seekid as NPCScriptref, byval copynum as integer, byval pool as integer=0) as NPCIndex
SELECT CASE seekid
CASE -300 TO -1'--direct reference
RETURN (seekid + 1) * -1
CASE 0 TO UBOUND(npool(pool).npcs) 'ID
DIM found as integer = 0
FOR i as integer = 0 TO UBOUND(npc)
IF npc(i).id - 1 = seekid ANDALSO npc(i).pool = pool THEN
IF found = copynum THEN
RETURN i
END IF
found += 1
END IF
NEXT i
END SELECT
'--failure
RETURN -1
END FUNCTION
'Intended replacement for getnpcref (TODO: but this is missing the copynum arg!)
'Given NPC ref (pool ignored) or NPC ID+pool, return npc() index if valid, or throw a scripterr and return -1.
'Note this is stricter than getnpcref: invalid npc refs are not alright!
'References to Hidden/Disabled NPCs are alright.
FUNCTION get_valid_npc (byval seekid as NPCScriptref, byval errlvl as scriptErrEnum = serrBadOp, byval pool as integer=0) as NPCIndex
'TODO: recognise when seekid has the wrong type, e.g. slice handle
IF seekid < 0 THEN
DIM npcidx as NPCIndex = (seekid + 1) * -1
IF npcidx > UBOUND(npc) THEN
scripterr current_command_name() & ": invalid NPC reference " & seekid, errlvl
RETURN -1
ELSEIF npc(npcidx).id = 0 THEN
scripterr current_command_name() & ": invalid NPC reference " & seekid & " (maybe the NPC was deleted?)", errlvl
RETURN -1
END IF
RETURN npcidx
ELSE
FOR i as integer = 0 TO UBOUND(npc)
IF npc(i).id - 1 = seekid ANDALSO npc(i).pool = pool THEN RETURN i
NEXT
scripterr current_command_name() & ": no " & npc_pool_name(pool) & " NPCs with ID " & seekid & " exist", errlvl
RETURN -1
END IF
END FUNCTION
'Given seekid+pool, which are a NPC ref (pool must be -1) or NPC ID+pool (-1 means pool 0),
'if they point to a valid NPC return true and the NPC ID and pool in retid, retpool;
'otherwise throw a scripterr and return false.
'References to Hidden/Disabled NPCs are alright.
'Uses errlvl serrBadOp.
FUNCTION get_valid_npc_id_pool (seekid as NPCScriptref, pool as integer=-1, byref retid as NPCTypeID, byref retpool as integer) as bool
IF seekid >= 0 THEN
IF pool = -1 THEN pool = 0
IF pool < 0 ORELSE pool > UBOUND(npool) THEN
scripterr current_command_name() & ": invalid NPC pool " & pool
RETURN NO
END IF
IF seekid > UBOUND(npool(pool).npcs) THEN
scripterr current_command_name() & ": invalid NPC ID " & seekid
RETURN NO
END IF
retid = seekid
retpool = pool
ELSE
IF pool <> -1 THEN
scripterr current_command_name() & ": npc pool argument is only allowed when using an NPC ID, but an NPC reference was used"
RETURN NO
END IF
DIM npcidx as NPCIndex = get_valid_npc(seekid)
IF npcidx = -1 THEN RETURN NO
DIM id as NPCTypeID = ABS(npc(npcidx).id) - 1
retpool = npc(npcidx).pool
IF id > UBOUND(npool(retpool).npcs) THEN
'Note that an NPC may be marked hidden because it has an invalid ID
scripterr current_command_name() & ": NPC reference " & seekid & " is for a disabled NPC with invalid ID " & npc(npcidx).id & " (the map must be incompletely loaded)"
RETURN NO
END IF
retid = id
END IF
RETURN YES
END FUNCTION
'==========================================================================================
' Slice handles
'==========================================================================================
'Check whether a slice handle could be a previously valid, now freed one.
FUNCTION slice_handle_is_freed(handle as integer) as bool
DIM slot as uinteger = handle AND SLICE_HANDLE_SLOT_MASK
'Each slice handle is composed of a HandleType, counter, and slot. We check the HandleType and
'slot number are valid (plotslices() is never shrunk) and:
'-the slot is occupied by a different slice (.handle doesn't match because the counter differs)
'or
'-it's not currently occupied but was occupied in the past (so its .handle has been set to something
' with correct )
'We can mask off SLICE_HANDLE_CTR_MASK and check the rest matches to check the above.
IF slot > 0 ANDALSO slot <= UBOUND(plotslices) ANDALSO _
(plotslices(slot).handle <> handle ORELSE plotslices(slot).sl = NULL) ANDALSO _
(handle AND NOT SLICE_HANDLE_CTR_MASK) = (plotslices(slot).handle AND NOT SLICE_HANDLE_CTR_MASK) THEN
RETURN YES
END IF
END FUNCTION
'Return the Slice ptr for a slice handle, or throw an error
'and return NULL if not valid
FUNCTION get_handle_slice(byval handle as integer, byval errlvl as scriptErrEnum = serrBadOp) as Slice ptr
'It's not necessary to explicitly check get_handle_type(handle) >= HandleType.Slice,
'in fact we mustn't, to support obsolete handles in old saves which count up from 1.
DIM slot as uinteger = handle AND SLICE_HANDLE_SLOT_MASK
IF slot > UBOUND(plotslices) ORELSE plotslices(slot).handle <> handle ORELSE plotslices(slot).sl = NULL THEN
IF errlvl > serrIgnore THEN
IF slice_handle_is_freed(handle) THEN
IF errlvl > serrWarn THEN
scripterr current_command_name() & ": the slice with handle " & handle & " has been deleted", errlvl
END IF
ELSE
scripterr current_command_name() & ": " & handle & " is not a slice handle", errlvl
END IF
END IF
RETURN NULL
END IF
DIM sl as Slice ptr = plotslices(slot).sl
#IFDEF ENABLE_SLICE_DEBUG
IF SliceDebugCheck(sl) = NO THEN
showbug SlicePath(sl) & " is not in the slice debug table!"
RETURN NO
END IF
#ENDIF
RETURN sl
END FUNCTION
FUNCTION get_handle_typed_slice(byval handle as integer, byval sltype as SliceTypes, byval errlvl as scriptErrEnum = serrBadOp) as Slice ptr
DIM sl as Slice ptr = get_handle_slice(handle, errlvl)
IF sl = NULL THEN RETURN sl
IF sl->SliceType <> sltype THEN
slice_bad_op sl, "is not a " & SliceTypeName(sltype)
RETURN NULL
END IF
RETURN sl
END FUNCTION
/' Currently these are #defines, for speed
'Return the Slice ptr for the nth script command argument, or throw an error and
'return NULL if not a valid slice handle.
FUNCTION get_arg_slice(byval argno as integer, byval errlvl as scriptErrEnum = serrBadOp) as Slice ptr
RETURN get_handle_slice(retvals(argno), errlvl)
END FUNCTION
FUNCTION get_arg_typed_slice(byval argno as integer, byval sltype as SliceTypes, byval errlvl as scriptErrEnum = serrBadOp) as Slice ptr
RETURN get_handle_typed_slice(retvals(argno), sltype, errlvl)
END FUNCTION
'/
LOCAL SUB unresizable_error(sl as Slice ptr, reason as string, errlvl as scriptErrEnum = serrBadOp)
slice_bad_op sl, "can't be resized" & reason, errlvl
END SUB
'Fetch Slice ptr for the n'th script arg, if a valid resizeable slice handle
FUNCTION get_arg_resizeable_slice(byval argno as integer, byval horiz_fill_ok as bool=NO, byval vert_fill_ok as bool=NO) as Slice ptr
DIM sl as Slice Ptr
sl = get_arg_slice(argno)
IF sl THEN
IF SlicePossiblyResizable(sl) = NO THEN
'Text slices are resizable horizontally if and only if they wrap
'They are never resizable vertically, but does it really matter if we let people momentarily
'change the size? Leaving it be for backcompat.
IF sl->SliceType = slText THEN
'IF setting_height THEN '"set slice height", but not "fill parent"
' slice_bad_op sl, ": text height can never be set directly"
'ELSE
unresizable_error sl, ", unless wrap is enabled"
'END IF
' Scaling sprite slices isn't available in games yet.
'ELSEIF sl->SliceType = slSprite THEN
' unresizable_error sl, " unless scaling is enabled"
ELSE
unresizable_error sl, ", due to its type"
END IF
RETURN NULL
END IF
'This is only for "set slice width/height"; "fill parent" needs to do its own checks
IF ((sl->CoverChildren AND coverHoriz) ANDALSO horiz_fill_ok = NO) ORELSE _
((sl->CoverChildren AND coverVert) ANDALSO vert_fill_ok = NO) THEN
unresizable_error sl, " while Covering Children", serrWarn
RETURN NULL
END IF
IF sl->Fill = NO THEN RETURN sl
SELECT CASE sl->Fillmode
CASE sliceFillFull
IF horiz_fill_ok ANDALSO vert_fill_ok THEN RETURN sl
CASE sliceFillHoriz
IF horiz_fill_ok THEN RETURN sl
CASE sliceFillVert
IF vert_fill_ok THEN RETURN sl
END SELECT
'Maybe this should be just an info message?
unresizable_error sl, " while Filling Parent", serrWarn
END IF
RETURN NULL
END FUNCTION
FUNCTION create_plotslice_handle(byval sl as Slice Ptr) as integer
BUG_IF(sl = 0, "null ptr", 0)
IF sl->TableSlot <> 0 THEN
'this should not happen! Call find_plotslice_handle instead.
showbug sl & " slice references plotslices(" & sl->TableSlot & ") which has " & plotslices(sl->TableSlot).sl
RETURN 0
END IF
'If a lot of slices have been deleted, then loop back to the beginning
'to find reusable slices. We delay doing this so that handles are less likely
'to get reused quickly (which we don't actually want), and to amortise the cost of
're-scanning the whole array from the beginning.
'Slice handles won't be reused until at least 256*4000 = 1024000 slices are deleted.
'In future, new script interpreter's garbage collection will obsolete this.
IF num_reusable_slice_table_slots > 4000 THEN
next_slice_table_slot = 1 'Skip slot 0
num_reusable_slice_table_slots = 0
END IF
DIM slot as integer
FOR slot = next_slice_table_slot TO UBOUND(plotslices)
IF plotslices(slot).sl = 0 THEN EXIT FOR
NEXT
IF slot > UBOUND(plotslices) THEN
'If no room is available, make the array bigger.
DIM numslots as integer = small(SLICE_HANDLE_SLOT_MASK, UBOUND(plotslices) * 1.5 + 32)
REDIM PRESERVE plotslices(0 TO numslots)
plotslicesp = @plotslices(0)
END IF
IF slot > SLICE_HANDLE_SLOT_MASK THEN
'There may in fact be up to 4000 unused table slots
scripterr "Max number of slice handles (" & SLICE_HANDLE_SLOT_MASK & ") exceeded!", serrMajor
RETURN 0
END IF
WITH plotslices(slot)
.sl = sl
sl->TableSlot = slot
next_slice_table_slot = slot + 1
'Increment the previous ctr (already shifted) by 1, looping around to 0
DIM ctr as uinteger = (.handle + (1 SHL SLICE_HANDLE_CTR_SHIFT)) AND SLICE_HANDLE_CTR_MASK
.handle = make_handle_raw(HandleType.Slice, ctr OR slot)
RETURN .handle
END WITH
END FUNCTION
FUNCTION find_plotslice_handle(byval sl as Slice Ptr) as integer
IF sl = 0 THEN RETURN 0 ' it would be silly to search for a null pointer
IF sl->TableSlot THEN RETURN plotslices(sl->TableSlot).handle
'slice not in table, so create a new handle for it
RETURN create_plotslice_handle(sl)
END FUNCTION
SUB restore_saved_plotslice_handle(byval sl as Slice Ptr, handle as integer)
'This function is used to restore handles when loading a slice collection from a saved game.
'This should ONLY be called when starting a game, before any scripts have run!
BUG_IF(sl = 0, "null ptr")
BUG_IF(sl->TableSlot <> 0, "shouldn't be called on a slice with existing TableSlot")
SELECT CASE get_handle_type(handle)
CASE IS >= HandleType.Slice 'OK
CASE 0 'Also OK: an obsolete slice handle counting up from 1. We will continue to use it
CASE ELSE:
reporterr "Invalid saved slice handle " & handle & " in RSAV", serrMajor
EXIT SUB
END SELECT
DIM slot as uinteger = handle AND SLICE_HANDLE_SLOT_MASK
IF slot > UBOUND(plotslices) THEN
REDIM PRESERVE plotslices(0 TO slot * 1.5 + 32)
plotslicesp = @plotslices(0)
END IF
BUG_IF(plotslices(slot).sl, "non-empty plotslices(" & slot & ")")
'Store the slice pointer in the handle slot
plotslices(slot).sl = sl
plotslices(slot).handle = handle
'Store the handle slot in the slice
sl->TableSlot = slot
END SUB
FUNCTION valid_spriteset(spritetype as SpriteType, record as integer) as bool
RETURN bound_arg(record, 0, sprite_sizes(spritetype).lastrec, "spriteset number", , serrBadOp)
END FUNCTION
'By default, no palette set
LOCAL FUNCTION load_sprite_plotslice(byval spritetype as SpriteType, byval record as integer, byval pal as integer=-2) as integer
IF valid_spriteset(spritetype, record) THEN
DIM sl as Slice Ptr
sl = NewSliceOfType(slSprite, SliceTable.scriptsprite)
ChangeSpriteSlice sl, spritetype, record, pal
RETURN create_plotslice_handle(sl)
ELSE
RETURN 0 'Failure, return zero handle
END IF
END FUNCTION
'By default, no palette change
LOCAL SUB replace_sprite_plotslice(byval slice_argno as integer, byval spritetype as SpriteType, byval record as integer, byval pal as integer=-2)
DIM sl as Slice ptr
sl = get_arg_spritesl(slice_argno)
IF sl THEN
IF valid_spriteset(spritetype, record) THEN
ChangeSpriteSlice sl, spritetype, record, pal
END IF
END IF
END SUB
'==========================================================================================
' Menu and menuitem handles
'==========================================================================================
FUNCTION find_menu_id (byval id as integer) as integer
DIM i as integer
FOR i = topmenu TO 0 STEP -1
IF menus(i).record = id THEN
RETURN i 'return slot
END IF
NEXT i
RETURN -1 ' Not found
END FUNCTION
'NOTE: you should nearly always use valid_menu_handle instead, which throws an error.
FUNCTION find_menu_handle (byval handle as integer) as integer
DIM i as integer
FOR i = 0 TO topmenu
IF menus(i).handle = handle THEN RETURN i 'return slot
NEXT i
RETURN -1 ' Not found
END FUNCTION
FUNCTION valid_menu_handle (handle as integer, byref found_in_menuslot as integer, errlvl as scriptErrEnum = serrBadOp) as bool
DIM htype as HandleType = get_handle_type(handle)
IF htype <> HandleType.Menu THEN
scripterr current_command_name() + ": Expected menu handle, got " & describe_handle(handle), errlvl
RETURN NO
END IF
found_in_menuslot = find_menu_handle(handle)
IF found_in_menuslot = -1 THEN
scripterr current_command_name() + ": Invalid menu handle " & handle & " (menu already closed)", errlvl
RETURN NO
ELSE
RETURN YES
END IF
END FUNCTION
'Returns mislot and sets found_in_menuslot, otherwise returns -1 and sets found_in_menuslot=-1
FUNCTION find_menu_item_handle (handle as integer, byref found_in_menuslot as integer) as integer
FOR menuslot as integer = 0 TO topmenu
WITH menus(menuslot)
FOR mislot as integer = 0 TO .numitems - 1
IF .items[mislot]->handle = handle THEN
found_in_menuslot = menuslot
RETURN mislot
END IF
NEXT mislot
END WITH
NEXT menuslot
found_in_menuslot = -1
RETURN -1 ' Not found
END FUNCTION
' If handle is valid, return true and set menuslot and mislot, otherwise show an error and return false
' and set to -1,-1.
FUNCTION valid_menu_item_handle (handle as integer, byref found_in_menuslot as integer, byref found_in_mislot as integer = 0, errlvl as scriptErrEnum = serrBadOp) as bool
DIM htype as HandleType = get_handle_type(handle)
IF htype <> HandleType.MenuItem THEN
scripterr current_command_name() + ": Expected menu item handle, got " & describe_handle(handle), errlvl
RETURN NO
END IF
found_in_mislot = find_menu_item_handle(handle, found_in_menuslot)
IF found_in_mislot = -1 THEN
scripterr current_command_name() + ": invalid menu item handle " & handle & " (menu item already deleted)", errlvl
RETURN NO
ELSE
RETURN YES
END IF
END FUNCTION
' If handle is valid, return true and fill in the ptr to the MenuDefItem
FUNCTION valid_menu_item_handle_ptr (handle as integer, byref mi as MenuDefItem ptr, byref found_in_menuslot as integer = 0, byref found_in_mislot as integer = 0) as bool
IF valid_menu_item_handle(handle, found_in_menuslot, found_in_mislot) THEN
mi = menus(found_in_menuslot).items[found_in_mislot]
RETURN YES
END IF
RETURN NO
END FUNCTION
FUNCTION assign_menu_item_handle (byref mi as MenuDefItem) as integer
STATIC new_handle as integer = make_handle(HandleType.MenuItem, 0)
new_handle = new_handle + 1
mi.handle = new_handle
RETURN new_handle
END FUNCTION
FUNCTION assign_menu_handles (byref menu as MenuDef) as integer
STATIC new_handle as integer = make_handle(HandleType.Menu, 0)
new_handle = new_handle + 1
menus(topmenu).handle = new_handle
FOR i as integer = 0 TO menu.numitems - 1
assign_menu_item_handle *menu.items[i]
NEXT i
RETURN new_handle
END FUNCTION
FUNCTION menu_item_handle_by_slot(byval menuslot as integer, byval mislot as integer, byval visible_only as bool=YES) as integer
IF menuslot >= 0 AND menuslot <= topmenu THEN
WITH menus(menuslot)
IF mislot >= 0 AND mislot < .numitems THEN
WITH *.items[mislot]
IF visible_only ANDALSO NOT .visible THEN RETURN 0
RETURN .handle
END WITH
END IF
END WITH
END IF
RETURN 0
END FUNCTION
FUNCTION find_menu_item_slot_by_string(byval menuslot as integer, s as string, byval mislot as integer=0, byval visible_only as bool=YES) as integer
DIM i as integer
DIM cap as STRING
WITH menus(menuslot)
FOR i = mislot TO .numitems - 1
WITH *.items[i]
IF visible_only AND NOT .visible THEN CONTINUE FOR
cap = get_menu_item_caption(*menus(menuslot).items[i], menus(menuslot))
IF cap = s THEN
RETURN i
END IF
END WITH
NEXT i
END WITH
RETURN -1 ' not found
END FUNCTION
'==========================================================================================
' Other script command arg checking/decoding
'==========================================================================================
'This doesn't check how many players there are/how many joysticks are plugged in, because it's not an error
'to poll a missing player/joystick
FUNCTION valid_player_num(byval player as integer) as bool
RETURN bound_arg(player, 0, 15, "player number", , serrBadOp)
END FUNCTION
FUNCTION valid_item_slot(byval item_slot as integer) as bool
RETURN bound_arg(item_slot, 0, last_inv_slot(), "item slot")
END FUNCTION
FUNCTION valid_item(byval itemID as integer) as bool
RETURN bound_arg(itemID, 0, gen(genMaxItem), "item ID")
END FUNCTION
'Only use this where a command should be able to act on empty caterpillar hero slots!
FUNCTION valid_hero_caterpillar_rank(who as integer) as bool
RETURN bound_arg(who, 0, 3, "hero caterpillar party rank")
END FUNCTION
'Only use this where a command should be able to act on empty hero slots!
'(for compatibility, that's most of them!)
FUNCTION valid_hero_party(byval who as integer, byval minimum as integer=0) as bool
RETURN bound_arg(who, minimum, 40, "hero party slot")
END FUNCTION
FUNCTION really_valid_hero_party(byval who as integer, byval maxslot as integer=40, byval errlvl as scriptErrEnum = serrBadOp) as bool
'Defaults to a non-suppressed error
IF bound_arg(who, 0, maxslot, "hero party slot", , errlvl) = NO THEN RETURN NO
IF gam.hero(who).id = -1 THEN
scripterr current_command_name() + ": Party hero slot " & who & " is empty", errlvl
RETURN NO
END IF
RETURN YES
END FUNCTION
FUNCTION valid_stat(byval statid as integer) as bool
RETURN bound_arg(statid, 0, statLast, "stat ID", , serrBadOp)
END FUNCTION
FUNCTION valid_plotstr(byval n as integer, byval errlvl as scriptErrEnum = serrBound) as bool
RETURN bound_arg(n, 0, UBOUND(plotstr), "string ID", , errlvl)
END FUNCTION
FUNCTION valid_attack(byval id_plus_1 as integer) as bool
RETURN bound_arg(id_plus_1, 1, gen(genMaxAttack) + 1, "attack ID", , serrBadOp)
END FUNCTION
FUNCTION valid_enemy(byval id as integer) as bool
RETURN bound_arg(id, 0, gen(genMaxEnemy), "enemy ID", , serrBadOp)
END FUNCTION
FUNCTION valid_formation(byval form as integer) as bool
RETURN bound_arg(form, 0, gen(genMaxFormation), "formation ID")
END FUNCTION
FUNCTION valid_formation_slot(byval form as integer, byval slot as integer) as bool
IF bound_arg(form, 0, gen(genMaxFormation), "formation ID") THEN
RETURN bound_arg(slot, 0, 7, "formation slot")
END IF
RETURN NO
END FUNCTION
'Given a zone handle or zone ID return a zone ID, or 0 (and shows an error) if invalid.
FUNCTION get_handle_zoneid(byval handle as integer, byval errlvl as scriptErrEnum = serrBadOp) as integer
DIM htype as HandleType = get_handle_type(handle)
IF htype = HandleType.Zone ORELSE htype = HandleType.None THEN
DIM id as integer = get_handle_payload(handle)
IF bound_arg(id, 1, zoneLASTREADABLE, "zone ID", , errlvl) THEN RETURN id
ELSE
scripterr current_command_name() & "Expected zone ID or handle, got " & describe_handle(handle), errlvl
END IF
RETURN 0
END FUNCTION
/' Not used
FUNCTION valid_zone(byval id as integer) as bool
RETURN get_handle_zoneid(id) <> 0
END FUNCTION
'/
FUNCTION valid_door(byval id as integer) as bool
IF bound_arg(id, 0, UBOUND(gam.map.door), "door", , serrBadOp) = NO THEN RETURN NO
IF gam.map.door(id).exists = NO THEN
scripterr current_command_name() & ": invalid door id " & id, serrBadOp
RETURN NO
END IF
RETURN YES
END FUNCTION
FUNCTION valid_door(thisdoor as Door, byval id as integer=-1) as bool
IF thisdoor.exists = NO THEN
DIM errtext as string = current_command_name() & ": invalid (non-existent) door object"
IF id >= 0 THEN errtext &= " id " & id
scripterr errtext, serrBadOp
RETURN NO
END IF
RETURN YES
END FUNCTION
FUNCTION valid_tile_pos(byval x as integer, byval y as integer) as bool
IF x < 0 OR y < 0 OR x >= mapsizetiles.x OR y >= mapsizetiles.y THEN
scripterr current_command_name() + ": invalid map position " & XY(x,y) & " -- map is " & mapsizetiles.wh & " tiles", serrBadOp
RETURN NO
END IF
RETURN YES
END FUNCTION
FUNCTION valid_map(map_id as integer) as bool
RETURN bound_arg(map_id, 0, gen(genMaxMap), "map number", , serrBadOp)
END FUNCTION
FUNCTION valid_map_layer(layer as integer, errorlevel as scriptErrEnum = serrBadOp) as bool
IF layer < 0 OR layer > UBOUND(maptiles) THEN
scripterr current_command_name() + ": invalid map layer " & layer & " -- last map layer is " & UBOUND(maptiles), errorlevel
RETURN NO
END IF
RETURN YES
END FUNCTION
FUNCTION valid_save_slot(slot as integer) as bool
RETURN bound_arg(slot, 1, maxSaveSlotCount, "save slot", , serrBadOp)
END FUNCTION
'Loads a Door; map_id -1 means "current map".
'Returns true if thisdoor could be loaded EVEN IF the door doesn't exist (marked unused in door.bits())!
'Use valid_door() instead or afterwards to check the door exists.
FUNCTION get_door_on_map(byref thisdoor as Door, byval door_id as integer, byval map_id as integer) as bool
IF map_id = -1 OR map_id = gam.map.id THEN
'default to current map
IF door_id < 0 OR door_id > UBOUND(gam.map.door) THEN RETURN NO
thisdoor = gam.map.door(door_id)
RETURN YES
END IF
IF valid_map(map_id) THEN
IF read_one_door(thisdoor, map_id, door_id) THEN
RETURN YES
END IF
END IF
RETURN NO
END FUNCTION
FUNCTION valid_color(index as integer) as bool
RETURN bound_arg(index, -1 * uiColorLast - 1, 255, "color index (0-255) or UI color constant", , serrBadOp)
END FUNCTION
FUNCTION valid_box_style(index as integer) as bool
RETURN bound_arg(index, 0, uiBoxLast, "box style ID", , serrBadOp)
END FUNCTION
'A KBScancode (which is misnamed): a control key ("... key") or keyboard key ("key:...") or joystick button ("joy:...")
'But does NOT allow scMouse* constants. Does allow some scancodes that aren't mapped to any keys, including 0.
FUNCTION valid_key(byval key as integer, byval errlvl as scriptErrEnum = serrBadOp) as bool
RETURN bound_arg(key, scKEYVAL_FIRST, scKEYVAL_LAST, "scancode", , errlvl)
END FUNCTION
'==========================================================================================
' Utility functions for default arguments
'==========================================================================================
'This function is for when a new argument has been added that will exist in newer compiled
' scripts, but might be missing in old compiled scripts
FUNCTION get_optional_arg(byval retval_index as integer, byval default as integer) as integer
IF curcmd->argc < retval_index + 1 THEN
RETURN default
END IF
RETURN retvals(retval_index)
END FUNCTION
'==========================================================================================
' Misc command implementations
'==========================================================================================
SUB tweakpalette (byval r as integer, byval g as integer, byval b as integer, byval first as integer = 0, byval last as integer = 255)
FOR i as integer = first TO last
master(i).r = bound(master(i).r + r * 4, 0, 255)
master(i).g = bound(master(i).g + g * 4, 0, 255)
master(i).b = bound(master(i).b + b * 4, 0, 255)
NEXT i
END SUB
'"greyscale palette" command
SUB greyscalepal ()
FOR i as integer = bound(retvals(0), 0, 255) TO bound(retvals(1), 0, 255)
WITH master(i)
.r = bound(CINT(.r * 0.3 + .g * 0.59 + .b * 0.11), 0, 255)
.g = .r
.b = .r
END WITH
NEXT i
END SUB
SUB write_checkpoint ()
'This is used for automated testing.
' currently just writes a screenshot,
' but might also dump slice tree and other stuff too in the future.
STATIC n as integer = 0
DIM f as string = absolute_with_orig_path("checkpoint" & right("0000" & n, 5))
bmp_screenshot f
n += 1
END SUB
' Implementation of "check game exists"
LOCAL FUNCTION check_game_exists () as integer
IF valid_plotstr(retvals(0), serrBadOp) = NO THEN RETURN 0
' Parse the path
DIM path as string = plotstr(retvals(0)).s
' find_file_portably returns either an error message or a path
path = find_file_portably(path)
IF is_rpg(path) ORELSE is_rpgdir(path) THEN
RETURN 1
END IF
END FUNCTION
' Implementation of "run game".
LOCAL SUB run_game ()
' Not being able to load the game should always show an error (use serrMajor for everything)
IF valid_plotstr(retvals(0), serrMajor) = NO THEN RETURN
IF running_under_Custom THEN
' This would require more work to implement
scripterr "Sorry, you can't use " + current_command_name() + " while Testing Game"
RETURN
END IF
' Parse the path
DIM path as string = plotstr(retvals(0)).s
' find_file_portably returns either an error message or a path
path = find_file_portably(path)
IF isfile(path) = NO ANDALSO isdir(path) = NO THEN
scripterr interpreter_context_name() + path, serrMajor
RETURN
END IF
IF select_rpg_or_rpgdir(path) = NO THEN
scripterr interpreter_context_name() + "Not a valid game: " + path, serrMajor
RETURN
END IF
gam.want.rungame = path
' TODO: when switching to fibres, should call exit_interpreter() or something like that instead
script_start_waiting()
END SUB
'Although gmap commands are pretty undocumented anyway, restrict their use to avoid backcompat worries
FUNCTION allow_gmap_idx(gmap_idx as integer) as bool
SELECT CASE gmap_idx
CASE 0 TO 19: RETURN YES
CASE 32 TO 33: RETURN YES
CASE 378: RETURN YES
END SELECT
RETURN NO
END FUNCTION
FUNCTION get_enemy_sprite_size(index as integer) as XYPair
DIM szindex as integer = ReadShort(tmpdir & "dt1.tmp", index * getbinsize(binDT1) + 111) 'picture size
DIM sprset as integer = ReadShort(tmpdir & "dt1.tmp", index * getbinsize(binDT1) + 107) 'sprite set
DIM spr as Frame ptr = frame_load(sprTypeSmallEnemy + szindex, sprset)
DIM size as XYPair
IF spr THEN size = spr->Size
frame_unload @spr
RETURN size
END FUNCTION
FUNCTION bulk_append_extra(extravec_ptr as integer vector ptr, count_to_add as integer) as integer
'Returns the index of the first new extra element (or -1 if the allocation failed)
'Q: Why does this function exist instead of using resize_extra directly?
'A: This handles the default 3 elements for an uninitialized extra, as well as
' showing a script-level error
DIM byref extravec as integer vector = *extravec_ptr
IF extravec = NULL THEN v_new extravec, 3
DIM old_length as integer = v_len(extravec)
DIM new_length as integer = old_length + count_to_add
IF new_length > maxExtraLength THEN
scripterr "Can't expand extra array from " & old_length & "->" & new_length & ", exceeds max length, " & maxExtraLength
RETURN -1
ELSE
resize_extra *extravec_ptr, new_length
END IF
RETURN old_length 'old length is the same as the index of the first new element
END FUNCTION
FUNCTION bulk_append_or_replace(extravec_ptr as integer vector ptr, count_to_add as integer, append_extra as bool) as integer
'Either append or resize extra, and return the index of the first new element, or -1 on error
IF append_extra THEN
'Resize extra to append double the length of the path
RETURN bulk_append_extra(extravec_ptr, count_to_add)
ELSE
IF count_to_add > maxExtraLength THEN
scripterr "Can't resize extra to " & count_to_add & ", exceeds max length, " & maxExtraLength
RETURN -1
ELSE
'Erase old extra
resize_extra *extravec_ptr, 0
resize_extra *extravec_ptr, count_to_add
END IF
END IF
RETURN 0
END FUNCTION
FUNCTION copy_path_data_into_extra(extravec_ptr as integer vector ptr, byref pf as AStarPathfinder, destpos as XYPair, append_extra as bool, skip_start as bool) as bool
DIM new_length as integer = (v_len(pf.path) - IIF(skip_start, 1, 0) ) * 2
DIM start_index as integer = bulk_append_or_replace(extravec_ptr, new_length, append_extra)
IF start_index = -1 THEN
scripterr "Extra data allocation failed, discarding the pathfinding data"
ELSE
'Write the path into the extra data, Xs in the even indexes, Ys in the odd indexes
DIM write_offset as integer = start_index - IIF(skip_start, 1, 0) * 2
FOR i as integer = IIF(skip_start, 1, 0) to v_len(pf.path) - 1
(*extravec_ptr)[write_offset+i*2] = pf.path[i].x
(*extravec_ptr)[write_offset+i*2+1] = pf.path[i].y
NEXT i
'Return true if the path reached the destination
IF pf.path[v_len(pf.path) - 1] = destpos THEN RETURN YES
END IF
RETURN NO
END FUNCTION