CheckSpawnEvent

Fires before mob spawn events.

Result is significant: DEFAULT: use vanilla spawn rules ALLOW: allow the spawn DENY: deny the spawn

The event is not cancelable.

The event does not have a result.

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.

script.zs
import crafttweaker.api.event.entity.living.spawn.CheckSpawnEvent;

Extending LivingSpawnEvent

CheckSpawnEvent extends LivingSpawnEvent. That means all methods available in LivingSpawnEvent are also available in CheckSpawnEvent

Methods

Return Type: MobSpawnType

script.zs
// CheckSpawnEvent.getSpawnReason() as MobSpawnType
myCheckSpawnEvent.getSpawnReason();

Return Type: BaseSpawner?

script.zs
// CheckSpawnEvent.getSpawner() as BaseSpawner?
myCheckSpawnEvent.getSpawner();

Return Type: boolean

script.zs
// CheckSpawnEvent.isSpawner() as boolean
myCheckSpawnEvent.isSpawner();

Properties

NameTypeHas GetterHas Setter
Name
isSpawner
Type
boolean
Has Getter
true
Has Setter
false
Name
spawnReason
Type
MobSpawnType
Has Getter
true
Has Setter
false
Name
spawner
Type
BaseSpawner?
Has Getter
true
Has Setter
false