Module yareio::spirit

Spirits are the game’s units. They carry energy which is used for creating new spirits, fighting, and capturing outposts.

Constants

ENERGIZE_RANGE

Maximum range of energy transfer.

EXPLODE_DAMAGE

The amount of damage given to enemy spirits in the EXPLODE_RADIUS once a spirit explodes.

EXPLODE_RADIUS

Radius from the exploding spirit where enemy spirits take damage.

JUMP_COST_PER_DIST

The cost of a jump for squares per unit distance. Cost is then rounded up.

MAX_CIRCLE_SIZE

Maximum size that circles can reach through merging.

MERGE_DISTANCE

Maximum merge distance for circles. See spirit::merge for more information.

MOVEMENT_SPEED

Movement speed of spirits in units per tick.

Functions

count^⚠

Get the number of spirits in the game.

divide^⚠

Divides spirit back into all the spirits that were merged into it.

energize^⚠

Transfer energy to another spirit* equal to the spirit’s size. Maximum distance for energy transfer is 200 units.

energize_base^⚠

Transfer energy to a base equal to the spirit’s size. Maximum distance for energy transfer is 200 units.

energize_outpost^⚠

Transfer energy to an outpost. Maximum distance for energy transfer is 200 units.

energize_star^⚠

Transfer energy to a star. Maximum distance for energy transfer is 200 units.

energy^⚠

Get the current energy of the spirit.

energy_capacity^⚠

The energy capacity of a spirit is the maximum amount of energy is can hold. It is equal to ten times its size.

explode^⚠

Spirit explodes, killing itself and dealing 10 damage to all enemy spirits within 100 radius.

goto^⚠

Moves spirit to target (x, y) with a speed of 20 units per tick.

hp^⚠

Get the spirit’s hp. This is equal to 1 when the spirit is alive and 0 when it is dead.

id^⚠

Get the spirit’s id. This is a combination of its player_id and number.

jump^⚠

Teleports the spirit into a new location up to 300 units away. Costs half of spirit’s energy capacity.

last_energized_id^⚠

Get the id of the last energized spirit by the spirit. If the last energized object was not a spirit, then blame @l0laapk3.

last_energized_number^⚠

Get the number of the last energized spirit by the spirit. If the last energized object was not a spirit, then blame @l0laapk3.

last_energized_player_id^⚠

Get the player id of the last energized spirit by the spirit. If the last energized object was not a spirit, then blame @l0laapk3.

merge^⚠

Merge the spirit into another friendly spirit. Target spirit needs to be within a 10 unit radius.

number^⚠Deprecated

Get the number of the spirit.

player_id^⚠Deprecated

Get the index of the player who controls the spirit.

position^⚠

Get the position of the spirit.

shape^⚠

Get the shape of the spirit. This is 0 for circles, 1 for squares.

shout^⚠

Show a message above the spirit as a light-weight in-game communication. Useful for some debugging as well.

size^⚠

Get the size of the spirit. Circles can be 1-100, squares have 10, triangles have 3. Circles increase their size by merging. The size determines the rate of energy transfer.