Hack/Mine Methods and Globals

From Hack/Mine Wiki
(Difference between revisions)
Jump to: navigation, search
(cdbgYV Thanks a lot for the blog post.Really looking forward to read more. Cool.)
(Undo revision 1796 by 37.233.27.142 (talk))
Line 3: Line 3:
 
1Ofo7C Really appreciate you sharing this blog.Really thank you!
 
1Ofo7C Really appreciate you sharing this blog.Really thank you!
  
−
cdbgYV Thanks a lot for the blog post.Really looking forward to read more. Cool.
+
==Available Methods==
 +
 
 +
===Area : Object===
 +
*getLocalMobs(Area area) : MobSpawnable[]
 +
*getName(Area area) : string
 +
*isPlural(Area area) : string
 +
 
 +
===Block : Object===
 +
*getAdjusted(Block block) : Block
 +
*getDistance(Block block, Block other) : double
 +
*getDistanceSquared(Block block, Block other) : int
 +
*getSideHit(Block block) : int
 +
*getX(Block block) : int
 +
*getY(Block block) : int
 +
*getZ(Block block) : int
 +
 
 +
===CharacterClass : Object===
 +
*getName(CharacterClass charClass) : string
 +
 
 +
===CharacterRace : Object===
 +
*getID(CharacterRace charRace) : int
 +
*getName(CharacterRace charRace) : string
 +
 
 +
===Creature : Living===
 +
*getTarget(Creature creature) : Entity
 +
*setTarget(Creature creature, Entity target) : bool
 +
 
 +
===Entity : Object===
 +
*IsTouchingFloorOrCeiling(Entity entity) : bool
 +
*addVelocity(Entity target, double dx, double dy, double dz) : void
 +
*createParticles(Entity entity, string particleID, int particleCount, double boundExpand, double magnitude) : void
 +
*getAllInAOE(Entity source, Entity[] unaffectedGroup, Entity[] listToBuild, double radius) : bool
 +
*getBlockID(Entity relativeTo, double verticalOffset) : int
 +
*getDistance(Entity entity, Block block) : double
 +
*getDistance(Entity entity, Entity other) : double
 +
*getDistanceSquared(Entity entity, Block block) : double
 +
*getDistanceSquared(Entity entity, Entity other) : double
 +
*getEyeY(Entity entity) : double
 +
*getFallDistance(Entity entity) : float
 +
*getFirstBlockUnderneath(Entity toTest, int maximumTestDepth) : Block
 +
*getHeight(Entity entity) : float
 +
*getNearestEntity(Entity source, double distance) : Entity
 +
*getPitch(Entity entity) : float
 +
*getPrevX(Entity entity) : double
 +
*getPrevY(Entity entity) : double
 +
*getPrevZ(Entity entity) : double
 +
*getVelX(Entity entity) : double
 +
*getVelY(Entity entity) : double
 +
*getVelZ(Entity entity) : double
 +
*getWidth(Entity entity) : float
 +
*getWorld(Entity entity) : World
 +
*getX(Entity entity) : double
 +
*getY(Entity entity) : double
 +
*getYaw(Entity entity) : float
 +
*getZ(Entity entity) : double
 +
*isColliding(Entity toCheck, float expandX, float expandY) : bool
 +
*isGrounded(Entity entity) : bool
 +
*isInWater(Entity entity) : bool
 +
*isTouchingWall(Entity entity) : bool
 +
*moveForward(Entity target, bool addToCurrentMotion, float velForward, float velUpward) : void
 +
*playSound(Entity source, string sound, float volume, float pitchLevel, float pitchVariance) : void
 +
*push(Entity pusher, Entity[] pushees, bool addToCurrentMotion, double baseForce, double forcePerDistance, double baseUpwardForce, double upwardForcePerDistance) : void
 +
*reorient(Entity reorientee, bool isGaussian, float yawRangeInDegrees, float pitchRangeInDegrees, void $ () funcPointer) : Object
 +
*rotate(Entity rotatee, float rotationInDegrees) : void
 +
*rotatePitch(Entity rotatee, float rotationInDegrees) : void
 +
*setBlockID(Entity relativeTo, double verticalOffset, int blockID) : bool
 +
*setDead(Entity entity) : void
 +
*setFallDistance(Entity entity, float fallDistance) : void
 +
*setPitch(Entity rotatee, float pitch) : void
 +
*setPosition(Entity entity, double x, double y, double z) : void
 +
*setVelocity(Entity target, double dx, double dy, double dz) : void
 +
*setYaw(Entity rotatee, float yaw) : void
 +
*shootEntitizedEffect(Entity creator, double distanceOut, double velocity, void $ (EntityEffect) funcPointer) : EntityEffect
 +
 
 +
===EntityBlock : Entity===
 +
*getBlockID(EntityBlock entityBlock) : int
 +
*getMetadata(EntityBlock entityBlock) : int
 +
 
 +
===EntityEffect : Entity===
 +
<None>
 +
 
 +
===Living : Entity===
 +
*applyAttrModEffect(Living affected, int attr, int amount, string flags, int ticksToLast) : bool
 +
*applyAttrMultEffect(Living affected, int attr, float amount, string flags, int ticksToLast) : bool
 +
*applyEffect(Living affected, string flags, bool $ (Living) onUpdate) : bool
 +
*applyTimedEffect(Living affected, int ticksToLast, string flags, bool $ (Living, int) onUpdate) : bool
 +
*attack(Living attacker, Entity indirectSource, Entity[] targets, int addedDamage, float meleeMultiplier, float magicMultiplier) : bool
 +
*attack(Living attacker, Entity indirectSource, Entity[] targets, int rawPhysicalDamage, float[] rawMagicDamage) : bool
 +
*canSee(Living source, Entity target) : bool
 +
*emitProjectile(Living emitter, Living owner, Projectile projectile, int damage, float[] magicDamage) : void
 +
*expendMana(Living living, float mana) : bool
 +
*expendMana(Living living, int mana) : bool
 +
*getDex(Living living) : int
 +
*getFrt(Living living) : int
 +
*getHealth(Living living) : int
 +
*getItl(Living living) : int
 +
*getLivingTypeID(Living living) : string
 +
*getLvl(Living living) : int
 +
*getMana(Living living) : int
 +
*getMaxHealth(Living living) : int
 +
*getMaxMana(Living living) : int
 +
*getNumberOfEffects(Living living, string flag) : int
 +
*getStr(Living living) : int
 +
*getWis(Living living) : int
 +
*isClimbing(Living living) : bool
 +
*setHealth(Living living, int health) : void
 +
*setMana(Living living, int mana) : void
 +
*shootArrow(Living shooter, bool expendArrow, void $ (Entity, Block) onImpact) : bool
 +
*shootProjectile(Living shooter, Projectile projectile, int damage, float[] magicDamage) : void
 +
 
 +
===MagicDamageType : Object===
 +
*makeDamage(MagicDamageType magicDamageType, float damage) : float[]
 +
 
 +
===MobSpawnable : Object===
 +
*getName(MobSpawnable mobType) : string
 +
*getNamePlural(MobSpawnable mobType) : string
 +
 
 +
===Object===
 +
<None>
 +
 
 +
===Player : Living===
 +
*addCurrency(Player player, int amount) : bool
 +
*addEnchantingPoints(Player player, int pointsToAdd) : void
 +
*addExperience(Player player, int pointsToAdd) : void
 +
*applyItemUseEffect(Player affected, float ticksToLast, bool shouldAnimate, int[] requiredItem, void $ (Player) onUpdate, void $ (Player) onFinish) : bool
 +
*finishItemUse(Player player) : bool
 +
*getCharacterClass(Player player) : CharacterClass
 +
*getCharacterRace(Player player) : CharacterRace
 +
*getCurrency(Player player) : int
 +
*getEnchantingLevels(Player player) : int
 +
*getExperience(Player player) : int
 +
*getName(Player player) : string
 +
*removeCurrency(Player player, int amount) : bool
 +
*removeEnchantingLevels(Player player) : void
 +
*removeExperience(Player player, int pointsToRemove) : void
 +
*requireItem(Player player, int itemID, int amountToExpend) : bool
 +
*teleportToDimension(Player player, int dimension) : void
 +
*tell(Player player, string message) : void
 +
 
 +
===Projectile : Object===
 +
<None>
 +
 
 +
===Server : Object===
 +
*getPlayer(Server server, string username) : Player
 +
*getPlayers(Server server) : Player[]
 +
*getProperty(Server server, string property, string defaultValue) : string
 +
*getWorld(Server server, int dimension) : World
 +
*getWorlds(Server server) : World[]
 +
*handleCommand(Server server, string command) : void
 +
*log(Server server, string message) : void
 +
*setProperty(Server server, string property, string value) : string
 +
 
 +
===SpellInstance : Object===
 +
*delayedCast(SpellInstance spellInstance, Entity caster) : bool
 +
 
 +
===Villager : Living===
 +
*getFirstName(Villager villager) : string
 +
*getLastName(Villager villager) : string
 +
 
 +
===World : Object===
 +
*createEntitizedEffect(World world, double x, double y, double z, void $ (EntityEffect) funcPointer) : EntityEffect
 +
*createExplosion(World world, Entity source, double x, double y, double z, float size) : void
 +
*createLightning(World world, double x, double y, double z, bool $ (Entity, Entity) action) : Entity
 +
*createPrimedTNT(World world, double x, double y, double z, int ticksTilBoom) : Entity
 +
*drawLine(World world, Block blockA, Block blockB, int blockID, int metadata) : void
 +
*drawLine(World world, int x0, int y0, int z0, int x1, int y1, int z1, int blockID, int metadata) : void
 +
*getAllInAOE(World world, double x, double y, double z, Entity[] unaffectedGroup, Entity[] listToBuild, double radius) : bool
 +
*getAllInBox(World world, double x0, double y0, double z0, double x1, double y1, double z1, Entity[] unaffectedGroup, Entity[] listToBuild) : bool
 +
*getBlockID(World world, int x, int y, int z) : int
 +
*getDimension(World world) : int
 +
*getEntities(World world) : Entity[]
 +
*getEntity(World world, int id) : Entity
 +
*isRemote(World world) : bool
 +
*onBlockPlaced(World world, int x, int y, int z, int facing, Living placer) : void
 +
*physicizeBlocks(World world, Block[] blocks, EntityBlock[] groupToAddTo) : bool
 +
*playSound(World world, double x, double y, double z, string sound, float volume, float pitchLevel, float pitchVariance) : void
 +
*randomDouble(World world) : double
 +
*randomFloat(World world) : float
 +
*randomGaussian(World world) : double
 +
*randomInt(World world) : int
 +
*setBlockID(World world, Block block, int blockID) : void
 +
*setBlockID(World world, int x, int y, int z, int blockID) : void
 +
*setBlockIDWithoutNotify(World world, int x, int y, int z, int blockID) : void
 +
*setBlockIDs(World world, Block[] blocks, int blockID) : void
 +
*spawnLiving(World world, string entityTypeID, double x, double y, double z) : Entity
 +
*spawnParticle(World world, string particleName, double x, double y, double z, double velX, double velY, double velZ) : void
 +
*ubersmite(World world, Player target) : void
 +
 
 +
===bool===
 +
<None>
 +
 
 +
===double===
 +
<None>
 +
 
 +
===float===
 +
<None>
 +
 
 +
===int===
 +
<None>
 +
 
 +
===list===
 +
*append(Object[] list, Object toAppend) : void
 +
*isEmpty(Object[] list) : bool
 +
 
 +
===string===
 +
*endsWith(string str, string suffix) : bool
 +
*length(string str) : int
 +
*startsWith(string str, string prefix) : bool
 +
*substr(string str, int beginIndex) : string
 +
*substr(string str, int beginIndex, int endIndex) : string
 +
*toLowerCase(string str) : string
 +
*toUpperCase(string str) : string
 +
*trim(string str) : string
 +
 
 +
===GLOBALS===
 +
*Block(int x, int y, int z) : Block
 +
*abs(double a) : double
 +
*abs(float a) : float
 +
*abs(int a) : int
 +
*cos(float angle) : float
 +
*cosDegrees(float angle) : float
 +
*getBlockID(string name) : int
 +
*getBlockName(int blockID) : string
 +
*max(double a, double b) : double
 +
*max(float a, float b) : float
 +
*max(int a, int b) : int
 +
*min(double a, double b) : double
 +
*min(float a, float b) : float
 +
*min(int a, int b) : int
 +
*randrange(double min, double max) : double
 +
*randrange(float min, float max) : float
 +
*randrange(int min, int max) : int
 +
*sin(float angle) : float
 +
*sinDegrees(float angle) : float

Revision as of 22:21, 28 July 2014

The following is a list of all global variables and methods available in Spellscript as Hack/Mine v0.6.4.2. Enjoy!

1Ofo7C Really appreciate you sharing this blog.Really thank you!

Contents

Available Methods

Area : Object

  • getLocalMobs(Area area) : MobSpawnable[]
  • getName(Area area) : string
  • isPlural(Area area) : string

Block : Object

  • getAdjusted(Block block) : Block
  • getDistance(Block block, Block other) : double
  • getDistanceSquared(Block block, Block other) : int
  • getSideHit(Block block) : int
  • getX(Block block) : int
  • getY(Block block) : int
  • getZ(Block block) : int

CharacterClass : Object

  • getName(CharacterClass charClass) : string

CharacterRace : Object

  • getID(CharacterRace charRace) : int
  • getName(CharacterRace charRace) : string

Creature : Living

  • getTarget(Creature creature) : Entity
  • setTarget(Creature creature, Entity target) : bool

Entity : Object

  • IsTouchingFloorOrCeiling(Entity entity) : bool
  • addVelocity(Entity target, double dx, double dy, double dz) : void
  • createParticles(Entity entity, string particleID, int particleCount, double boundExpand, double magnitude) : void
  • getAllInAOE(Entity source, Entity[] unaffectedGroup, Entity[] listToBuild, double radius) : bool
  • getBlockID(Entity relativeTo, double verticalOffset) : int
  • getDistance(Entity entity, Block block) : double
  • getDistance(Entity entity, Entity other) : double
  • getDistanceSquared(Entity entity, Block block) : double
  • getDistanceSquared(Entity entity, Entity other) : double
  • getEyeY(Entity entity) : double
  • getFallDistance(Entity entity) : float
  • getFirstBlockUnderneath(Entity toTest, int maximumTestDepth) : Block
  • getHeight(Entity entity) : float
  • getNearestEntity(Entity source, double distance) : Entity
  • getPitch(Entity entity) : float
  • getPrevX(Entity entity) : double
  • getPrevY(Entity entity) : double
  • getPrevZ(Entity entity) : double
  • getVelX(Entity entity) : double
  • getVelY(Entity entity) : double
  • getVelZ(Entity entity) : double
  • getWidth(Entity entity) : float
  • getWorld(Entity entity) : World
  • getX(Entity entity) : double
  • getY(Entity entity) : double
  • getYaw(Entity entity) : float
  • getZ(Entity entity) : double
  • isColliding(Entity toCheck, float expandX, float expandY) : bool
  • isGrounded(Entity entity) : bool
  • isInWater(Entity entity) : bool
  • isTouchingWall(Entity entity) : bool
  • moveForward(Entity target, bool addToCurrentMotion, float velForward, float velUpward) : void
  • playSound(Entity source, string sound, float volume, float pitchLevel, float pitchVariance) : void
  • push(Entity pusher, Entity[] pushees, bool addToCurrentMotion, double baseForce, double forcePerDistance, double baseUpwardForce, double upwardForcePerDistance) : void
  • reorient(Entity reorientee, bool isGaussian, float yawRangeInDegrees, float pitchRangeInDegrees, void $ () funcPointer) : Object
  • rotate(Entity rotatee, float rotationInDegrees) : void
  • rotatePitch(Entity rotatee, float rotationInDegrees) : void
  • setBlockID(Entity relativeTo, double verticalOffset, int blockID) : bool
  • setDead(Entity entity) : void
  • setFallDistance(Entity entity, float fallDistance) : void
  • setPitch(Entity rotatee, float pitch) : void
  • setPosition(Entity entity, double x, double y, double z) : void
  • setVelocity(Entity target, double dx, double dy, double dz) : void
  • setYaw(Entity rotatee, float yaw) : void
  • shootEntitizedEffect(Entity creator, double distanceOut, double velocity, void $ (EntityEffect) funcPointer) : EntityEffect

EntityBlock : Entity

  • getBlockID(EntityBlock entityBlock) : int
  • getMetadata(EntityBlock entityBlock) : int

EntityEffect : Entity

<None>

Living : Entity

  • applyAttrModEffect(Living affected, int attr, int amount, string flags, int ticksToLast) : bool
  • applyAttrMultEffect(Living affected, int attr, float amount, string flags, int ticksToLast) : bool
  • applyEffect(Living affected, string flags, bool $ (Living) onUpdate) : bool
  • applyTimedEffect(Living affected, int ticksToLast, string flags, bool $ (Living, int) onUpdate) : bool
  • attack(Living attacker, Entity indirectSource, Entity[] targets, int addedDamage, float meleeMultiplier, float magicMultiplier) : bool
  • attack(Living attacker, Entity indirectSource, Entity[] targets, int rawPhysicalDamage, float[] rawMagicDamage) : bool
  • canSee(Living source, Entity target) : bool
  • emitProjectile(Living emitter, Living owner, Projectile projectile, int damage, float[] magicDamage) : void
  • expendMana(Living living, float mana) : bool
  • expendMana(Living living, int mana) : bool
  • getDex(Living living) : int
  • getFrt(Living living) : int
  • getHealth(Living living) : int
  • getItl(Living living) : int
  • getLivingTypeID(Living living) : string
  • getLvl(Living living) : int
  • getMana(Living living) : int
  • getMaxHealth(Living living) : int
  • getMaxMana(Living living) : int
  • getNumberOfEffects(Living living, string flag) : int
  • getStr(Living living) : int
  • getWis(Living living) : int
  • isClimbing(Living living) : bool
  • setHealth(Living living, int health) : void
  • setMana(Living living, int mana) : void
  • shootArrow(Living shooter, bool expendArrow, void $ (Entity, Block) onImpact) : bool
  • shootProjectile(Living shooter, Projectile projectile, int damage, float[] magicDamage) : void

MagicDamageType : Object

  • makeDamage(MagicDamageType magicDamageType, float damage) : float[]

MobSpawnable : Object

  • getName(MobSpawnable mobType) : string
  • getNamePlural(MobSpawnable mobType) : string

Object

<None>

Player : Living

  • addCurrency(Player player, int amount) : bool
  • addEnchantingPoints(Player player, int pointsToAdd) : void
  • addExperience(Player player, int pointsToAdd) : void
  • applyItemUseEffect(Player affected, float ticksToLast, bool shouldAnimate, int[] requiredItem, void $ (Player) onUpdate, void $ (Player) onFinish) : bool
  • finishItemUse(Player player) : bool
  • getCharacterClass(Player player) : CharacterClass
  • getCharacterRace(Player player) : CharacterRace
  • getCurrency(Player player) : int
  • getEnchantingLevels(Player player) : int
  • getExperience(Player player) : int
  • getName(Player player) : string
  • removeCurrency(Player player, int amount) : bool
  • removeEnchantingLevels(Player player) : void
  • removeExperience(Player player, int pointsToRemove) : void
  • requireItem(Player player, int itemID, int amountToExpend) : bool
  • teleportToDimension(Player player, int dimension) : void
  • tell(Player player, string message) : void

Projectile : Object

<None>

Server : Object

  • getPlayer(Server server, string username) : Player
  • getPlayers(Server server) : Player[]
  • getProperty(Server server, string property, string defaultValue) : string
  • getWorld(Server server, int dimension) : World
  • getWorlds(Server server) : World[]
  • handleCommand(Server server, string command) : void
  • log(Server server, string message) : void
  • setProperty(Server server, string property, string value) : string

SpellInstance : Object

  • delayedCast(SpellInstance spellInstance, Entity caster) : bool

Villager : Living

  • getFirstName(Villager villager) : string
  • getLastName(Villager villager) : string

World : Object

  • createEntitizedEffect(World world, double x, double y, double z, void $ (EntityEffect) funcPointer) : EntityEffect
  • createExplosion(World world, Entity source, double x, double y, double z, float size) : void
  • createLightning(World world, double x, double y, double z, bool $ (Entity, Entity) action) : Entity
  • createPrimedTNT(World world, double x, double y, double z, int ticksTilBoom) : Entity
  • drawLine(World world, Block blockA, Block blockB, int blockID, int metadata) : void
  • drawLine(World world, int x0, int y0, int z0, int x1, int y1, int z1, int blockID, int metadata) : void
  • getAllInAOE(World world, double x, double y, double z, Entity[] unaffectedGroup, Entity[] listToBuild, double radius) : bool
  • getAllInBox(World world, double x0, double y0, double z0, double x1, double y1, double z1, Entity[] unaffectedGroup, Entity[] listToBuild) : bool
  • getBlockID(World world, int x, int y, int z) : int
  • getDimension(World world) : int
  • getEntities(World world) : Entity[]
  • getEntity(World world, int id) : Entity
  • isRemote(World world) : bool
  • onBlockPlaced(World world, int x, int y, int z, int facing, Living placer) : void
  • physicizeBlocks(World world, Block[] blocks, EntityBlock[] groupToAddTo) : bool
  • playSound(World world, double x, double y, double z, string sound, float volume, float pitchLevel, float pitchVariance) : void
  • randomDouble(World world) : double
  • randomFloat(World world) : float
  • randomGaussian(World world) : double
  • randomInt(World world) : int
  • setBlockID(World world, Block block, int blockID) : void
  • setBlockID(World world, int x, int y, int z, int blockID) : void
  • setBlockIDWithoutNotify(World world, int x, int y, int z, int blockID) : void
  • setBlockIDs(World world, Block[] blocks, int blockID) : void
  • spawnLiving(World world, string entityTypeID, double x, double y, double z) : Entity
  • spawnParticle(World world, string particleName, double x, double y, double z, double velX, double velY, double velZ) : void
  • ubersmite(World world, Player target) : void

bool

<None>

double

<None>

float

<None>

int

<None>

list

  • append(Object[] list, Object toAppend) : void
  • isEmpty(Object[] list) : bool

string

  • endsWith(string str, string suffix) : bool
  • length(string str) : int
  • startsWith(string str, string prefix) : bool
  • substr(string str, int beginIndex) : string
  • substr(string str, int beginIndex, int endIndex) : string
  • toLowerCase(string str) : string
  • toUpperCase(string str) : string
  • trim(string str) : string

GLOBALS

  • Block(int x, int y, int z) : Block
  • abs(double a) : double
  • abs(float a) : float
  • abs(int a) : int
  • cos(float angle) : float
  • cosDegrees(float angle) : float
  • getBlockID(string name) : int
  • getBlockName(int blockID) : string
  • max(double a, double b) : double
  • max(float a, float b) : float
  • max(int a, int b) : int
  • min(double a, double b) : double
  • min(float a, float b) : float
  • min(int a, int b) : int
  • randrange(double min, double max) : double
  • randrange(float min, float max) : float
  • randrange(int min, int max) : int
  • sin(float angle) : float
  • sinDegrees(float angle) : float
Retrieved from "http://www.hackslashmine.net/hsmwiki/index.php?title=Hack/Mine_Methods_and_Globals&oldid=1954"
Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox