Code Documentation
Documentation for many of the functions and objects utilized by the engine.
These functions and objects can be refrenced in your own events and conditions.
Documentation
- GameState class
GameStateGameState.is_displaying_overworld()GameState.levelGameState.level_nidGameState.current_partyGameState.tilemapGameState.bg_tilemapGameState.modeGameState.partyGameState.get_party()GameState.unitsGameState.regionsGameState.get_data()GameState.get_unit()GameState.get_klass()GameState.get_convoy_inventory()GameState.get_item()GameState.get_skill()GameState.get_region()GameState.get_region_under_pos()GameState.get_ai_group()GameState.ai_group_active()GameState.get_units_in_ai_group()GameState.get_all_units()GameState.get_player_units()GameState.get_enemy_units()GameState.get_enemy1_units()GameState.get_enemy2_units()GameState.get_other_units()GameState.get_team_units()GameState.get_travelers()GameState.get_player_units_and_travelers()GameState.get_rescuer()GameState.get_rescuers_position()GameState.get_all_units_in_party()GameState.get_units_in_party()GameState.get_all_player_units()GameState.is_roam()GameState.get_roam_unit()GameState.check_dead()GameState.check_alive()GameState.get_terrain_nid()GameState.get_all_formation_spots()GameState.get_open_formation_spots()GameState.get_money()GameState.get_bexp()GameState.get_random()GameState.get_random_float()GameState.get_random_choice()GameState.get_random_weighted_choice()
- Level Object
- UnitObject class
UnitObjectUnitObject.nidUnitObject.prefab_nidUnitObject.genericUnitObject.persistentUnitObject.aiUnitObject.ai_groupUnitObject.roam_aiUnitObject.factionUnitObject.teamUnitObject.portrait_nidUnitObject.affinityUnitObject.klassUnitObject.variantUnitObject.nameUnitObject.descUnitObject.partyUnitObject.levelUnitObject.expUnitObject.statsUnitObject.growthsUnitObject.growth_pointsUnitObject.stat_cap_modifiersUnitObject.wexpUnitObject.positionUnitObject.starting_positionUnitObject.previous_positionUnitObject.travelerUnitObject.strike_partnerUnitObject.lead_unitUnitObject.deadUnitObject.is_dyingUnitObject.itemsUnitObject.has_rescuedUnitObject.has_takenUnitObject.has_givenUnitObject.has_droppedUnitObject.has_run_aiUnitObject.get_max_hp()UnitObject.get_hp()UnitObject.get_max_mana()UnitObject.get_mana()UnitObject.get_max_fatigue()UnitObject.get_fatigue()UnitObject.get_exp()UnitObject.add_skill()UnitObject.remove_skill()UnitObject.skillsUnitObject.stat_bonus()UnitObject.get_stat()UnitObject.get_growth()UnitObject.get_stat_cap()UnitObject.get_damage_with_current_weapon()UnitObject.get_accuracy_with_current_weapon()UnitObject.get_avoid_with_current_weapon()UnitObject.tagsUnitObject.get_ai()UnitObject.get_roam_ai()UnitObject.accessoriesUnitObject.nonaccessoriesUnitObject.get_skill()UnitObject.get_weapon()UnitObject.get_accessory()UnitObject.can_equip()UnitObject.get_internal_level()
- RegionObject class
- RegionPrefab class
- Party Object
- Unit Helper Functions
growth_rate()growth_contribution()base_growth_rate()difficulty_growth_rate()get_next_level_up()auto_level()difficulty_auto_level()apply_stat_changes()apply_growth_changes()get_starting_skills()get_personal_skills()get_global_skills()can_unlock()can_pairup()check_focus()check_flanked()check_flanking()wait()usable_wtypes()get_weapon_cap()
- Item Helper Functions
is_magic()is_ranged()is_heal()is_mana_restore()available()has_magic()can_use()can_repair()has_repair()buy_price()sell_price()repair_price()create_item()get_all_items()get_all_items_with_multiitems()get_all_items_and_abilities()is_weapon_recursive()is_spell_recursive()get_all_items_from_multi_item()get_all_tradeable_items()get_all_storeable_items()get_num_items()get_num_accessories()too_much_in_inventory()inventory_full()get_range()get_range_string()get_max_range()num_stacks()can_be_used_in_base()
- Useful Functions
GameQueryEngineGameQueryEngine.get_item()GameQueryEngine.get_subitem()GameQueryEngine.has_item()GameQueryEngine.get_skill()GameQueryEngine.has_skill()GameQueryEngine.get_klass()GameQueryEngine.get_class()GameQueryEngine.get_closest_allies()GameQueryEngine.get_units_within_distance()GameQueryEngine.get_allies_within_distance()GameQueryEngine.get_units_in_area()GameQueryEngine.get_debuff_count()GameQueryEngine.get_units_in_region()GameQueryEngine.any_unit_in_region()GameQueryEngine.is_dead()GameQueryEngine.u()GameQueryEngine.v()GameQueryEngine.get_support_rank()GameQueryEngine.get_terrain()GameQueryEngine.has_achievement()GameQueryEngine.check_shove()GameQueryEngine.check_bypass_shove()
- Constants