LuaBindings

These are the exported Core Scripting API functions available from all modules. There are numerous types used in this documentation:

Summary

Return type	Function and Description
`Action`	`ActionAttack(Creature target)` Create attack action
`Action`	`ActionCastSpellAt(String id, int x, int y)` Create cast spell action
`Action`	`ActionCastSpellOn(String id, Creature target)` Create cast spell action
`Action`	`ActionForceMove(int x, int y, Map m)` Create force move action
`Action`	`ActionInteract(int x, int y)` Create interact action
`Action`	`ActionMove(int x, int y)` Create move action
`Action`	`ActionTeleport(int x, int y, Map m)` Create teleport action
`Action`	`ActionUseItemAt(Item item, int x, int y)` Create use item action
`Action`	`ActionUseItemOn(Item item, Creature target)` Create use item action
`Action`	`ActionUseSkillAt(String id, int x, int y)` Create use skill action
`Action`	`ActionUseSkillOn(String id, Creature target)` Create use skill action
`void`	`AddClass(String id, String name)` Add character class to be used for creating new PCs
`void`	`AddItemToContainer(Container c, Item item)` Add item to container
`void`	`AddQuestEntry(String questId, String entryId)` Add quest entry
`void`	`AddQuestLog(String id, boolean finished)` Add quest log supplied as finished or active
`void`	`AddSkill(Creature pc, String id)` Add skill (learn it) to creature
`void`	`AddSP(Creature pc, int sp)` Add SP for player
`void`	`AddSpell(Creature pc, String id)` Add spell (learn it) to creature
`void`	`AddTextLog(String line)` Add line to text log shown to player
`void`	`Animation(int x, int y, int icon, int start, int length, String text)` Animation to be run, will lock UI until finished
`void`	`ApplyEffect(Effect fx, Creature c)` Apply effect on creature After applying the effect the effect object should not be applied to another creature
`TileEffect`	`ApplyEffectAtPosition(Effect fx, Map map, int x, int y)` Add effect as a TileEffect
`void`	`AutoSave()` Auto saves game on a auto save spot
`int`	`CalculateToHit(Creature attacker, Creature target)` Get to hit % if attacking target with current weapon
`boolean`	`CanSee(Creature c, int x, int y)` Check if creature can see tile
`Container`	`CreateContainer()` Create an empty container
`Entity`	`CreateEntity(String id)` Create new entity using supplied blueprint
`Container`	`CreateLoot(Map map, int x, int y)` Create loot container
`void`	`Debug(String s)` Debug print out
`void`	`DestroyEntity(Entity e)`
`int`	`DiceRoll(String s)` Roll dice from string, i.e.
`boolean`	`DoAction(Creature pc, Action a)` Do action instantly
`Effect`	`EffectBless(int dur, int amount)` Create BLESS effect
`Effect`	`EffectBurn(int dur, int amount)` Create BURN effect
`Effect`	`EffectCure()` Create CURE effect
`Effect`	`EffectCurse(int dur, int amount)` Create CURSE effect
`Effect`	`EffectCustom(int dur, String onApply, String onRemove)` Create CUSTOM effect
`Effect`	`EffectDamage(int amount)` Create DAMAGE effect
`Effect`	`EffectFreeze(int dur, int amount)` Create FREEZE effect
`Effect`	`EffectHaste(int dur, int amount)` Create HASTE effect
`Effect`	`EffectHeal(int amount)` Create HEAL effect
`Effect`	`EffectPierce(int dur, int amount)` Create PIERCE effect
`Effect`	`EffectPoison(int dur, int amount)` Create POISON effect
`Effect`	`EffectShield(int dur, int amount)` Create SHIELD effect
`Effect`	`EffectSlow(int dur, int amount)` Create SLOW effect
`Effect`	`EffectStrengthen(int dur, int amount)` Create a STRENGTHEN effect
`Effect`	`EffectVisual(int dur, int icon)` Create VISUAL effect
`Effect`	`EffectWeaken(int dur, int amount)` Create WEAKEN effect
`void`	`EndGame()` End module
`LuaTable`	`FindPath(Map m, int fx, int fy, int tx, int ty)` Find shortest path from one space to another
`LuaTable`	`FindPathThroughDoors(Map m, int fx, int fy, int tx, int ty)` Find shortest path from one space to another through doors
`int`	`GetAIR(Creature c)` Get AIR skill value
`int`	`GetAP(Creature c)` Get current AP
`int`	`GetARC(Creature c)` Get ARC skill value
`int`	`GetArmor(Creature c)` Get total armor for creature
`int`	`GetArmorPenalty(Creature c)` Get total armor penalty
`int`	`GetATK(Creature c)` Get ATK skill value
`String`	`GetBlueprintId(Entity e)` Get blueprint id from entity
`Container`	`GetContainer(String iid)` Get created container by its iid field
`int`	`GetCooldown(Creature pc, String id)` Get skill cooldown
`Creature`	`GetCreatureAtPosition(Map map, int x, int y)` Get creature at position on map (nil if not found)
`LuaTable`	`GetCreatures(Map map)` Get all creatures on map
`int`	`GetDamageBonus(Creature c)` Get damage bonus for creature
`int`	`GetDEF(Creature c)` Get DEF skill value
`int`	`GetDEX(Creature c)` Get DEX of creature
`int`	`GetDisarmRating(Trap t)` Get disarm rating for trap
`LuaTable`	`GetEffects(Creature c)` Get active effects on creature
`LuaTable`	`GetEffectsAtPosition(Map map, int x, int y)` Get effects at position on map
`String`	`GetEffectType(Effect fx)` Get effect type
`Item`	`GetEquipped(Creature pc, String slot)` Get equipped item in slot
`int`	`GetERT(Creature c)` Get ERT skill value
`int`	`GetFIR(Creature c)` Get FIR skill value
`String`	`GetGlobalVar(String var)`
`int`	`GetGold(Creature pc)` Get gold creature carries
`boolean`	`GetHasVisited(String mapId)` Check if players have visited a map
`int`	`GetHP(Creature c)` Get current HP
`String`	`GetIID(Entity e)` Get Instance ID of entity (unique id of entity)
`int`	`GetINT(Creature c)` Get INT of creature
`boolean`	`GetIsEnemy(Creature c)` Get IsEnemy value
`int`	`GetItemArmor(Item item)` Get item armor bonus
`int`	`GetItemArmorPenalty(Item item)` Get item armor penalty
`String`	`GetItemDamage(Item item)` Get item damage dice
`int`	`GetItemGold(Item item)` Get item value in gold
`boolean`	`GetItemIdentified(Item item)` Get if item is identified or not
`Entity`	`GetItemOwner(Item i)` Get item owner
`LuaTable`	`GetItems(Creature pc)` Get inventory of creature
`LuaTable`	`GetItemsInContainer(Container c)` Get items in container
`String`	`GetItemType(Item item)` Get item type
`int`	`GetItemUses(Item item)` Get item uses
`String`	`GetLocalVar(Entity e, String var)` Get local variable
`int`	`GetLOR(Creature c)` Get LOR skill value
`int`	`GetLUK(Creature c)` Get LUK skill value
`Map`	`GetMap(String id)` Get map from id
`Map`	`GetMapFromCreature(Creature c)` Get map from creature
`int`	`GetMaxHP(Creature c)` Get maximum HP
`int`	`GetMaxMP(Creature c)` Get maximum MP
`int`	`GetMP(Creature c)` Get current MP
`String`	`GetName(Entity e)` Get name of creature/item
`LuaTable`	`GetParty()` Get party list
`PointF`	`GetPosition(Creature c)` Get creature position
`LuaTable`	`GetSkills(Creature c)` Get list of skills known to creature
`int`	`GetSpellCost(String id)` Get cost of spell
`LuaTable`	`GetSpells(Creature c)` Get list of spells known to creature
`String`	`GetSpellTargetType(String id)` Get target type of spell
`int`	`GetSTR(Creature c)` Get STR of creature with effects
`int`	`GetTHF(Creature c)` Get THF skill value
`String`	`GetTile(Map m, int x, int y)` Get tile from map
`Trap`	`GetTrap(Map map, int x, int y)` Get trap object from position
`PointF`	`GetTrapPosition(Trap t)` Get position of trap
`int`	`GetWOD(Creature c)` Get WOD skill value
`int`	`GetWTR(Creature c)` Get WTR skill value
`void`	`GiveItem(Item i, Creature c)` Give item to creature
`boolean`	`HasQuestEntry(String questId, String entryId)` Check for active quest entry
`boolean`	`HasRequirement(Creature pc, String id)` Check if creature has requirements for Spell or Skill
`boolean`	`HasSkill(Creature c, String id)` Check if creature has skill
`boolean`	`HasSpell(Creature c, String id)` Check if creature has spell
`boolean`	`IsCreature(java.lang.Object o)` Check if object is creature
`boolean`	`IsInCombat()` Check if PCs are engaged in combat or not
`boolean`	`IsItem(java.lang.Object o)` Check if object is item
`boolean`	`IsOutdoor(Map m)` Get outdoor flag of map
`void`	`MoveTrap(Trap t, Map map, int x, int y)` Move trap to a new position
`void`	`OpenContainer(Container c)` Open container screen
`void`	`OpenShop(Creature shop)` Opens shop ui
`void`	`OpenTravelMap(String mapId, String locId)` Open travel map screen on supplied map
`Trap`	`PlaceTrap(String id, Map map, int x, int y)` Place a newly created trap on the map
`void`	`RemoveEffect(Creature c, Effect fx)` Remove effect from creature
`void`	`RemoveLoot(Map map, int x, int y)` Remove loot container from map
`void`	`RemoveQuestEntry(String questId, String entryId)` Remove quest entry
`void`	`RemoveQuestLog(String id)` Remove quest log from finished or active
`void`	`RemoveTileEffect(TileEffect fx)` Remove effect from map
`void`	`RemoveTrap(Trap t)` Remove trap from map
`void`	`SaveGame(boolean partyOnly)` Opens the saved game UI allowing user to save the game
`void`	`SetContainerOnClose(Container c, String onClose)`
`void`	`SetGlobalVar(String var, String val)`
`void`	`SetGold(Creature pc, int gold)` Set new gold amount for creature
`void`	`SetIsEnemy(Creature c, boolean enemy)` Set enemy flag
`void`	`SetItemArmor(Item item, int n)` Set item armor bonus
`void`	`SetItemArmorPenalty(Item item, int n)` Set item armor penalty
`void`	`SetItemDamage(Item item, String damage)` Set item damage dice
`void`	`SetItemGold(Item item, int gold)` Set item gold value
`void`	`SetItemIdentified(Item item, boolean identified)` Set item to identified or not
`void`	`SetItemUses(Item item, int uses)` Set item uses
`void`	`SetLocalVar(Entity e, String var, String val)` Set local variable
`void`	`SetMP(Creature c, int mp)` Set current MP
`void`	`SetTile(Map m, int x, int y, String tile)` Set tile on map
`void`	`SetTravelLocationVisible(String mapId, String locId, boolean visible)` Set location on travel map visible or hidden
`void`	`ShowPopupText(String text)` Show popup text that disappears by itself
`void`	`StartConversation(String id)` Start conversation
`void`	`StartEncounter(String id, Map map, int x, int y)` Start encounter, spawning everything defined

- Details
  - AddClass
```
void AddClass(String id,
                            String name)
```
    Add character class to be used for creating new PCs
    
    Parameters:
    
    id - Blueprint used for creating class
    
    name - Name of class
  - AddSP
```
void AddSP(Creature pc,
                         int sp)
```
    Add SP for player
    
    Parameters:
    
    pc - Creature to get SP
    
    sp - Amount of SP to add
  - CreateEntity
```
Entity CreateEntity(String id)
```
    Create new entity using supplied blueprint
    
    Parameters:
    
    id - Blueprint
    
    Returns:
    
    Entity object, or null if id not found
  - DestroyEntity
```
void DestroyEntity(Entity e)
```
  - GetBlueprintId
```
String GetBlueprintId(Entity e)
```
    Get blueprint id from entity
    
    Parameters:
    
    e - Entity (Creature, Map...)
    
    Returns:
    
    Blueprint id
  - ActionMove
```
Action ActionMove(int x,
                                int y)
```
    Create move action
    
    Parameters:
    
    x - Position
    
    y - Position
    
    Returns:
    
    New action
    
    See Also:
    
    DoAction(Creature, Action)
  - ActionTeleport
```
Action ActionTeleport(int x,
                                    int y,
                                    Map m)
```
    Create teleport action
    
    Parameters:
    
    x - Position
    
    y - Position
    
    m - Map
    
    Returns:
    
    New action
    
    See Also:
    
    DoAction(Creature, Action)
  - ActionForceMove
```
Action ActionForceMove(int x,
                                     int y,
                                     Map m)
```
    Create force move action
    
    Parameters:
    
    x - Position
    
    y - Position
    
    m - Map
    
    Returns:
    
    New Action
    
    See Also:
    
    DoAction(Creature, Action)
  - ActionAttack
```
Action ActionAttack(Creature target)
```
    Create attack action
    
    Parameters:
    
    target - Target creature
    
    Returns:
    
    New action
    
    See Also:
    
    DoAction(Creature, Action)
  - ActionInteract
```
Action ActionInteract(int x,
                                    int y)
```
    Create interact action
    
    Parameters:
    
    x - Position
    
    y - Position
    
    Returns:
    
    New action
    
    See Also:
    
    DoAction(Creature, Action)
  - ActionUseSkillOn
```
Action ActionUseSkillOn(String id,
                                      Creature target)
```
    Create use skill action
    
    Parameters:
    
    id - Skill
    
    target - Target creature
    
    Returns:
    
    New action
    
    See Also:
    
    DoAction(Creature, Action)
  - ActionUseSkillAt
```
Action ActionUseSkillAt(String id,
                                      int x,
                                      int y)
```
    Create use skill action
    
    Parameters:
    
    id - Skill
    
    x - Target
    
    y - Target
    
    Returns:
    
    New action
    
    See Also:
    
    DoAction(Creature, Action)
  - ActionCastSpellOn
```
Action ActionCastSpellOn(String id,
                                       Creature target)
```
    Create cast spell action
    
    Parameters:
    
    id - Spell
    
    target - Target creature
    
    Returns:
    
    New action
    
    See Also:
    
    DoAction(Creature, Action)
  - ActionCastSpellAt
```
Action ActionCastSpellAt(String id,
                                       int x,
                                       int y)
```
    Create cast spell action
    
    Parameters:
    
    id - Spell
    
    x - Target
    
    y - Target
    
    Returns:
    
    New action
    
    See Also:
    
    DoAction(Creature, Action)
  - ActionUseItemOn
```
Action ActionUseItemOn(Item item,
                                     Creature target)
```
    Create use item action
    
    Parameters:
    
    item - Item
    
    target - Target
    
    Returns:
    
    New action
    
    See Also:
    
    DoAction(Creature, Action)
  - ActionUseItemAt
```
Action ActionUseItemAt(Item item,
                                     int x,
                                     int y)
```
    Create use item action
    
    Parameters:
    
    item - Item
    
    x - Target
    
    y - Target
    
    Returns:
    
    New action
    
    See Also:
    
    DoAction(Creature, Action)
  - DoAction
```
boolean DoAction(Creature pc,
                               Action a)
```
    Do action instantly
    
    Parameters:
    
    pc - Creature to perform action
    
    a - Action to perform
    
    Returns:
    
    true if successful, false if action not possible
  - GetParty
```
LuaTable GetParty()
```
    Get party list
    
    Returns:
    
    List of party members, empty list if none
  - GetMap
```
Map GetMap(String id)
```
    Get map from id
    
    Parameters:
    
    id - ID of map
    
    Returns:
    
    Map entity
  - GetMapFromCreature
```
Map GetMapFromCreature(Creature c)
```
    Get map from creature
    
    Parameters:
    
    c - Creature
    
    Returns:
    
    Map
  - IsOutdoor
```
boolean IsOutdoor(Map m)
```
    Get outdoor flag of map
    
    Parameters:
    
    m - Map
    
    Returns:
    
    true if outdoor, else false
  - GetTile
```
String GetTile(Map m,
                                       int x,
                                       int y)
```
    Get tile from map
    
    Parameters:
    
    m - Map
    
    x - Position
    
    y - Position
    
    Returns:
    
    Tile (one character string)
  - SetTile
```
void SetTile(Map m,
                           int x,
                           int y,
                           String tile)
```
    Set tile on map
    
    Parameters:
    
    m - Map
    
    x - Position
    
    y - Position
    
    tile - New tile (one character string)
  - GetHasVisited
```
boolean GetHasVisited(String mapId)
```
    Check if players have visited a map
    
    Parameters:
    
    mapId - ID of map
    
    Returns:
    
    true if visited, else false
  - EffectStrengthen
```
Effect EffectStrengthen(int dur,
                                      int amount)
```
    Create a STRENGTHEN effect
    
    Parameters:
    
    dur - Duration of effect
    
    amount - Bonus amount
    
    Returns:
    
    Effect object
    
    See Also:
    
    ApplyEffect(Effect, Creature)
  - EffectWeaken
```
Effect EffectWeaken(int dur,
                                  int amount)
```
    Create WEAKEN effect
    
    Parameters:
    
    dur - Duration of effect
    
    amount - Weaken amount
    
    Returns:
    
    Effect object
    
    See Also:
    
    ApplyEffect(Effect, Creature)
  - EffectBless
```
Effect EffectBless(int dur,
                                 int amount)
```
    Create BLESS effect
    
    Parameters:
    
    dur - Duration of effect
    
    amount - Bless amount
    
    Returns:
    
    Effect object
    
    See Also:
    
    ApplyEffect(Effect, Creature)
  - EffectCurse
```
Effect EffectCurse(int dur,
                                 int amount)
```
    Create CURSE effect
    
    Parameters:
    
    dur - Duration of effect
    
    amount - Curse amount
    
    Returns:
    
    Effect object
    
    See Also:
    
    ApplyEffect(Effect, Creature)
  - EffectHaste
```
Effect EffectHaste(int dur,
                                 int amount)
```
    Create HASTE effect
    
    Parameters:
    
    dur - Duration of effect
    
    amount - Haste amount
    
    Returns:
    
    Effect object
    
    See Also:
    
    ApplyEffect(Effect, Creature)
  - EffectSlow
```
Effect EffectSlow(int dur,
                                int amount)
```
    Create SLOW effect
    
    Parameters:
    
    dur - Duration of effect
    
    amount - Slow amount
    
    Returns:
    
    Effect object
    
    See Also:
    
    ApplyEffect(Effect, Creature)
  - EffectPoison
```
Effect EffectPoison(int dur,
                                  int amount)
```
    Create POISON effect
    
    Parameters:
    
    dur - Duration of effect
    
    amount - Poison amount
    
    Returns:
    
    Effect object
    
    See Also:
    
    ApplyEffect(Effect, Creature)
  - EffectCure
```
Effect EffectCure()
```
    Create CURE effect
    
    Returns:
    
    Effect object
    
    See Also:
    
    ApplyEffect(Effect, Creature)
  - EffectDamage
```
Effect EffectDamage(int amount)
```
    Create DAMAGE effect
    
    Parameters:
    
    amount - Damage amount
    
    Returns:
    
    Effect object
    
    See Also:
    
    ApplyEffect(Effect, Creature)
  - EffectHeal
```
Effect EffectHeal(int amount)
```
    Create HEAL effect
    
    Parameters:
    
    amount - Heal amount
    
    Returns:
    
    Effect object
    
    See Also:
    
    ApplyEffect(Effect, Creature)
  - EffectShield
```
Effect EffectShield(int dur,
                                  int amount)
```
    Create SHIELD effect
    
    Parameters:
    
    dur - Duration of effect
    
    amount - Shield amount
    
    Returns:
    
    Effect object
    
    See Also:
    
    ApplyEffect(Effect, Creature)
  - EffectPierce
```
Effect EffectPierce(int dur,
                                  int amount)
```
    Create PIERCE effect
    
    Parameters:
    
    dur - Duration of effect
    
    amount - Pierce amount
    
    Returns:
    
    Effect object
    
    See Also:
    
    ApplyEffect(Effect, Creature)
  - EffectVisual
```
Effect EffectVisual(int dur,
                                  int icon)
```
    Create VISUAL effect
    
    Parameters:
    
    dur - Duration of effect
    
    icon - Icon
    
    Returns:
    
    Effect object
    
    See Also:
    
    ApplyEffectAtPosition(Effect, Map, int, int)
  - EffectBurn
```
Effect EffectBurn(int dur,
                                int amount)
```
    Create BURN effect
    
    Parameters:
    
    dur - Duration
    
    amount - Damage
    
    Returns:
    
    Effect object
    
    See Also:
    
    ApplyEffect(Effect, Creature)
  - EffectFreeze
```
Effect EffectFreeze(int dur,
                                  int amount)
```
    Create FREEZE effect
    
    Parameters:
    
    dur - Duration
    
    amount - Damage
    
    Returns:
    
    Effect obect
    
    See Also:
    
    ApplyEffect(Effect, Creature)
  - EffectCustom
```
Effect EffectCustom(int dur,
                                  String onApply,
                                  String onRemove)
```
    Create CUSTOM effect
    
    Parameters:
    
    dur - Duration of effect
    
    onApply - Script to run
    
    onRemove - Script o run when effect is removed
    
    Returns:
    
    Effect object
    
    See Also:
    
    ApplyEffectAtPosition(Effect, Map, int, int)
  - ApplyEffect
```
void ApplyEffect(Effect fx,
                               Creature c)
```
    Apply effect on creature After applying the effect the effect object should not be applied to another creature
    
    Parameters:
    
    fx - Effect object
    
    c - Creature to receive effect
  - ApplyEffectAtPosition
```
TileEffect ApplyEffectAtPosition(Effect fx,
                                               Map map,
                                               int x,
                                               int y)
```
    Add effect as a TileEffect
    
    Parameters:
    
    fx - Effect to base tile effect on (copied)
    
    map - Map
    
    x - Position
    
    y - Position
    
    Returns:
    
    New tile effect
  - GetEffectsAtPosition
```
LuaTable GetEffectsAtPosition(Map map,
                                            int x,
                                            int y)
```
    Get effects at position on map
    
    Parameters:
    
    map - Map
    
    x - Position
    
    y - Position
    
    Returns:
    
    List of TileEffects
    
    See Also:
    
    ApplyEffectAtPosition(Effect, Map, int, int)
  - RemoveTileEffect
```
void RemoveTileEffect(TileEffect fx)
```
    Remove effect from map
    
    Parameters:
    
    fx - TileEffect object
    
    See Also:
    
    GetEffectsAtPosition(Map, int, int)
  - GetItemType
```
String GetItemType(Item item)
```
    Get item type
    
    Parameters:
    
    item - Item
    
    Returns:
    
    Type of item
  - GetItemDamage
```
String GetItemDamage(Item item)
```
    Get item damage dice
    
    Parameters:
    
    item - Item
    
    Returns:
    
    Damage dice as string, ex 2d4+2
  - SetItemDamage
```
void SetItemDamage(Item item,
                                 String damage)
```
    Set item damage dice
    
    Parameters:
    
    item - Item
    
    damage - Damage dice as string, ex 2d4+2
  - GetItemArmor
```
int GetItemArmor(Item item)
```
    Get item armor bonus
    
    Parameters:
    
    item - Item
    
    Returns:
    
    Armor bonus
  - SetItemArmor
```
void SetItemArmor(Item item,
                                int n)
```
    Set item armor bonus
    
    Parameters:
    
    item - Item
    
    n - Armor bonus
  - GetItemArmorPenalty
```
int GetItemArmorPenalty(Item item)
```
    Get item armor penalty
    
    Parameters:
    
    item - Item
    
    Returns:
    
    Armor penalty
  - SetItemArmorPenalty
```
void SetItemArmorPenalty(Item item,
                                       int n)
```
    Set item armor penalty
    
    Parameters:
    
    item - Item
    
    n - Armor penalty
  - GetItemUses
```
int GetItemUses(Item item)
```
    Get item uses
    
    Parameters:
    
    item - Item
    
    Returns:
    
    Number of uses left
  - SetItemUses
```
void SetItemUses(Item item,
                               int uses)
```
    Set item uses
    
    Parameters:
    
    item - Item
    
    uses - Number of uses
  - GetItemGold
```
int GetItemGold(Item item)
```
    Get item value in gold
    
    Parameters:
    
    item - Item
    
    Returns:
    
    Gold amount, 0 if invalid item
  - SetItemGold
```
void SetItemGold(Item item,
                               int gold)
```
    Set item gold value
    
    Parameters:
    
    item - Item
    
    gold - New gold amount
  - SetItemIdentified
```
void SetItemIdentified(Item item,
                                     boolean identified)
```
    Set item to identified or not
    
    Parameters:
    
    item - Item
    
    identified - Identified item if true
  - GetItemIdentified
```
boolean GetItemIdentified(Item item)
```
    Get if item is identified or not
    
    Returns:
    
    true if identified
  - GetEffects
```
LuaTable GetEffects(Creature c)
```
    Get active effects on creature
    
    Parameters:
    
    c - Creature
    
    Returns:
    
    List of effects
  - RemoveEffect
```
void RemoveEffect(Creature c,
                                Effect fx)
```
    Remove effect from creature
    
    Parameters:
    
    c - Creature
    
    fx - Effect object
    
    See Also:
    
    GetEffects(Creature)
  - GetEffectType
```
String GetEffectType(Effect fx)
```
    Get effect type
    
    Parameters:
    
    fx - Effect object
    
    Returns:
    
    Type as string
  - GetPosition
```
PointF GetPosition(Creature c)
```
    Get creature position
    
    Parameters:
    
    c - Creature
    
    Returns:
    
    Position (x,y)
  - GetSpells
```
LuaTable GetSpells(Creature c)
```
    Get list of spells known to creature
    
    Parameters:
    
    c - Creature
    
    Returns:
    
    List of spell ids
  - HasSpell
```
boolean HasSpell(Creature c,
                               String id)
```
    Check if creature has spell
    
    Parameters:
    
    c - Creature
    
    id - Spell id
    
    Returns:
    
    true or false
  - GetSpellCost
```
int GetSpellCost(String id)
```
    Get cost of spell
    
    Parameters:
    
    id - Spell id
    
    Returns:
    
    Cost of spell, 0 if invalid id
  - GetSpellTargetType
```
String GetSpellTargetType(String id)
```
    Get target type of spell
    
    Parameters:
    
    id - Spell id
    
    Returns:
    
    Target type as defined in module XML (self, single, 3x3, 5x5)
  - GetSkills
```
LuaTable GetSkills(Creature c)
```
    Get list of skills known to creature
    
    Parameters:
    
    c - Creature
    
    Returns:
    
    List of skill ids
  - HasSkill
```
boolean HasSkill(Creature c,
                               String id)
```
    Check if creature has skill
    
    Parameters:
    
    c - Creature
    
    id - Skill id
    
    Returns:
    
    true or false
  - GetSTR
```
int GetSTR(Creature c)
```
    Get STR of creature with effects
    
    Parameters:
    
    c - Creature
    
    Returns:
    
    STR after effects
  - GetDEX
```
int GetDEX(Creature c)
```
    Get DEX of creature
    
    Parameters:
    
    c - Creature
    
    Returns:
    
    DEX
  - GetINT
```
int GetINT(Creature c)
```
    Get INT of creature
    
    Parameters:
    
    c - Creature
    
    Returns:
    
    INT
  - GetHP
```
int GetHP(Creature c)
```
    Get current HP
    
    Parameters:
    
    c - Creature
    
    Returns:
    
    HP
  - GetMaxHP
```
int GetMaxHP(Creature c)
```
    Get maximum HP
    
    Parameters:
    
    c - Creature
    
    Returns:
    
    Max HP
  - GetMP
```
int GetMP(Creature c)
```
    Get current MP
    
    Parameters:
    
    c - Creature
    
    Returns:
    
    MP
  - SetMP
```
void SetMP(Creature c,
                         int mp)
```
    Set current MP
    
    Parameters:
    
    c - Creature
    
    mp - new MP amount
  - GetMaxMP
```
int GetMaxMP(Creature c)
```
    Get maximum MP
    
    Parameters:
    
    c - Creature
    
    Returns:
    
    Max MP
  - GetAP
```
int GetAP(Creature c)
```
    Get current AP
    
    Parameters:
    
    c - Creature
    
    Returns:
    
    AP
  - GetATK
```
int GetATK(Creature c)
```
    Get ATK skill value
    
    Parameters:
    
    c - Creature
    
    Returns:
    
    ATK
  - GetDEF
```
int GetDEF(Creature c)
```
    Get DEF skill value
    
    Parameters:
    
    c - Creature
    
    Returns:
    
    DEF
  - GetARC
```
int GetARC(Creature c)
```
    Get ARC skill value
    
    Parameters:
    
    c - Creature
    
    Returns:
    
    ARC
  - GetWTR
```
int GetWTR(Creature c)
```
    Get WTR skill value
    
    Parameters:
    
    c - Creature
    
    Returns:
    
    WTR
  - GetFIR
```
int GetFIR(Creature c)
```
    Get FIR skill value
    
    Parameters:
    
    c - Creature
    
    Returns:
    
    FIR
  - GetAIR
```
int GetAIR(Creature c)
```
    Get AIR skill value
    
    Parameters:
    
    c - Creature
    
    Returns:
    
    AIR
  - GetERT
```
int GetERT(Creature c)
```
    Get ERT skill value
    
    Parameters:
    
    c - Creature
    
    Returns:
    
    ERT
  - GetTHF
```
int GetTHF(Creature c)
```
    Get THF skill value
    
    Parameters:
    
    c - Creature
    
    Returns:
    
    THF
  - GetWOD
```
int GetWOD(Creature c)
```
    Get WOD skill value
    
    Parameters:
    
    c - Creature
    
    Returns:
    
    WOD
  - GetLOR
```
int GetLOR(Creature c)
```
    Get LOR skill value
    
    Parameters:
    
    c - Creature
    
    Returns:
    
    LOR
  - GetLUK
```
int GetLUK(Creature c)
```
    Get LUK skill value
    
    Parameters:
    
    c - Creature
    
    Returns:
    
    LUK
  - GetIsEnemy
```
boolean GetIsEnemy(Creature c)
```
    Get IsEnemy value
    
    Parameters:
    
    c - Creature
    
    Returns:
    
    true for enemy
  - SetIsEnemy
```
void SetIsEnemy(Creature c,
                              boolean enemy)
```
    Set enemy flag
    
    Parameters:
    
    c - Creature
    
    enemy - true for enemy, false for friend
  - GiveItem
```
void GiveItem(Item i,
                            Creature c)
```
    Give item to creature
    
    Parameters:
    
    i - Item to give
    
    c - Creature to get it
  - GetDamageBonus
```
int GetDamageBonus(Creature c)
```
    Get damage bonus for creature
    
    Parameters:
    
    c - Creature
    
    Returns:
    
    Damage bonus
  - GetArmor
```
int GetArmor(Creature c)
```
    Get total armor for creature
    
    Parameters:
    
    c - Creature
    
    Returns:
    
    Armor bonus
  - GetArmorPenalty
```
int GetArmorPenalty(Creature c)
```
    Get total armor penalty
    
    Parameters:
    
    c - Armor penalty for creature
    
    Returns:
    
    Armor penalty
  - CalculateToHit
```
int CalculateToHit(Creature attacker,
                                 Creature target)
```
    Get to hit % if attacking target with current weapon
    
    Parameters:
    
    attacker - Attacking creature
    
    target - Target creature
    
    Returns:
    
    % to hit
  - GetCreatures
```
LuaTable GetCreatures(Map map)
```
    Get all creatures on map
    
    Parameters:
    
    map - Map to get list of creatures from
    
    Returns:
    
    List of creatures
  - GetCreatureAtPosition
```
Creature GetCreatureAtPosition(Map map,
                                             int x,
                                             int y)
```
    Get creature at position on map (nil if not found)
    
    Parameters:
    
    map - Map to search
    
    x - Position
    
    y - Position
    
    Returns:
    
    Creature (or nil if none)
  - AddQuestLog
```
void AddQuestLog(String id,
                               boolean finished)
```
    Add quest log supplied as finished or active
    
    Parameters:
    
    id - Quest log id
    
    finished - true for finished, false for active
  - AddQuestEntry
```
void AddQuestEntry(String questId,
                                 String entryId)
```
    Add quest entry
    
    Parameters:
    
    questId - Quest id, must be active or finished
    
    entryId - Entry id
  - RemoveQuestEntry
```
void RemoveQuestEntry(String questId,
                                    String entryId)
```
    Remove quest entry
    
    Parameters:
    
    questId - Quest id, must be active or finished
    
    entryId - Entry id
  - HasQuestEntry
```
boolean HasQuestEntry(String questId,
                                    String entryId)
```
    Check for active quest entry
    
    Parameters:
    
    questId - Quets id
    
    entryId - Entry id
    
    Returns:
    
    true if quest entry is active (shown)
  - RemoveQuestLog
```
void RemoveQuestLog(String id)
```
    Remove quest log from finished or active
    
    Parameters:
    
    id - Quest log id
  - StartConversation
```
void StartConversation(String id)
```
    Start conversation
    
    Parameters:
    
    id - Resource ID
  - IsCreature
```
boolean IsCreature(java.lang.Object o)
```
    Check if object is creature
    
    Parameters:
    
    o - Object to check
    
    Returns:
    
    True if creature, false if not
  - IsItem
```
boolean IsItem(java.lang.Object o)
```
    Check if object is item
    
    Parameters:
    
    o - Object to check
    
    Returns:
    
    True if item, false if not
  - Animation
```
void Animation(int x,
                             int y,
                             int icon,
                             int start,
                             int length,
                             String text)
```
    Animation to be run, will lock UI until finished
    
    Parameters:
    
    x - Tile position
    
    y - Tile position
    
    icon - Icon
    
    start - Start in game ticks (200ms)
    
    length - Length in game ticks (200ms)
    
    text - Text to show (nil = none)
  - Debug
```
void Debug(String s)
```
    Debug print out
    
    Parameters:
    
    s - String to print
  - FindPathThroughDoors
```
LuaTable FindPathThroughDoors(Map m,
                                            int fx,
                                            int fy,
                                            int tx,
                                            int ty)
```
    Find shortest path from one space to another through doors
    
    Parameters:
    
    m - Map to use for path finding
    
    fx - From position
    
    fy - From position
    
    tx - To position
    
    ty - To position
    
    Returns:
    
    List of points (.x and .y)
  - FindPath
```
LuaTable FindPath(Map m,
                                int fx,
                                int fy,
                                int tx,
                                int ty)
```
    Find shortest path from one space to another
    
    Parameters:
    
    m - Map to use for path finding
    
    fx - From position
    
    fy - From position
    
    tx - To position
    
    ty - To position
    
    Returns:
    
    List of points (.x and .y)
  - CanSee
```
boolean CanSee(Creature c,
                             int x,
                             int y)
```
    Check if creature can see tile
    
    Parameters:
    
    c - Creature
    
    x - Position
    
    y - Position
    
    Returns:
    
    true if space can be seen
  - SetLocalVar
```
void SetLocalVar(Entity e,
                               String var,
                               String val)
```
    Set local variable
    
    Parameters:
    
    e - Entity such as Creature/Item/Map
    
    var - Variable name
    
    val - Variable value (string value only)
  - GetLocalVar
```
String GetLocalVar(Entity e,
                                           String var)
```
    Get local variable
    
    Parameters:
    
    e - Entity such as Creature/Item/Map
    
    var - Variable name
    
    Returns:
    
    Value (string) or nil
  - SetGlobalVar
```
void SetGlobalVar(String var,
                                String val)
```
  - GetGlobalVar
```
String GetGlobalVar(String var)
```
  - GetIID
```
String GetIID(Entity e)
```
    Get Instance ID of entity (unique id of entity)
    
    Parameters:
    
    e - Entity such as Creature/Item/Map
    
    Returns:
    
    IID string
  - AddSpell
```
void AddSpell(Creature pc,
                            String id)
```
    Add spell (learn it) to creature
    
    Parameters:
    
    pc - Creature to learn spell
    
    id - Spell resource ID
  - AddSkill
```
void AddSkill(Creature pc,
                            String id)
```
    Add skill (learn it) to creature
    
    Parameters:
    
    pc - Creature to learn skill
    
    id - Skill resource ID
  - HasRequirement
```
boolean HasRequirement(Creature pc,
                                     String id)
```
    Check if creature has requirements for Spell or Skill
    
    Parameters:
    
    pc - Creature to check
    
    id - Spell/Skill resource ID
    
    Returns:
  - GetGold
```
int GetGold(Creature pc)
```
    Get gold creature carries
    
    Parameters:
    
    pc - Creature
    
    Returns:
    
    Gold amount
  - SetGold
```
void SetGold(Creature pc,
                           int gold)
```
    Set new gold amount for creature
    
    Parameters:
    
    pc - Creature
    
    gold - New gold amount
  - OpenShop
```
void OpenShop(Creature shop)
```
    Opens shop ui
    
    Parameters:
    
    shop - Creature to shop with
  - SaveGame
```
void SaveGame(boolean partyOnly)
```
    Opens the saved game UI allowing user to save the game
    
    Parameters:
    
    partyOnly - true if only party should be saved, false if also module data saved
  - AutoSave
```
void AutoSave()
```
    Auto saves game on a auto save spot
  - ShowPopupText
```
void ShowPopupText(String text)
```
    Show popup text that disappears by itself
    
    Parameters:
    
    text - Text ot show
  - CreateContainer
```
Container CreateContainer()
```
    Create an empty container
    
    Returns:
    
    Container item
  - GetContainer
```
Container GetContainer(String iid)
```
    Get created container by its iid field
    
    Parameters:
    
    iid - Container id
    
    Returns:
    
    Container item (or null) if none found
  - GetItemsInContainer
```
LuaTable GetItemsInContainer(Container c)
```
    Get items in container
    
    Parameters:
    
    c - Container
    
    Returns:
    
    List of items
  - AddItemToContainer
```
void AddItemToContainer(Container c,
                                      Item item)
```
    Add item to container
    
    Parameters:
    
    c - Container
    
    item - Item to add
  - SetContainerOnClose
```
void SetContainerOnClose(Container c,
                                       String onClose)
```
  - OpenContainer
```
void OpenContainer(Container c)
```
    Open container screen
    
    Parameters:
    
    c - Container to show
  - AddTextLog
```
void AddTextLog(String line)
```
    Add line to text log shown to player
    
    Parameters:
    
    line - Line to show
  - GetName
```
String GetName(Entity e)
```
    Get name of creature/item
    
    Parameters:
    
    e - Entity to get name of
    
    Returns:
    
    Name of thing
  - GetEquipped
```
Item GetEquipped(Creature pc,
                               String slot)
```
    Get equipped item in slot
    
    Parameters:
    
    pc - Creature
    
    slot - SLOT_ constant
    
    Returns:
  - GetCooldown
```
int GetCooldown(Creature pc,
                              String id)
```
    Get skill cooldown
    
    Parameters:
    
    pc -
    
    id -
    
    Returns:
  - GetItemOwner
```
Entity GetItemOwner(Item i)
```
    Get item owner
    
    Parameters:
    
    i - Item
    
    Returns:
    
    Owner
  - GetItems
```
LuaTable GetItems(Creature pc)
```
    Get inventory of creature
    
    Parameters:
    
    pc - Creature
    
    Returns:
    
    List of items
  - SetTravelLocationVisible
```
void SetTravelLocationVisible(String mapId,
                                            String locId,
                                            boolean visible)
```
    Set location on travel map visible or hidden
    
    Parameters:
    
    mapId - Travel map id
    
    locId - Location id
    
    visible - true if visible
  - OpenTravelMap
```
void OpenTravelMap(String mapId,
                                 String locId)
```
    Open travel map screen on supplied map
    
    Parameters:
    
    mapId - Map id
    
    locId - Player location, leave "" if empty
  - PlaceTrap
```
Trap PlaceTrap(String id,
                             Map map,
                             int x,
                             int y)
```
    Place a newly created trap on the map
    
    Parameters:
    
    id - Blueprint id of trap
    
    map - Map
    
    x - Position
    
    y - Position
    
    Returns:
    
    New trap object, or nil on error
  - MoveTrap
```
void MoveTrap(Trap t,
                            Map map,
                            int x,
                            int y)
```
    Move trap to a new position
    
    Parameters:
    
    t - Trap object
    
    map - Map
    
    x - Position
    
    y - Position
  - GetTrap
```
Trap GetTrap(Map map,
                           int x,
                           int y)
```
    Get trap object from position
    
    Parameters:
    
    map - Map
    
    x - Position
    
    y - Position
    
    Returns:
    
    Trap object, or nil if not found
  - GetTrapPosition
```
PointF GetTrapPosition(Trap t)
```
    Get position of trap
    
    Parameters:
    
    t - Trap object
    
    Returns:
    
    Position
  - RemoveTrap
```
void RemoveTrap(Trap t)
```
    Remove trap from map
    
    Parameters:
    
    t - Trap object
  - GetDisarmRating
```
int GetDisarmRating(Trap t)
```
    Get disarm rating for trap
    
    Parameters:
    
    t - Trap
    
    Returns:
    
    Disarm rating
  - IsInCombat
```
boolean IsInCombat()
```
    Check if PCs are engaged in combat or not
    
    Returns:
    
    true if in combat
  - DiceRoll
```
int DiceRoll(String s)
```
    Roll dice from string, i.e. 2d6 + 2
    
    Parameters:
    
    s - Dice string
    
    Returns:
    
    Resulting number
  - StartEncounter
```
void StartEncounter(String id,
                                  Map map,
                                  int x,
                                  int y)
```
    Start encounter, spawning everything defined
    
    Parameters:
    
    id - Blueprint of encounter
    
    map - Map to place things in
    
    x - Center position of spawn
    
    y - Center position of spawn
  - CreateLoot
```
Container CreateLoot(Map map,
                                   int x,
                                   int y)
```
    Create loot container
    
    Parameters:
    
    map - Map to place loot on
    
    x - Position of loot
    
    y - Position of loot
    
    Returns:
  - RemoveLoot
```
void RemoveLoot(Map map,
                              int x,
                              int y)
```
    Remove loot container from map
    
    Parameters:
    
    map - Map to remove from
    
    x - Position of loot
    
    y - Position of loot
  - EndGame
```
void EndGame()
```
    End module

Scripting API for Black Skulls CRPG

Summary

Details

AddClass

AddSP

CreateEntity

DestroyEntity

GetBlueprintId

ActionMove

ActionTeleport

ActionForceMove

ActionAttack

ActionInteract

ActionUseSkillOn

ActionUseSkillAt

ActionCastSpellOn

ActionCastSpellAt

ActionUseItemOn

ActionUseItemAt

DoAction

GetParty

GetMap

GetMapFromCreature

IsOutdoor

GetTile

SetTile

GetHasVisited

EffectStrengthen

EffectWeaken

EffectBless

EffectCurse

EffectHaste

EffectSlow

EffectPoison

EffectCure

EffectDamage

EffectHeal

EffectShield

EffectPierce

EffectVisual

EffectBurn

EffectFreeze

EffectCustom

ApplyEffect

ApplyEffectAtPosition

GetEffectsAtPosition

RemoveTileEffect

GetItemType

GetItemDamage

SetItemDamage

GetItemArmor

SetItemArmor

GetItemArmorPenalty

SetItemArmorPenalty

GetItemUses

SetItemUses

GetItemGold

SetItemGold

SetItemIdentified

GetItemIdentified

GetEffects

RemoveEffect

GetEffectType

GetPosition

GetSpells

HasSpell

GetSpellCost

GetSpellTargetType

GetSkills

HasSkill

GetSTR

GetDEX

GetINT

GetHP

GetMaxHP

GetMP

SetMP

GetMaxMP

GetAP

GetATK