Mob - CraftTweaker Documentation

Version:

Language:

Home Commands Examples Getting Started With Scripts Global Keywords 1.21 Migration Guide

Importing the class

It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file.

ZenScript
 Copy
import crafttweaker.api.entity.type.misc.Mob;

Extending LivingEntity

Mob extends LivingEntity. That means all methods available in LivingEntity are also available in Mob

Implemented Interfaces

Mob implements the following interfaces. That means all methods defined in these interfaces are also available in Mob

Targeting

Methods

ate

Name: ate

ZenScript
 Copy
// Mob.ate()

myMob.ate();

canBeLeashed

Name: canBeLeashed

Return Type: boolean

ZenScript
 Copy
// Mob.canBeLeashed() as boolean

myMob.canBeLeashed();

canFireProjectileWeapon

Name: canFireProjectileWeapon

Return Type: boolean

ZenScript
 Copy
Mob.canFireProjectileWeapon(weapon as ProjectileWeaponItem) as boolean

Parameter	Type
Parameter weapon	Type ProjectileWeaponItem

canHoldItem

Name: canHoldItem

Return Type: boolean

ZenScript
 Copy
Mob.canHoldItem(stack as ItemStack) as boolean

Parameter	Type
Parameter stack	Type ItemStack

canReplaceEqualItem

Name: canReplaceEqualItem

Return Type: boolean

ZenScript
 Copy
Mob.canReplaceEqualItem(toReplace as ItemStack, with as ItemStack) as boolean

Parameter	Type
Parameter toReplace	Type ItemStack
Parameter with	Type ItemStack

checkSpawnObstruction

Name: checkSpawnObstruction

Return Type: boolean

ZenScript
 Copy
Mob.checkSpawnObstruction(level as LevelReader) as boolean

Parameter	Type
Parameter level	Type LevelReader

checkSpawnRules

Name: checkSpawnRules

Return Type: boolean

ZenScript
 Copy
Mob.checkSpawnRules(level as LevelAccessor, spawnType as MobSpawnType) as boolean

Parameter	Type
Parameter level	Type LevelAccessor
Parameter spawnType	Type MobSpawnType

clearRestriction

Name: clearRestriction

ZenScript
 Copy
// Mob.clearRestriction()

myMob.clearRestriction();

dropLeash

Name: dropLeash

ZenScript
 Copy
Mob.dropLeash(broadcastPacket as boolean, dropLeash as boolean)

Parameter	Type
Parameter broadcastPacket	Type boolean
Parameter dropLeash	Type boolean

equipItemIfPossible

Name: equipItemIfPossible

Return Type: ItemStack

ZenScript
 Copy
Mob.equipItemIfPossible(stack as ItemStack) as ItemStack

Parameter	Type
Parameter stack	Type ItemStack

isMaxGroupSizeReached

Name: isMaxGroupSizeReached

Return Type: boolean

ZenScript
 Copy
Mob.isMaxGroupSizeReached(size as int) as boolean

Parameter	Type
Parameter size	Type int

isWithinMeleeAttackRange

Name: isWithinMeleeAttackRange

Return Type: boolean

ZenScript
 Copy
Mob.isWithinMeleeAttackRange(entity as LivingEntity) as boolean

Parameter	Type
Parameter entity	Type LivingEntity

isWithinRestriction

Name: isWithinRestriction

Return Type: boolean

ZenScript
 Copy
Mob.isWithinRestriction(position as BlockPos) as boolean

Parameter	Type
Parameter position	Type BlockPos

lookAt

Name: lookAt

ZenScript
 Copy
Mob.lookAt(entity as Entity, maxXRotIncrease as float, maxYRotIncrease as float)

Parameter	Type
Parameter entity	Type Entity
Parameter maxXRotIncrease	Type float
Parameter maxYRotIncrease	Type float

playAmbientSound

Name: playAmbientSound

ZenScript
 Copy
// Mob.playAmbientSound()

myMob.playAmbientSound();

restrictTo

Name: restrictTo

ZenScript
 Copy
Mob.restrictTo(restrictCenter as BlockPos, restrictRadius as int)

Parameter	Type
Parameter restrictCenter	Type BlockPos
Parameter restrictRadius	Type int

setDropChance

Name: setDropChance

ZenScript
 Copy
Mob.setDropChance(slot as EquipmentSlot, chance as float)

Parameter	Type
Parameter slot	Type EquipmentSlot
Parameter chance	Type float

setGuaranteedDrop

Name: setGuaranteedDrop

ZenScript
 Copy
Mob.setGuaranteedDrop(slot as EquipmentSlot)

Parameter	Type
Parameter slot	Type EquipmentSlot

setLeashedTo

Name: setLeashedTo

ZenScript
 Copy
Mob.setLeashedTo(leashHolder as Entity, broadcastPacket as boolean)

Parameter	Type
Parameter leashHolder	Type Entity
Parameter broadcastPacket	Type boolean

setPersistenceRequired

Name: setPersistenceRequired

ZenScript
 Copy
// Mob.setPersistenceRequired()

myMob.setPersistenceRequired();

wantsToPickUp

Name: wantsToPickUp

Return Type: boolean

ZenScript
 Copy
Mob.wantsToPickUp(stack as ItemStack) as boolean

Parameter	Type
Parameter stack	Type ItemStack

Properties

Name	Type	Has Getter	Has Setter
Name aggressive	Type Mob	Has Getter true	Has Setter true
Name ambientSoundInterval	Type int	Has Getter true	Has Setter false
Name baby	Type Mob	Has Getter false	Has Setter true
Name canPickUpLoot	Type boolean	Has Getter true	Has Setter true
Name getRestrictCenter	Type BlockPos	Has Getter true	Has Setter false
Name getRestrictRadius	Type float	Has Getter true	Has Setter false
Name hasRestriction	Type boolean	Has Getter true	Has Setter false
Name isPersistenceRequired	Type boolean	Has Getter true	Has Setter false
Name isWithinRestriction	Type boolean	Has Getter true	Has Setter false
Name leashed	Type boolean	Has Getter true	Has Setter false
Name leftHanded	Type Mob	Has Getter true	Has Setter true
Name maxHeadRotSpeed	Type int	Has Getter true	Has Setter false
Name maxHeadXRot	Type int	Has Getter true	Has Setter false
Name maxHeadYRot	Type int	Has Getter true	Has Setter false
Name maxSpawnClusterSize	Type int	Has Getter true	Has Setter false
Name noAi	Type Mob	Has Getter true	Has Setter true
Name target	Type Mob	Has Getter false	Has Setter true