StendhalAPI: Difference between revisions

{{PublicMethod | useKarma | params=scale | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | useKarma | params=negLimit, posLimit[, granularity] | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | heal | params=[amount[, tell]] | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | addMana | params=mana, tell | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | damageDone | params=defender, attackingWeaponsValue, damageType | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | setAtk | params=atk | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getAtk | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getCappedAtk | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | setAtkXP | params=atk | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | addAtkXP | params=xp | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getAtkXP | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | incAtkXP | params=def | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | setDef | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getDef | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getCappedDef | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | setDefXP | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | addDefXP | params=xp | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getDefXP | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | incDefXP | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | setRatk | params=ratk | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getRatk | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getCappedRatk | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | setRatkXP | params=xp | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | addRatkXP | params=xp | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getRatkXP | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | incRatkXP | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | initHP | params=hp | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | setBaseHP | params=newhp | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getBaseHP | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | setHP | params=hp | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getHP | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getLVCap | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getMana | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getBaseMana | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | setMana | params=newMana | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | setBaseMana | params=newBaseMana | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | addBaseMana | params=newBaseMana | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | setLVCap | params=newLVCap | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | setXP | params=newxp | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | subXP | params=newxp | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | addXP | params=newxp | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getXP | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | isAttackable | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | setTarget | params=target | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | stopAttack | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getsFightXpFrom | params=enemy | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | stopAttacking | params=attacker | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | rememberAttacker | params=attacker | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | setBlood | params=name | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getBloodClass | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getDroppables | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | dropDroppableItem | params=droppable | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | maybeDropDroppables | params=attacker | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | onDamaged | params=attacker, damage | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | damage | params=amount, attacker | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | delayedDamage | params=amount, attackerName | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | onDead | params=killer[, remove] | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getCorpseName | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getHarmlessCorpseName | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getCorpseWidth | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getCorpseHeight | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | isInvisibleToCreatures | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | isAttacked | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getAttackSources | params= | desc=TODO | ret= | rettype=List<[[StendhalAPI#Entity|Entity]]> | paramlist=}}

{{PublicMethod | getAttackingRPEntities | params= | desc=TODO | ret= | rettype=List<[[StendhalAPI#RPEntity|RPEntity]]> | paramlist=}}

{{PublicMethod | isAttacking | params= | desc=TODO | ret= | rettype=boolean | paramlist=}}

{{PublicMethod | getAttackTarget | params= | desc=TODO | ret= | rettype=[[StendhalAPI#RPEntity|RPEntity]] | paramlist=}}

{{PublicMethod | equipToInventoryOnly | params=item | desc=TODO | ret= | rettype=boolean | paramlist=}}

{{PublicMethod | getSlotToEquip | params=item | desc=TODO | ret= | rettype=[[MarauroaAPI#RPSlot|RPSlot]] | paramlist=}}

{{PublicMethod | equipOrPutOnGround | params=item | desc=TODO | ret= | rettype=boolean | paramlist=}}

{{PublicMethod | equip | params=slotName, item | desc=TODO | ret= | rettype=boolean | paramlist=}}

{{PublicMethod | isEquipped | params=condition, amount | desc=TODO | ret= | rettype=boolean | paramlist=}}

{{PublicMethod | drop | params=<name> {{!|}} <item> | desc=TODO | ret= | rettype=boolean | paramlist=}}

{{PublicMethod | dropWithInfostring | params=name, infostring[, amount] | desc=TODO | ret= | rettype=boolean | paramlist=}}

{{PublicMethod | isEquipped | params=name[, amount] | desc=TODO | ret= | rettype=boolean | paramlist=}}

{{PublicMethod | isEquippedWithInfostring | params=name, infostring[, amount] | desc=TODO | ret= | rettype=boolean | paramlist=}}

{{PublicMethod | getNumberOfEquipped | params=name | desc=TODO | ret= | rettype=int | paramlist=}}

{{PublicMethod | getTotalNumberOf | params=name | desc=TODO | ret= | rettype=int | paramlist=}}

{{PublicMethod | getFirstEquipped | params=name | desc=TODO | ret= | rettype=[[StendhalAPI#Item|Item]] | paramlist=}}

{{PublicMethod | getAllEquipped | params=name | desc=TODO | ret= | rettype=List<[[StendhalAPI#Item|Item]]> | paramlist=}}

{{PublicMethod | getAllEquippedWithInfostring | params=name, infostring | desc=TODO | ret= | rettype=List<[[StendhalAPI#Item|Item]]> | paramlist=}}

{{PublicMethod | isEquippedItemClass | params=slot, clazz | desc=TODO | ret= | rettype=boolean | paramlist=}}

{{PublicMethod | isEquippedItemInSlot | params=slot, item | desc=TODO | ret= | rettype=boolean | paramlist=}}

{{PublicMethod | getEquippedItemClass | params=slot, clazz | desc=TODO | ret= | rettype=[[StendhalAPI#Item|Item]] | paramlist=}}

{{PublicMethod | getWeapon | params= | desc=TODO | ret= | rettype=[[StendhalAPI#Item|Item]] | paramlist=}}

{{PublicMethod | getWeapons | params= | desc=TODO | ret= | rettype=List<[[StendhalAPI#Item|Item]]> | paramlist=}}

{{PublicMethod | getRangeWeapon | params= | desc=TODO | ret= | rettype=[[StendhalAPI#Item|Item]] | paramlist=}}

{{PublicMethod | getAmmunition | params= | desc=TODO | ret= | rettype=[[StendhalAPI#StackableItem|StackableItem]] | paramlist=}}

{{PublicMethod | getMissileIfNotHoldingOtherWeapon | params= | desc=TODO | ret= | rettype=[[StendhalAPI#StackableItem|StackableItem]] | paramlist=}}

{{PublicMethod | hasShield | params= | desc=TODO | ret= | rettype=boolean | paramlist=}}

{{PublicMethod | getShield | params= | desc=TODO | ret= | rettype=[[StendhalAPI#Item|Item]] | paramlist=}}

{{PublicMethod | hasArmor | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getArmor | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | hasHelmet | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getHelmet | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | hasLegs | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getLegs | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | hasBoots | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getBoots | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | hasCloak | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getCloak | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | hasRing | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getRing | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | sendPrivateText | params=text | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | sendPrivateText | params=type, text | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getItemAtk | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getItemRatk | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getItemDef | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getDefenseItems | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | updateItemAtkDef | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | canDoRangeAttack | params=target, maxrange | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | hasLineOfSight | params=target | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getMaxRangeForArcher | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | setTitle | params=title | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | logic | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | canHit | params=defender | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getAtkRate | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | attack | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | handleLifesteal | params=attacker, attackerWeapons, damage | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getCorpseDeserver | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getLanguage | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | setDeathSound | params=sound | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getDeathSound | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | addStatusAttacker | params=statusAttacker | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getStatusList | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | hasStatus | params=statusType | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | setShadowStyle | params=st | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | applyDistanceAttackModifiers | params=damage, squareDistance, maxrange | desc=TODO | ret= | rettype= | paramlist=}}

'''Public Methods:'''

{{PublicMethod | DressedEntity | params= | desc=Default constructor. | ret=New instance. | rettype=[[StendhalAPI#DressedEntity|DressedEntity]] | paramlist=}}

{{PublicMethod | DressedEntity | params=object | desc=Copy constructor. | ret=New instance. | rettype=[[StendhalAPI#DressedEntity|DressedEntity]] | paramlist=

{{MethodParam | object | type=[[MarauroaAPI#RPObject|RPObject]] | desc=Object to be copied.}} }}

{{PublicMethod | getOutfit | params= | desc=TODO | ret= | rettype=[[StendhalAPI#Outfit|Outfit]] or null | paramlist=}}

{{PublicMethod | getOriginalOutfit | params= | desc=TODO | ret= | rettype=[[StendhalAPI#Outfit|Outfit]] or null | paramlist=}}

{{PublicMethod | getOutfitColors | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | setOutfit | params=outfit[, temporary] | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | setOutfit | params=layers | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | setOutfit | params=temporary, layers | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | setOutfit | params=strcode[, temporary] | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | setOutfitWithDetail | params=outfit, temporary | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | setOutfitColor | params=part, color | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | setOutfitColors | params=parts | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | isNaked | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | unsetOutfitColor | params=part | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | restoreOriginalOutfit | params= | desc=TODO | ret= | rettype= | paramlist=}}

'''Public Members:'''

{{PublicMember | pauseTurnsRemaining | desc=| type=int}}

'''Public Methods:'''

{{PublicMethod | NPC | params= | desc=Default constructor | ret=New instance. | rettype=[[StendhalAPI#NPC|NPC]] | paramlist=}}

{{PublicMethod | NPC | params=object | desc=Copy constructor. | ret=New instance. | rettype=[[StendhalAPI#NPC|NPC]] | paramlist=

{{MethodParam | object | type=[[MarauroaAPI#RPObject|RPObject]] | desc=Object to be copied.}} }}

{{PublicMethod | checkPause | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getIdea | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getMovementRange | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getPerceptionRange | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | getSounds | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | moveRandomly | params= | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | say | params=text | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | setIdea | params=idea | desc=Sets the NPC's idea/thought. | ret= | rettype= | paramlist=

{{MethodParam | idea | type=String | desc=The idea mnemonic, or <code>null</code>.}} }}

{{PublicMethod | setMovement | params=destEntity, min, max, maxPathRadius | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | setMovementRange | params=movementRange | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | setPathCompletedPause | params=pause[, dir] | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | setPerceptionRange | params=perceptionRange | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | setRandomPathFrom | params=x, y, distance | desc=TODO | ret= | rettype= | paramlist=}}

{{PublicMethod | setSounds | params=sounds | desc=TODO | ret= | rettype= | paramlist=}}

[[Category:Documentation]]

[[Category:API]]