Characters

combat

Casting skills, the skill bar, movement and the ranger's pet.

combat gives your character orders: cast skills, dodge, jump, move and glide. A skill can be given by skill id or by name, and is looked up on your character's skills. A target can be an Agent or an agent id; without one, the skill goes to your current target.

local target = agents.selected()
if target and combat.is_ready("Signet of Might") then
    combat.cast("Signet of Might")
end

if me:health().percent < 30 then
    combat.evade(combat.EVADE_DOWN)
end

Casting

combat.cast(skill [, target])boolean
Casts a skill, at a target or your current one. False if you don't have the skill.
combat.cast_at(skill, pos)boolean
Casts a ground-targeted skill at a position.
combat.cast_slot(slot, skill_id [, target])boolean
Casts a skill as if from a skill bar slot.
combat.cast_slot_at(slot, skill_id, pos)boolean
The same, at a position.
combat.cast_mastery(skill_id [, target])boolean
Casts a mastery skill.
combat.cast_mastery_at(skill_id, pos)boolean
Casts a mastery skill at a position.
combat.check_los(skill_id, pos)boolean
Whether the skill has line of sight to a position.
combat.cancel_current_skill()
Cancels the cast in progress.
combat.current_skill()table?
What you're casting: {id, skill_id, name, target_agent_id}.
combat.is_casting([skill_id])boolean
Whether you're casting anything, or that skill.

Skills and the skill bar

combat.skills()Skill[]?
Your character's skills. See Skill.
combat.skill(skill)Skill?
One of your skills, by id or name.
combat.skill_by_slot(slot)Skill?
The skill in a skill bar slot.
combat.is_ready(skill)boolean
Whether one of your skills is off cooldown and usable.
combat.get_skill(skill_id)Skill?
Any skill by id, whether or not you have it.
combat.skill_triggers(skill_id, underwater, quickness)table[]?
When a skill's effects happen during its cast: a list of {trigger_type, time}.
combat.queued_skills()Skill[]?
Skills queued to cast next.
combat.selected_auto_attack_slot()integer?
The slot set to auto-attack.
combat.select_auto_attack([slot])
Sets which slot auto-attacks.
combat.weapon_swap_cooldown()number?
Time left on weapon swap.
combat.weapon_swap_ready()boolean
Whether you can swap weapons.
combat.equip_skill(slot, skill_id)
Puts a utility, heal or elite skill in a slot.
combat.equip_weapon_skill(slot, skill_id)
Picks a weapon skill for a slot.
combat.equip_aquatic_skill(slot, skill_id)
Puts an underwater skill in a slot.

Movement and actions

combat.evade([direction])
Dodges. direction is one of the combat.EVADE_* constants, combat.EVADE_DOWN by default.
combat.is_evading()boolean
Whether you're dodging.
combat.set_move_dir(dir)
Moves in a direction.
combat.set_move_dir_with(dir, face)
Moves in a direction while facing another.
combat.move_direction()Vec3?
The direction you've been ordered to move.
combat.face(dir)
Turns to face a direction.
combat.halt()
Stops moving.
combat.swap_weapons()
Swaps weapon sets.
combat.stow_weapons()
Puts your weapons away.
combat.interact(agent)
Interacts with an agent.
combat.pickup(agent)
Picks up a ground item.
combat.revive(agent)
Revives an agent.
combat.finish(agent)
Finishes a downed agent.

Gliding

combat.open_glider()
Opens the glider.
Dodge directions
EVADE_UPEVADE_DOWNEVADE_LEFTEVADE_RIGHTEVADE_UP_LEFTEVADE_UP_RIGHTEVADE_DOWN_LEFTEVADE_DOWN_RIGHT

pet

The ranger's pet. Everything returns nil (or false) when you aren't a ranger.

pet.available()boolean
Whether you have a pet.
pet.active()Agent?
The pet out now.
pet.selected_pets()table[]?
Your selected pets, each {id, name}.
pet.mode()integer?
The pet's mode.
pet.toggle_mode()
Switches the pet's mode.
pet.swap_cooldown()number?
Time left until you can swap pets.
pet.swap_ready()boolean
Whether you can swap pets.
pet.swap()
Swaps pets.
pet.skills()Skill[]?
The pet's skills.
pet.skill(skill)Skill?
One pet skill, by id or name.
pet.attack([target])
Sends the pet to attack.
pet.skill_1([target])
Uses the pet's first skill. pet.skill_2 and pet.skill_3 use the others.
pet.return_to_me()
Calls the pet back.
pet.stow()
Stows the pet.
pet.activate()
Brings the pet out.

content_function

Special actions the game runs as content functions, such as fishing.

content_function.evade()
Evades.
content_function.evading()boolean
Whether that evade is in progress.
content_function.start_fishing_left()
Starts reeling left. stop_fishing_left stops.
content_function.start_fishing_right()
Starts reeling right. stop_fishing_right stops.
content_function.start(id)
Starts a content function by id.
content_function.stop(id)
Stops it.
PreviousAgent