Enums module

Enumerations for various data types.

All enum variants take the name of the variant as a string for its value. This means that anywhere an enum value is required, you can pass a string with its name.

Usage

local Enums = ELONA.require("core.Enums")

Enums

DamageSource	A source of damage to be used with LuaCharacter.damage_hp.
Color	A set of colors.
CurseState	The curse state of an item.
IdentifyState	The identify state of an item.
StatusAilment	A status effect applicable to a character.
Element	A type of elemental damage.
TileKind	A kind of tile to be used with Map.generate_tile.
Quality	The quality of randomly generated equipment.
Buff	The type of a buff.
MapType	The type of a map.
MapEntranceType	Determines how the player should be spawned in a map when entering it for the first time.
MapTileset	Indicates which map tile atlas to use for a map.
Gender	Possible genders of a character.
Relationship	Relationship of a character to the player.
CharaFlag	A flag that can be set on a character.
TraitType	The types of traits available.
CharaFindLocation	Location to search for characters using Chara.find.
ItemFindLocation	Location to search for items using Item.find.
ControlAllyOperation	Operation to use with Input.choose_ally.
RandomTitleType	Title type to use with World.random_title.
WishMatchType	Match type to use with Wish.match.
WishHook	Wish hook point to use with Wish.add.

Enums

# DamageSource

A source of damage to be used with LuaCharacter.damage_hp.

Enum Values:

• trap : (Enums.DamageSource)
• overcasting : (Enums.DamageSource)
• starvation : (Enums.DamageSource)
• poisoning : (Enums.DamageSource)
• curse : (Enums.DamageSource)
• backpack_weight : (Enums.DamageSource)
• fall_from_stairs : (Enums.DamageSource)
• audience : (Enums.DamageSource)
• burn : (Enums.DamageSource)
• adventuring : (Enums.DamageSource)
• unseen_hand : (Enums.DamageSource)
• food_poisoning : (Enums.DamageSource)
• blood_loss : (Enums.DamageSource)
• ether_disease : (Enums.DamageSource)
• acid : (Enums.DamageSource)
• shatter : (Enums.DamageSource)
• atomic_bomb : (Enums.DamageSource)
• iron_maiden : (Enums.DamageSource)
• guillotine : (Enums.DamageSource)
• hanging : (Enums.DamageSource)
• mochi : (Enums.DamageSource)

# Color

A set of colors.

Enum Values:

• none : (Enums.Color)
• white : (Enums.Color)
• green : (Enums.Color)
• red : (Enums.Color)
• blue : (Enums.Color)
• orange : (Enums.Color)
• yellow : (Enums.Color)
• grey : (Enums.Color)
• purple : (Enums.Color)
• cyan : (Enums.Color)
• light_red : (Enums.Color)
• gold : (Enums.Color)
• white2 : (Enums.Color)
• light_brown : (Enums.Color)
• dark_green : (Enums.Color)
• light_grey : (Enums.Color)
• pale_red : (Enums.Color)
• light_blue : (Enums.Color)
• light_purple : (Enums.Color)
• light_green : (Enums.Color)
• yellow_green : (Enums.Color)
• random_furniture : (Enums.Color)
• random_seeded : (Enums.Color)
• random_any : (Enums.Color)

# CurseState

The curse state of an item.

Enum Values:

• doomed : (Enums.CurseState)
• cursed : (Enums.CurseState)
• none : (Enums.CurseState)
• blessed : (Enums.CurseState)

Usage:

local item = Item.create(10, 10, "core.putitoro", 3)
  item.curse_state = "Blessed"

# IdentifyState

The identify state of an item.

Enum Values:

• unidentified : (Enums.IdentifyState)
• partly : (Enums.IdentifyState)
• almost : (Enums.IdentifyState)
• completely : (Enums.IdentifyState)

Usage:

local item = Item.create(10, 10, "core.putitoro", 3)
  item.identify_state = "Completely"

# StatusAilment

A status effect applicable to a character.

Enum Values:

• blinded : (Enums.StatusAilment)
• confused : (Enums.StatusAilment)
• paralyzed : (Enums.StatusAilment)
• poisoned : (Enums.StatusAilment)
• sleep : (Enums.StatusAilment)
• fear : (Enums.StatusAilment)
• dimmed : (Enums.StatusAilment)
• bleeding : (Enums.StatusAilment)
• drunk : (Enums.StatusAilment)
• insane : (Enums.StatusAilment)
• sick : (Enums.StatusAilment)

See also:

• LuaCharacter.apply_ailment

# Element

A type of elemental damage.

Enum Values:

• fire : (Enums.Element)
• cold : (Enums.Element)
• lightning : (Enums.Element)
• darkness : (Enums.Element)
• mind : (Enums.Element)
• poison : (Enums.Element)
• nether : (Enums.Element)
• sound : (Enums.Element)
• nerve : (Enums.Element)
• chaos : (Enums.Element)
• magic : (Enums.Element)
• cut : (Enums.Element)
• ether : (Enums.Element)
• acid : (Enums.Element)
• vorpal : (Enums.Element)

# TileKind

A kind of tile to be used with Map.generate_tile.

Enum Values:

• normal : (Enums.TileKind)
• wall : (Enums.TileKind)
• tunnel : (Enums.TileKind)
• room : (Enums.TileKind)
• fog : (Enums.TileKind)

See also:

• Map.generate_tile

# Quality

The quality of randomly generated equipment.

Enum Values:

• none : (Enums.Quality)
• bad : (Enums.Quality)
• good : (Enums.Quality)
• great : (Enums.Quality)
• miracle : (Enums.Quality)
• godly : (Enums.Quality)
• special : (Enums.Quality)

# Buff

The type of a buff.

Food buffs are lost when vomiting. Hex buffs can be removed with Holy Light/Vanquish Hex, and can be resisted.

Enum Values:

• buff : (Enums.Buff)
• hex : (Enums.Buff)
• food : (Enums.Buff)

# MapType

The type of a map.

Enum Values:

• world_map : (Enums.MapType)
• guild : (Enums.MapType)
• town : (Enums.MapType)
• field : (Enums.MapType)
• player_owned : (Enums.MapType)
• shelter : (Enums.MapType)
• temporary : (Enums.MapType)
• dungeon : (Enums.MapType)
• dungeon_tower : (Enums.MapType)
• dungeon_forest : (Enums.MapType)
• dungeon_castle : (Enums.MapType)

# MapEntranceType

Determines how the player should be spawned in a map when entering it for the first time.

Enum Values:

• stair_up : (Enums.MapEntranceType)
• stair_down : (Enums.MapEntranceType)
• custom : (Enums.MapEntranceType)
• center : (Enums.MapEntranceType)
• random : (Enums.MapEntranceType)
• world_map_pos : (Enums.MapEntranceType)
• specified : (Enums.MapEntranceType)
• south : (Enums.MapEntranceType)

# MapTileset

Indicates which map tile atlas to use for a map.

Enum Values:

• normal : (Enums.MapTileset)
• world_map : (Enums.MapTileset)

# Gender

Possible genders of a character.

Enum Values:

• random : (Enums.Gender)
• male : (Enums.Gender)
• female : (Enums.Gender)

# Relationship

Relationship of a character to the player.

Enum Values:

• aggressive : (Enums.Relationship)
• nonaggressive : (Enums.Relationship)
• unconcerned : (Enums.Relationship)
• neutral : (Enums.Relationship)
• friend : (Enums.Relationship)

# CharaFlag

A flag that can be set on a character.

The first 32 flags (up to IsQuickTempered) are "intrinsic" and will be reset when the character is refreshed.

Enum Values:

• is_floating : (Enums.CharaFlag)
• is_invisible : (Enums.CharaFlag)
• can_see_invisible : (Enums.CharaFlag)
• is_immune_to_confusion : (Enums.CharaFlag)
• is_immune_to_blindness : (Enums.CharaFlag)
• is_immune_to_fear : (Enums.CharaFlag)
• is_immune_to_sleep : (Enums.CharaFlag)
• is_immune_to_paralyzation : (Enums.CharaFlag)
• is_immune_to_poison : (Enums.CharaFlag)
• can_digest_rotten_food : (Enums.CharaFlag)
• is_protected_from_thieves : (Enums.CharaFlag)
• is_incognito : (Enums.CharaFlag)
• drops_gold : (Enums.CharaFlag)
• explodes : (Enums.CharaFlag)
• is_death_master : (Enums.CharaFlag)
• can_cast_rapid_magic : (Enums.CharaFlag)
• has_lay_hand : (Enums.CharaFlag)
• is_suitable_for_mount : (Enums.CharaFlag)
• splits : (Enums.CharaFlag)
• has_cursed_equipments : (Enums.CharaFlag)
• is_unsuitable_for_mount : (Enums.CharaFlag)
• is_immune_to_elemental_damage : (Enums.CharaFlag)
• splits2 : (Enums.CharaFlag)
• is_metal : (Enums.CharaFlag)
• cures_bleeding_quickly : (Enums.CharaFlag)
• has_power_bash : (Enums.CharaFlag)
• is_immune_to_mine : (Enums.CharaFlag)
• is_quick_tempered : (Enums.CharaFlag)
• is_livestock : (Enums.CharaFlag)
• is_married : (Enums.CharaFlag)
• has_made_gene : (Enums.CharaFlag)
• is_escorted : (Enums.CharaFlag)
• is_temporary : (Enums.CharaFlag)
• is_silent : (Enums.CharaFlag)
• has_been_used_stethoscope : (Enums.CharaFlag)
• has_own_sprite : (Enums.CharaFlag)
• is_leashed : (Enums.CharaFlag)
• is_contracting : (Enums.CharaFlag)
• is_quest_target : (Enums.CharaFlag)
• is_escorted_in_sub_quest : (Enums.CharaFlag)
• will_explode_soon : (Enums.CharaFlag)
• is_sentenced_daeth : (Enums.CharaFlag)
• is_lay_hand_available : (Enums.CharaFlag)
• is_ridden : (Enums.CharaFlag)
• is_lord_of_dungeon : (Enums.CharaFlag)
• has_own_name : (Enums.CharaFlag)
• is_pregnant : (Enums.CharaFlag)
• is_not_attacked_by_enemy : (Enums.CharaFlag)
• is_contracting_with_reaper : (Enums.CharaFlag)
• needs_refreshing_status : (Enums.CharaFlag)
• visited_just_now : (Enums.CharaFlag)
• breaks_into_debris : (Enums.CharaFlag)
• is_best_friend : (Enums.CharaFlag)
• is_hung_on_sand_bag : (Enums.CharaFlag)
• has_anorexia : (Enums.CharaFlag)
• was_passed_item_by_you_just_now : (Enums.CharaFlag)
• cures_mp_frequently : (Enums.CharaFlag)
• has_custom_talk : (Enums.CharaFlag)
• has_learned_words : (Enums.CharaFlag)
• only_christmas : (Enums.CharaFlag)

See also:

• LuaCharacter.set_flag

# TraitType

The types of traits available.

Enum Values:

• feat : (Enums.TraitType)
• mutation : (Enums.TraitType)
• nature : (Enums.TraitType)
• ether_disease : (Enums.TraitType)

# CharaFindLocation

Location to search for characters using Chara.find.

Enum Values:

• allies : (Enums.CharaFindLocation)
• others : (Enums.CharaFindLocation)

See also:

• Chara.find

# ItemFindLocation

Location to search for items using Item.find.

Enum Values:

• player_inventory : (Enums.ItemFindLocation)
• ground : (Enums.ItemFindLocation)
• player_inventory_and_ground : (Enums.ItemFindLocation)

See also:

• Item.find

# ControlAllyOperation

Operation to use with Input.choose_ally.

Enum Values:

• call_back : (Enums.ControlAllyOperation)
• sell : (Enums.ControlAllyOperation)
• pet_arena : (Enums.ControlAllyOperation)
• staying : (Enums.ControlAllyOperation)
• investigate : (Enums.ControlAllyOperation)
• gene_engineer : (Enums.ControlAllyOperation)

See also:

• Input.choose_ally

# RandomTitleType

Title type to use with World.random_title.

Enum Values:

• character : (Enums.RandomTitleType)
• weapon : (Enums.RandomTitleType)
• party : (Enums.RandomTitleType)
• living_weapon : (Enums.RandomTitleType)

See also:

• World.random_title

# WishMatchType

Match type to use with Wish.match.

Enum Values:

• prefix : (Enums.WishMatchType)
• suffix : (Enums.WishMatchType)
• include : (Enums.WishMatchType)
• perfect : (Enums.WishMatchType)

See also:

• Wish.match

# WishHook

Wish hook point to use with Wish.add.

Enum Values:

• first : (Enums.WishHook)
• before_vanilla_special : (Enums.WishHook)
• after_vanilla_special : (Enums.WishHook)
• before_vanilla_item : (Enums.WishHook)
• after_vanilla_item : (Enums.WishHook)
• before_vanilla_skill : (Enums.WishHook)
• after_vanilla_skill : (Enums.WishHook)
• last : (Enums.WishHook)

See also:

• Wish.add