Home Commands Examples Getting Started With Scripts Global Keywords
AllowMobDespawnEvent FinalizeMobSpawnEvent MobSpawnEvent
AnimalTameEvent BabyEntitySpawnEvent LivingAttackEvent LivingDamageEvent LivingDeathEvent LivingDestroyBlockEvent LivingDropsEvent LivingEquipmentChangeEvent LivingEvent LivingFallEvent LivingHealEvent LivingHurtEvent LivingJumpEvent LivingKnockBackEvent LivingUseTotemEvent LootingLevelEvent ShieldBlockEvent
EntityEvent EntityJoinLevelEvent EntityLeaveLevelEvent EntityMobGriefingEvent EntityMountEvent EntityStruckByLightningEvent EntityTravelToDimensionEvent ProjectileImpactEvent
DetonateExplosionEvent DifficultyChangeEvent Event EventResult ExplosionEvent FurnaceFuelBurnTimeEvent StartExplosionEvent
BracketHandlers ForgeBracketDumpers ForgeBracketValidators
Previous
MobEffectRemoveEvent FinalizeMobSpawnEvent
Next

AllowMobDespawnEvent

Importing the class

If you need to reference this type directly, like when casting an Array, or as a parameter, you will need to import it. Simply add the import at the top of the file.

script.zs
import crafttweaker.forge.api.event.entity.living.spawn.AllowMobDespawnEvent;

Extends

AllowMobDespawnEvent extends MobSpawnEvent.

Listening to the event

This event can be listened to like so:

script.zs
events.register<crafttweaker.forge.api.event.entity.living.spawn.AllowMobDespawnEvent>(event => {
    println("AllowMobDespawnEvent ran!");
});

Members

cancel
cancel()
Cancels the event. Same as setCanceled(true)
script.zs
// AllowDespawn.cancel();
event.cancel();
cancelable
Getter
script.zs
// AllowDespawn.cancelable as bool
event.cancelable

Return Type: bool

cancelable() as bool
script.zs
// AllowDespawn.cancelable() as bool;
event.cancelable();

Return Type: bool

canceled
Getter
script.zs
// AllowDespawn.canceled as bool
event.canceled

Return Type: bool

Setter
script.zs
// AllowDespawn.canceled = (cancel as bool);
event.canceled = myBool;

Parameters:

cancel Type: bool
canceled() as bool
script.zs
// AllowDespawn.canceled() as bool;
event.canceled();

Return Type: bool

canceled(cancel as bool)
script.zs
// AllowDespawn.canceled(cancel as bool);
event.canceled(myBool);

Parameters:

cancel Type: bool
entity
Getter
script.zs
// AllowDespawn.entity as Mob
event.entity

Return Type: Mob

Getter
script.zs
// AllowDespawn.entity as Entity
event.entity

Return Type: Entity

hasResult
Getter
script.zs
// AllowDespawn.hasResult as bool
event.hasResult

Return Type: bool

hasResult() as bool
script.zs
// AllowDespawn.hasResult() as bool;
event.hasResult();

Return Type: bool

level
Getter
script.zs
// AllowDespawn.level as ServerLevelAccessor
event.level

Return Type: ServerLevelAccessor

result
Getter
script.zs
// AllowDespawn.result as EventResult
event.result

Return Type: EventResult

Setter
script.zs
// AllowDespawn.result = (result as EventResult);
event.result = myResult;

Parameters:

result Type: EventResult
result() as Result
script.zs
// AllowDespawn.result() as EventResult;
event.result();

Return Type: EventResult

result(result as Result)
script.zs
// AllowDespawn.result(result as EventResult);
event.result(myResult);

Parameters:

result Type: EventResult
setAllow
setAllow()
sets the event's result to allow
script.zs
// AllowDespawn.setAllow();
event.setAllow();
setDefault
setDefault()
sets the event's result to default
script.zs
// AllowDespawn.setDefault();
event.setDefault();
setDeny
setDeny()
sets the event's result to deny
script.zs
// AllowDespawn.setDeny();
event.setDeny();
x
Getter
script.zs
// AllowDespawn.x as double
event.x

Return Type: double

y
Getter
script.zs
// AllowDespawn.y as double
event.y

Return Type: double

z
Getter
script.zs
// AllowDespawn.z as double
event.z

Return Type: double

Previous
MobEffectRemoveEvent FinalizeMobSpawnEvent
Next