Skip to content

Script calls User API

Pheonix KageDesu edited this page Sep 22, 2022 · 14 revisions

⚠️ Information actual for version 0.8 and above
⚠️ Page is not complete yet...


⚠️ Examples you can find in Demo Project, map uAPI (ID 5) 🗺️

ABS System

  • uAPI.resumeABS();

  • uAPI.pauseABS();

  • uAPI.scriptAction(ACTION, CHAR, DELAY);

ACTION - Script action
CHAR - null, $gamePlayer, event object or this (current Event) (OPTIONAL)
DELAY - delay before call in milliseconds (OPTIONAL)

Example: play Balloon animation 1 above this Event after 100ms delay - uAPI.scriptAction("ba_1", this, 100);
Example: turn ON self switch A for event 18 - uAPI.scriptAction("ss_A_true_18");

UI

  • uAPI.editUI(); - starts UI editor scene
  • uAPI.showUI();
  • uAPI.hideUI();
  • uAPI.resetUserUISettings(); - reset all UI settings (changed via Editor or Script calls) to defaults (from Plugin Parameters)

Skill Panel

  • uAPI.setSkillToPanel(ID, SLOT_SYMBOL);
  • uAPI.setItemToPanel(ID, SLOT_SYMBOL);

ID - it's skill or item ID from database
SLOT_SYMBOL - it's slot key (1,2 or E...)

For remove item, use 0 instead ID
Example: Remove any skill from Slot 5 uAPI.setSkillToPanel(0, 5);

For add item\skill in any empty skill slot, not use any SLOT_SYMBOL (keep empty)
Example: Add item 10 in any empty slot uAPI.setItemToPanel(10);

  • uAPI.getSkillIdFromPanel(SLOT_SYMBOL);
    - return skill or item ID from skill slot, or 0 if slot is empty

Camera

  • uAPI.enableMapScroll();
  • uAPI.disableMapScroll();
  • uAPI.resetMapScroll(); - reset camera to center

Enemies

  • uAPI.gainExpForEnemyDb( ENEMY_DB_ID, IS_SHOW_NOTIFY );
    - get experience for enemy by his database ID

  • uAPI.gainExpForEnemyEv( EVENT_ID, IS_SHOW_NOTIFY );
    - get experience for enemy by his Event ID on map (only for ABS events)

IS_SHOW_NOTIFY - show popUp? true or false
Example: uAPI.gainExpForEnemyDb(10, true);

  • uAPI.getEnemyByLabel( LABEL );
    - return first Game_Event object from Map by matching label ABS parameter

  • uAPI.getEnemiesByLabel( LABEL );
    - return all Game_Events objects (array) from Map by matching label ABS parameter

Example: uAPI.getEnemyByLabel("boss"); // returns Game_Event object with enemy that have ABS parameter <label: boss>

  • uAPI.gainHpForBattler(CHAR_ID, VALUE, IS_CRIT); - change enemy or character HP with PopUp text

Example: uAPI.gainHpForBattler(8, -10, false)// decrease HP by 10 for Enemy (event 8) and show's PopUp text above

⚠️ Examples you can find in Demo Project, map Exp (ID 14) 🗺️

Skills

  • uAPI.lastUsedSkill();
    - return last used skill database object

  • uAPI.lastSkillUser();
    - return last skill user, Character object (Event or Game_Player)

  • uAPI.lastUsedSkillTarget();
    - return last used skill target, Character object (Event or Game_Player)

⚠️ Example (in Demo project) -> Skill 301 uses <onHit:ce_4> and call this script calls via Common Event 4


Clone this wiki locally