Script Calls API - KageDesu/Alpha-ABS GitHub Wiki
⚠️ Available since build 980
Use API commands in Event Commands, Advanced -> Script...
Command list:
Main
uAPI.isABS
- return true if current map is ABS map
uAPI.isUI
- return true if ABS UI is visible
uAPI.isBattle
- return true if player in battle state
Interface
uAPI.hide
- hide all ABS interface
uAPI.show
- show ABS interface
uAPI.hideSkills
- hide the skill panel
uAPI.showSkills
- show the skill panel
uAPI.hideControls
- hide the control panel (UI Buttons)
uAPI.showControls
- show the control panel (UI Buttons)
uAPI.putText(text)
- show alert text
uAPI.putLine(text)
- add text
to items notify
uAPI.putLineWithIcon(text, icon index)
- add text
with icon
to items notify
Example: uAPI.putText('example')
Example: uAPI.putLine('example')
uAPI.showMiniText(eventId, "text", colorIndex)
- show mini message Wiki
Interface : Spell Panel
uAPI.UIClearSkills
- remove all items and skills from UI Spell panel
uAPI.UISetSkill(id, index)
- set skill (ID from database) to UI Spell panel to (index (1 - 8)).
Player must know this skill (has been learned), if no index is specified - any empty cell
Example: uAPI.UISetSkill(32, 1) - if Actor known Skill with ID 32, set it to first spell slot
Example: uAPI.UISetSkill(32) - if Actor known Skill with ID 32, set it to first empty spell slot
uAPI.UISetItem(id, index)
- same that UISetSkill, but for Items (item ID from database)
uAPI.UIRemoveSkill(id)
- remove skill (ID from database) from UI Spell panel
uAPI.UIRemoveItem(id)
- same for Items
uAPI.UIRemoveByIndex(index)
- remove any (skill or item) from UI Spell panel slot, index (1 - 8)
uAPI.UISavePanelState
- save currents UI Spell panel skills and items
uAPI.UIRestorePanelState
- restore saved UI Spell panel skills and items
Controls
uAPI.jumpOff
- disable jumping for player
uAPI.jumpOn
- enable jump
uAPI.rotateOff
- disable rotate by key \ to target for player
uAPI.rotateOn
- enable rotate
uAPI.weaponsOff
- disable favorite weapons circle
uAPI.weaponsOn
- enable favorite weapons circle
uAPI.doJump
- jump
uAPI.doFollow
- enable\disable follow mode
uAPI.doRotate
- rotate to target (mouse)
uAPI.doChangeWeapons
- open\close favorite weapons circle
uAPI.doAttack
- perform attack
uAPI.doReload
- perform firearm reload
uAPI.doUseShield
- perform Defense stance
uAPI.isJumpAllowed
- player can jump? return true or false
uAPI.isFollowAllowed
- player can follow? return true or false
uAPI.isRotateAllowed
- player can rotate? return true or false
uAPI.isWeaponsAllowed
- player can use favorite weapons? return true or false
uAPI.isCanUseShield
- player has equipped shield?
uAPI.isCanUseShieldNow
- player can perform Defense stance now?
uAPI.isSummonUnitExist
- player has summoned monster?
uAPI.showSummonMenu
- open summon monster menu (select circle)
uAPI.findNextTarget
- select next target on map
uAPI.findNearestTarget
- select nearest target on map
Player
uAPI.player
- return $gamePlayer (Game_Player)
uAPI.actor
- return player actor (Game_Actor)
uAPI.actorId
- return player actor ID (Number)
uAPI.target
- return current player target (Game_Event) (or null if target not selected)
uAPI.tActor
- return player target actor (Game_Enemy)
uAPI.tId
- return player target event ID on map
Party
uAPI.party[n]
- return Nth party member character (Game_Character), or null if not exists Nth party member
uAPI.pActor[n]
- return Nth party actor (Game_Actor)
uAPI.pActorID[n]
- return Nth party actor ID (Number)
uAPI.stopParty
- stop AI for party members (can be used when dialogs or cutscenes)
uAPI.resumeParty
- resume party members AI
Enemies
uAPI.findEnemy(id)
- return enemy (Game_Event) by ID (event ID on map)
uAPI.reviveE(id, time)
- resurrect enemy with ID in time (in seconds)
uAPI.loot(id)
- loot enemy with ID
uAPI.spawn(id, x, y)
- spawn enemy with ID (from spawn map) in x,y
uAPI.spawn(id, regionId)
- spawn enemy in region
uAPI.showEnemyVision
- draw enemies visors on map
uAPI.hideEnemyVision
- hide enemies visors on map
uAPI.setParamE(id, parameterName, newValue)
- set parameter for enemy with ID (see this page for parameters)
Example: uAPI.setParamE(32, "viewRadius", 3);
uAPI.findNearestEnemy(notetag, range, varId)
- find nearest to player enemy with notetag
in range
and set enemy ID to variable varId
Map
uAPI.encountersCount
- return enemy spawn count by Encounter on current map (see Map Encounters)
uAPI.aliveEnemiesCount
- return alive enemies (ABS events) count on current map
uAPI.deadEnemiesCount
- return dead enemies count
uAPI.inBattleEnemiesCount
- return enemies count with battle state
(engaged in battle)
Inventory
uAPI.inventoryOff
- disable inventory (player can't open it by key)
uAPI.inventoryOn
- enable inventory
uAPI.openInventory
- open inventory window
uAPI.closeInventory
- close inventory window
uAPI.addWeaponInPlayerStorage(id, count)
- put weapon (by ID) in player storage
uAPI.addItemInPlayerStorage(id, count)
- put item (by ID) in player storage
uAPI.addArmorInPlayerStorage(id, count)
- put armor (by ID) in player storage
uAPI.moveEquipedItemsToStorage()
- move all player equipped items to storage
uAPI.moveAllItemsToStorage()
- move all player (party) items to storage
uAPI.clearPlayerStorage()
- delete all items from storage
uAPI.refreshWeightSystem()
- refresh weight system (max party weight calculations)
uAPI.modifyInventoryMaxWeight(value)
- permanently add value to Party Max Weight(value should be > 0)