Fork me on GitHub

Available Packages:

Unit

function GetUnitGoldCost(int unitid) returns int

function GetUnitWoodCost(int unitid) returns int

function UnitAlive(unit id) returns boolean

function static unit.abortOrder() returns boolean

Cancels the current order

function static unit.addAbility(int abil) returns boolean

function static unit.addAbility(int abilId, int level)

function static unit.addAgi(int value)

function static unit.addAnimationProperties(string properties, boolean add)

function static unit.addAnimationProperties(string properties)

function static unit.addHP(real val)

function static unit.addInt(int value)

function static unit.addItemById(int itemId) returns item

function static unit.addItemHandle(item whichItem) returns boolean

function static unit.addItemToSlot(int id, int slot) returns boolean

function static unit.addItemToStock(int itmId, int currentStock, int stockMax)

function static unit.addLevels(int toAdd, boolean showEyeCandy)

function static unit.addMana(real val)

function static unit.addPermanentAbility(int abilId)

function static unit.addPermanentAbility(int abilId, int level)

function static unit.addSkillPoints(int value) returns boolean

function static unit.addState(unitstate state, real value)

function static unit.addStr(int value)

function static unit.addType(unittype utype) returns boolean

function static unit.addUnitToStock(int unitId, int currentStock, int stockMax)

function static unit.addXp(int toAdd, boolean showEyeCandy)

function static unit.cancelTimedLife()

function createUnit(int unitId) returns unit

function createUnit(player p, int unitId) returns unit

function createUnit(int unitId, vec2 pos) returns unit

function createUnit(player p, int unitId, vec2 pos) returns unit

function createUnit(player p, int unitId, vec2 pos, angle facing) returns unit

function createUnit(player p, int unitId, vec3 pos, angle facing) returns unit

function createUnitZ(player p, int unitId, vec3 pos, angle facing) returns unit

function static unit.decAbilityLevel(int abilityId)

function static unit.disableAbility(int abilId, boolean flag, boolean hideUI)

function static unit.disableAttack(boolean flag, boolean hideUI)

function static unit.disableWorkQueue(boolean flag, boolean hideUI)

function static unit.dropItemPoint(item itm, vec2 pos) returns boolean

function static unit.dropItemSlot(item itm, int slot) returns boolean

function static unit.endAbilityCooldown(int abilCode)

function static unit.explode()

Kills a unit by blowing it up

function static unit.getAbility(int abilId) returns ability

function static unit.getAbilityByIndex(int index) returns ability

function static unit.getAbilityCooldown(int abilId, int levelIndex) returns real

Level is indexed. Level 1 = 0, Level 2 = 1, e.t.c.

function static unit.getAbilityCooldownRemaining(int abilId) returns real

function static unit.getAbilityLevel(int id) returns int

function static unit.getAbilityManaCost(int abilId, int level) returns int

function static unit.getAgi(boolean includeBonuses) returns int

function static unit.getArmor() returns real

function static unit.getAttackCooldown(int weaponIndex) returns real

function static unit.getBaseDamage(int weaponIndex) returns int

function static unit.getCollisionSize() returns real

function static unit.getCurrentOrder() returns int

Returns the current order of the unit

function static unit.getDefaultAcquireRange() returns real

function static unit.getDefaultFlyHeight() returns real

function static unit.getDefaultMovespeed() returns real

function static unit.getDefaultPropWindow() returns angle

Returns the default prop window of the unit as angle.

function static unit.getDefaultTurnSpeed() returns real

function static unit.getDiceNumber(int weaponIndex) returns int

function static unit.getDiceSides(int weaponIndex) returns int

function static unit.getFacingAngle() returns angle

Returns the facing of the unit as an angle. Use this to avoid confusion between radians and degrees

function static unit.getField(unitbooleanfield field) returns boolean

function static unit.getField(unitintegerfield field) returns int

function static unit.getField(unitrealfield field) returns real

function static unit.getField(unitstringfield field) returns string

function static unit.getFieldWeapon(unitweaponbooleanfield field, int weaponIndex) returns boolean

function static unit.getFieldWeapon(unitweaponintegerfield field, int weaponIndex) returns int

function static unit.getFieldWeapon(unitweaponrealfield field, int weaponIndex) returns real

function static unit.getFieldWeapon(unitweaponstringfield field, int weaponIndex) returns string

function static unit.getFlyHeight() returns real

function static unit.getFoodUsed() returns int

function static unit.getGoldCost() returns int

function static unit.getHP() returns real

function static unit.getHPRatio() returns real

function handle.getHandleId() returns int

function static unit.getIcon() returns string

function static unit.getInt(boolean includeBonuses) returns int

function static unit.getIntMaxHP() returns int

function static unit.getIntMaxMana() returns int

function static unit.getItemById(int itemId) returns item

Returns the first item of the specific type from the unit's inventory, or null if none is present

function static unit.getItemSlot(item whichItem) returns int

Retrieves slot number for speficied item or -1 if not found.

function static unit.getLevel() returns int

function static unit.getLocalZ() returns real

function static unit.getMana() returns real

function static unit.getMaxHP() returns real

function static unit.getMaxMana() returns real

function static unit.getMissingHP() returns real

Get units current missing health.

function static unit.getMissingMana() returns real

Get units current missing mana.

function static unit.getMoveSpeed() returns real

function static unit.getName() returns string

function static unit.getOwner() returns player

function static unit.getPointValue() returns int

function static unit.getPos() returns vec2

function static unit.getPos3Fly() returns vec3

function static unit.getPos3Real() returns vec3

function static unit.getPos3Zero() returns vec3

function static unit.getPos3with(real z) returns vec3

function static unit.getPropWindow() returns angle

Returns the prop window of the unit as angle.

function static unit.getProperName() returns string

function static unit.getRallyDestructable() returns destructable

function static unit.getRallyPoint() returns vec2

function static unit.getRallyTarget() returns rallyResult

Returns the rally point of this unit as a rallyResult

function static unit.getRallyUnit() returns unit

function static unit.getSkillPoints() returns int

function static unit.getState(unitstate state) returns real

function static unit.getStr(boolean includeBonuses) returns int

function static unit.getTurnSpeed() returns real

function static unit.getTypeId() returns int

function static unit.getUnitAcquireRange() returns real

function getUnitIcon(int unitId) returns string

function static unit.getUserData() returns int

function static unit.getWoodCost() returns int

function static unit.getX() returns real

function static unit.getXp() returns int

function static unit.getY() returns real

function static unit.hasAbility(int id) returns boolean

function static unit.hasItem(item whichItem) returns boolean

function static unit.hasItemById(int itemId) returns boolean

function static unit.hide()

function static unit.hideAbility(int abilId, boolean flag)

function static unit.incAbilityLevel(int abilityId)

function static unit.interruptAttack()

function static unit.inventory() returns InventoryIterator

Creates an inventory iterator that allows you to access each existing item in the unit's inventory via for-loop. An example 'for i in u.inventory()'.

function static unit.inventorySize() returns int

function static unit.isAlive() returns boolean

Checks if the unit is alive using the UnitAlive native

function static unit.isAllyOf(player whichPlayer) returns boolean

Checks whether a unit is an ally of the given player

function static unit.isAllyOf(unit u) returns boolean

Checks whether two units are allies

function static unit.isBuildInProgress() returns boolean

function static unit.isEnemyOf(player whichPlayer) returns boolean

Checks whether a unit is an enemy of the given player

function static unit.isEnemyOf(unit u) returns boolean

Checks whether two units are enemies

function static unit.isHidden() returns boolean

function static unit.isIllusion() returns boolean

function static unit.isInRange(vec2 pos, real distance) returns boolean

Checks whether a unit is within range of a point. Takes into account the units collision size

function static unit.isInventoryFull() returns boolean

Checks if unit inventory is full.

function static unit.isInvulnerable() returns boolean

function static unit.isPaused() returns boolean

function static unit.isSelectable() returns boolean

function static unit.isSuspendedXp() returns boolean

function static unit.isType(unittype utype) returns boolean

function static unit.isUpgradeInProgress() returns boolean

function static unit.issueImmediateOrder(string order) returns boolean

function static unit.issueImmediateOrderById(int id) returns boolean

function static unit.issuePointOrder(string order, vec2 target) returns boolean

function static unit.issuePointOrderById(int id, vec2 target) returns boolean

function static unit.issueRallyPoint(vec2 pos)

function static unit.itemCount() returns int

Returns the number of items equipped.

function static unit.itemCount(int itemTypeId) returns int

Returns the number of slots containing the given item type

function static unit.itemInSlot(int inventoryIndex) returns item

function static unit.kill()

function static unit.lookAt(string bone, unit target, vec3 offset)

function static unit.lookAt(string bone, unit target)

function static unit.makeAbilityPermanent(int abil, boolean flag) returns boolean

function static unit.pause()

function static unit.pauseEx()

function static unit.queueAnimation(string animation)

function rallyResult(RallyType rtype, unit u, destructable d, vec2 pos) returns rallyResult

function static unit.recycleGuardPosition()

function static unit.remove()

function static unit.removeAbility(int abil) returns boolean

function static unit.removeAnimationProperties(string properties)

function static unit.removeGuardPosition()

function static unit.removeItem(item itm)

function static unit.removeItemById(int itemId) returns boolean

Removes the first item of type itemId carried by the unit returns true if an item was found and removed

function static unit.removeItemFromSlot(int slot) returns item

function static unit.removeItemFromStock(int itmId)

function static unit.removeLevels(int toRemove) returns boolean

function static unit.removeType(unittype utype) returns boolean

function static unit.removeUnitFromStock(int unitId)

function static unit.resetAbilityCooldown(int abilId)

function static unit.resetCooldown()

Reset all cooldowns of the unit

function static unit.resetLookAt()

function static unit.revive(vec2 pos, boolean doEyecandy)

function static unit.selectSkill(int abilcode)

function static unit.setAbilityCooldown(int abilId, int levelIndex, real cooldown)

Level is indexed. Level 1 = 0, Level 2 = 1, e.t.c.

function static unit.setAbilityLevel(int abilId, int lvl)

function static unit.setAbilityManaCost(int abilId, int level, int manaCost)

function static unit.setAgi(int value)

function static unit.setAnimation(string name)

function static unit.setAnimation(int index)

function static unit.setArmor(real armorAmount)

function static unit.setAttackCooldown(real cooldown, int weaponIndex)

function static unit.setAttackCooldownPercChange(real attackCooldownPercChange, int weaponIndex) returns real

Change unit attack cooldown by given percentage. Negative values are possible as well. Returns the new attack cooldown time of the unit.

function static unit.setBaseDamage(int baseDamage, int weaponIndex)

function static unit.setColor(playercolor c)

function static unit.setDiceNumber(int diceNumber, int weaponIndex)

function static unit.setDiceSides(int diceSides, int weaponIndex)

function static unit.setExploded(boolean exploded)

Sets whether a unit explodes on death

function static unit.setFacing(angle a)

function static unit.setField(unitbooleanfield field, boolean value) returns boolean

function static unit.setField(unitintegerfield field, int value) returns boolean

function static unit.setField(unitrealfield field, real value) returns boolean

function static unit.setField(unitstringfield field, string value) returns boolean

function static unit.setFieldWeapon(unitweaponbooleanfield field, int weaponIndex, boolean value) returns boolean

function static unit.setFieldWeapon(unitweaponintegerfield field, int weaponIndex, int value) returns boolean

function static unit.setFieldWeapon(unitweaponrealfield field, int weaponIndex, real value) returns boolean

function static unit.setFieldWeapon(unitweaponstringfield field, int weaponIndex, string value) returns boolean

function static unit.setFlyHeight(real height, real rate)

function static unit.setHP(real hp)

function static unit.setInt(int value)

function static unit.setInvulnerable(boolean flag)

function static unit.setLevel(int level, boolean showEyeCandy)

function static unit.setMana(real val)

function static unit.setMaxHP(int hp)

function static unit.setMaxHP(int hp, boolean keepRatio)

Changes a unit's maximum hp, adjusting the current hp to keep the same ratio.

function static unit.setMaxMana(int mana)

function static unit.setMaxMana(int mana, boolean keepRatio)

Changes a unit's maximum mana, adjusting the current mana to keep the same ratio. If the current unit's maximum mana is zero, the ratio will be considered zero.

function static unit.setMoveSpeed(real speed)

function static unit.setMoveSpeedPercChange(real movespeedPercChange) returns real

Change unit movement speed by given percentage. Negative values are possible as well. Returns the new speed of the unit. ex.: using 0.25 on unit with speed 400 will make the new speed 500.

function static unit.setName(string name)

function static unit.setOwner(player p, boolean changeColor)

function static unit.setPathing(boolean value)

function static unit.setPos(vec2 pos)

Sets the unit's position using the SetUnitPosition native. This native comes with some side effects like additional position verification and stopping the target unit.

function static unit.setPos(real x, real y)

function static unit.setPosFly(vec3 pos)

function static unit.setPosReal(vec3 pos)

function static unit.setPropWindow(angle value)

A prop window of 0 prevents the unit from moving, but it can still turn around.

function static unit.setProperName(string name)

function static unit.setScale(real scale)

function static unit.setSkillPoints(int value) returns boolean

function static unit.setState(unitstate state, real value)

function static unit.setStr(int value)

function static unit.setTimeScale(real scale)

function static unit.setTimedLife(real time)

function static unit.setTurnSpeed(real speed)

function static unit.setType(unittype utype, boolean flag) returns boolean

function static unit.setUseFood(boolean flag)

function static unit.setUserData(int data)

function static unit.setVertexColor(int r, int g, int b, int a)

function static unit.setX(real x)

function static unit.setXY(vec2 pos)

Sets the coordinmates of the unit to the given position. Uses the SetUnitX/Y natives

function static unit.setXY(vec3 pos)

Sets the coordinmates of the unit to the given position. Uses the SetUnitX/Y natives

function static unit.setXYZ(vec3 pos)

Sets the coordinmates of the unit to the given position. Z is being set as flyheight. Uses the SetUnitX/Y natives

function static unit.setXYZReal(vec3 pos)

function static unit.setXp(int newXpVal, boolean showEyeCandy)

function static unit.setY(real y)

function static unit.shareVision(player whichPlayer)

Share vision of that unit with a player

Set sharing of vision with a player

function static unit.show()

function static unit.showTeamGlow(boolean show)

function static unit.startAbilityCooldown(int abilCode)

function static unit.startAbilityCooldown(int abilCode, real cooldown)

function static unit.subHP(real val)

function static unit.subMana(real val)

function static unit.subState(unitstate state, real value)

function static unit.suspendXp(boolean suspend)

function static unit.toggleType(unittype utype) returns boolean

function static unit.unpause()

function static unit.unpauseEx()

function static unit.useItem(item itm) returns boolean

function static unit.useItemPoint(item itm, vec2 pos) returns boolean

function vec2.withRealZ(unit u) returns vec3