Function index
Use this index when you know a function’s name. Each link opens its dedicated section with arguments, defaults, return value, requirements, and an example.
Functions beginning with sf2. come from local sf2 = require("sf2"). Methods beginning with fighter: are available inside combat callbacks. Names beginning with on_ are callbacks you supply when registering a behavior.
actor:change_formactor:change_healthactor:move_byactor:play_moveactor:removeactor:set_targetactor:snapshotfighter:acquire_camerafighter:actor_eventsfighter:actorsfighter:add_damage_shieldfighter:add_magic_chargefighter:add_outgoing_damagefighter:change_formfighter:change_healthfighter:clear_cloakfighter:clear_flagfighter:clear_model_colorfighter:clear_status_iconfighter:end_roundfighter:has_flagfighter:mark_rectfighter:mark_spritefighter:move_byfighter:overlaps_rectfighter:play_movefighter:projectilesfighter:remove_damage_shieldfighter:scale_incoming_damagefighter:scale_outgoing_damagefighter:set_button_cooldownfighter:set_cloakfighter:set_control_blockedfighter:set_control_visiblefighter:set_flagfighter:set_hit_blockedfighter:set_model_colorfighter:show_status_iconfighter:snapshotfighter:spawn_actorfighter:spawn_projectilefighter.opponent:add_magic_chargefighter.opponent:change_healthfighter.opponent:move_byfighter.opponent:overlaps_rectfighter.opponent:play_moveon_actor_endon_actor_spawnon_animation_endon_animation_starton_backon_before_fighton_blockon_cancelon_changeon_clickon_closeon_combo_changedon_completeon_criticalon_damage_dealingon_damage_dealton_damage_receivedon_damage_resolvingon_decideon_fight_beginon_fight_endon_hit_post_criton_hit_pre_criton_post_hiton_prepareon_resulton_round_beginon_round_endon_style_changedon_tickprojectile:move_byprojectile:removeprojectile:snapshotrequiresf2.achievements.registersf2.actors.registersf2.assets.audiosf2.assets.binarysf2.assets.existssf2.assets.modelsf2.assets.qualifysf2.assets.replacesf2.assets.spritesf2.audio.is_playingsf2.audio.playsf2.audio.set_volumesf2.audio.stopsf2.battles.focussf2.battles.patchsf2.battles.registersf2.battles.revealsf2.battles.set_lockedsf2.behaviors.registersf2.counters.addsf2.counters.getsf2.counters.registersf2.enchantments.registersf2.events.registersf2.extensions.callsf2.extensions.getsf2.extensions.registersf2.extensions.try_callsf2.fights.patchsf2.fights.registersf2.forge.configure_candidatesf2.forge.configure_recipesf2.forge.exclude_candidatesf2.forge.override_deviationsf2.forge.profilesf2.forge.register_profilesf2.forge.register_recipesf2.fx.glintsf2.fx.lightsf2.fx.on_framesf2.fx.overlaysf2.fx.particlessf2.fx.playsf2.fx.resetsf2.fx.screensf2.fx.setsf2.fx.shadowsf2.fx.stainsf2.fx.trailsf2.items.aliassf2.items.getsf2.items.register_armorsf2.items.register_consumablesf2.items.register_freesf2.items.register_helmsf2.items.register_magicsf2.items.register_rangedsf2.items.register_sealsf2.items.register_weaponsf2.items.set_default_enchantmentssf2.items.set_initial_profilesf2.items.set_innate_perkssf2.items.set_presentationsf2.items.set_subtypesf2.items.set_tactic_subtypesf2.items.tombstonesf2.itemsets.registersf2.locales.registersf2.localization.keysf2.localization.patchsf2.localization.registersf2.localization.textsf2.locations.dojo_pickersf2.locations.namesf2.locations.registersf2.locations.reset_dojosf2.locations.select_dojosf2.locations.selected_dojosf2.locations.tagsf2.log.debugsf2.log.errorsf2.log.infosf2.log.warnsf2.modes.cancelsf2.modes.is_pendingsf2.modes.registersf2.modes.resolvesf2.moves.exclude_itemsf2.moves.extend_item_locksf2.moves.extend_perk_locksf2.moves.forksf2.moves.patchsf2.moves.registersf2.moves.register_templatesf2.moves.register_triggersf2.moves.remove_item_locksf2.moves.remove_perk_locksf2.moves.replacesf2.perks.getsf2.perks.recharge_indicatorsf2.perks.registersf2.price.coinssf2.price.gemssf2.profile.equipmentsf2.profile.fightsf2.profile.has_defeatedsf2.profile.itemsf2.profile.levelsf2.profile.perksf2.profile.set_eclipse_modesf2.progression.replace_perk_branchsf2.projectiles.registersf2.quests.registersf2.quests.suppresssf2.raids.registersf2.random.integersf2.random.numbersf2.rewards.registersf2.rules.attributessf2.rules.avatarsf2.rules.behaviorsf2.rules.equip_itemsf2.rules.groupsf2.rules.hot_groundsf2.rules.invert_joysticksf2.rules.light_in_the_darknesssf2.rules.namesf2.rules.no_animationsf2.rules.no_buttonsf2.rules.no_health_barsf2.rules.no_perkssf2.rules.perksf2.rules.randomsf2.rules.random_areasf2.rules.recharge_magic_each_roundsf2.rules.regenerationsf2.rules.remove_intervalsf2.rules.require_itemsf2.rules.ring_outsf2.scenes.opensf2.services.disablesf2.settings.getsf2.settings.togglesf2.shop.add_itemsf2.shop.set_availabilitysf2.shop.set_pricesf2.state.getsf2.state.registersf2.state.setsf2.state.unsetsf2.story.before_fightsf2.story.cancel_fightsf2.story.fight_pendingsf2.story.is_activesf2.story.offsf2.story.onsf2.story.play_sequencesf2.story.resume_fightsf2.tactics.namesf2.tactics.registersf2.timers.setsf2.ui.act_screensf2.ui.closesf2.ui.dojo_buttonsf2.ui.get_textsf2.ui.is_opensf2.ui.opensf2.ui.set_checkedsf2.ui.set_enabledsf2.ui.set_spritesf2.ui.set_textsf2.ui.set_valuesf2.ui.set_visiblesf2.ui.story_dialogsf2.underworld.set_focussf2.underworld.set_map_colorssf2.underworld.set_toggle_visiblesf2.visuals.ambient_particlessf2.visuals.background_depthsf2.visuals.bloomsf2.visuals.depth_hazesf2.visuals.impactsf2.visuals.ink_hudsf2.visuals.knockout_outrosf2.visuals.rim_lightsf2.visuals.weapon_trailssf2.warriors.get_templatesf2.warriors.registersf2.warriors.register_templatesf2.world.is_camera_activesf2.world.is_marker_activesf2.world.release_camerasf2.world.remove_markersf2.world.set_camerasf2.world.set_marker_colorsf2.world.set_marker_rectsf2.world.set_marker_spritesf2.zones.getsf2.zones.register