Home Commands Examples Getting Started With Scripts Global Keywords 1.21 Migration Guide
AgeableMob ExperienceOrb FallingBlockEntity LightningBolt Mob PathfinderMob
Entity EntityAccess EntityDimensions EntityIngredient EntityType HumanoidArm INameTagFunction LivingEntity MobCategory MobSpawnType NameTagResult RemovalReason Shearable Targeting
BracketDumpers BracketHandlers BracketValidators ResourceLocationBracketHandler
Previous
FallingBlockEntity Mob
Next

LightningBolt

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.api.entity.type.misc.LightningBolt;

Extends

LightningBolt extends Entity.

Implements

LightningBolt implements the following interfaces:

Nameable,EntityAccess,CommandSource,IAttachmentHolder

Undocumented Interfaces

SyncedDataHolder,ScoreHolder,IEntityExtension,INBTSerializable<CompoundTag>

Members

acceptsFailure
Getter
Checks if the commands from this source should return failure messages
script.zs
// LightningBolt.acceptsFailure as bool
myLightningBolt.acceptsFailure

Return Type: bool

acceptsFailure() as bool
Checks if the commands from this source should return failure messages

Returns: True if the commands from this source should return failure messages, false otherwise.

script.zs
// LightningBolt.acceptsFailure() as bool;
myLightningBolt.acceptsFailure();

Return Type: bool

acceptsSuccess
Getter
Checks if the commands from this source should return successful messages
script.zs
// LightningBolt.acceptsSuccess as bool
myLightningBolt.acceptsSuccess

Return Type: bool

acceptsSuccess() as bool
Checks if the commands from this source should return successful messages

Returns: True if the commands from this source should return successful messages, false otherwise.

script.zs
// LightningBolt.acceptsSuccess() as bool;
myLightningBolt.acceptsSuccess();

Return Type: bool

addTag
addTag(tagName as string) as bool
Adds a tag to the entity, returning false if the entity has over 1024

Returns: true if the tag was added.

script.zs
// LightningBolt.addTag(tagName as string) as bool;
myLightningBolt.addTag(myString);

Parameters:

tagName Type: string - The name of the tag to add.

Return Type: bool

airSupply
Getter
Gets the current air supply of the entity.
script.zs
// LightningBolt.airSupply as int
myLightningBolt.airSupply

Return Type: int

airSupply() as int
Gets the current air supply of the entity.

Returns: The current air supply of the entity.

script.zs
// LightningBolt.airSupply() as int;
myLightningBolt.airSupply();

Return Type: int

alwaysAccepts
Getter
Checks if the command source always accepts.
script.zs
// LightningBolt.alwaysAccepts as bool
myLightningBolt.alwaysAccepts

Return Type: bool

alwaysAccepts() as bool
Checks if the command source always accepts.

Returns: True if the command source always accepts, false otherwise.

script.zs
// LightningBolt.alwaysAccepts() as bool;
myLightningBolt.alwaysAccepts();

Return Type: bool

bbHeight
Getter
Gets the height of the bounding box of the entity.
script.zs
// LightningBolt.bbHeight as float
myLightningBolt.bbHeight

Return Type: float

bbHeight() as float
Gets the height of the bounding box of the entity.

Returns: The height of the bounding box of the entity.

script.zs
// LightningBolt.bbHeight() as float;
myLightningBolt.bbHeight();

Return Type: float

bbWidth
Getter
Gets the width of the bounding box of the entity.
script.zs
// LightningBolt.bbWidth as float
myLightningBolt.bbWidth

Return Type: float

bbWidth() as float
Gets the width of the bounding box of the entity.

Returns: The width of the bounding box of the entity.

script.zs
// LightningBolt.bbWidth() as float;
myLightningBolt.bbWidth();

Return Type: float

blockPosiion
Getter
Gets the BlockPos of the entity.
script.zs
// LightningBolt.blockPosiion as BlockPos
myLightningBolt.blockPosiion

Return Type: BlockPos

blockPosiion() as BlockPos
Gets the BlockPos of the entity.

Returns: The BlockPos of the entity.

script.zs
// LightningBolt.blockPosiion() as BlockPos;
myLightningBolt.blockPosiion();

Return Type: BlockPos

blockPosition
Getter
Gets the position of the entity.
script.zs
// LightningBolt.blockPosition as BlockPos
myLightningBolt.blockPosition

Return Type: BlockPos

blockPosition() as BlockPos
Gets the position of the entity.

Returns: The block position of the entity.

script.zs
// LightningBolt.blockPosition() as BlockPos;
myLightningBolt.blockPosition();

Return Type: BlockPos

blocksSetOnFire
Getter
Gets the number of blocks that will be set on fire by the lightning bolt.
script.zs
// LightningBolt.blocksSetOnFire as int
myLightningBolt.blocksSetOnFire

Return Type: int

blocksSetOnFire() as int
Gets the number of blocks that will be set on fire by the lightning bolt.

Returns: The number of blocks that will be set on fire by the lightning bolt.

script.zs
// LightningBolt.blocksSetOnFire() as int;
myLightningBolt.blocksSetOnFire();

Return Type: int

blockX
Getter
Gets the x coordinate of the entity.
script.zs
// LightningBolt.blockX as int
myLightningBolt.blockX

Return Type: int

blockX() as int
Gets the x coordinate of the entity.

Returns: The x coordinate of the entity.

script.zs
// LightningBolt.blockX() as int;
myLightningBolt.blockX();

Return Type: int

blockY
Getter
Gets the y coordinate of the entity.
script.zs
// LightningBolt.blockY as int
myLightningBolt.blockY

Return Type: int

blockY() as int
Gets the y coordinate of the entity.

Returns: The y coordinate of the entity.

script.zs
// LightningBolt.blockY() as int;
myLightningBolt.blockY();

Return Type: int

blockZ
Getter
Gets the z coordinate of the entity.
script.zs
// LightningBolt.blockZ as int
myLightningBolt.blockZ

Return Type: int

blockZ() as int
Gets the z coordinate of the entity.

Returns: The z coordinate of the entity.

script.zs
// LightningBolt.blockZ() as int;
myLightningBolt.blockZ();

Return Type: int

boundingBox
Getter
Gets the bounding box of the entity.
script.zs
// LightningBolt.boundingBox as AABB
myLightningBolt.boundingBox

Return Type: AABB

boundingBox() as AABB
Gets the bounding box of the entity.

Returns: The bounding box of the entity.

script.zs
// LightningBolt.boundingBox() as AABB;
myLightningBolt.boundingBox();

Return Type: AABB

boundingBoxForCulling
Getter
Gets the bounding box for culling of the entity.
script.zs
// LightningBolt.boundingBoxForCulling as AABB
myLightningBolt.boundingBoxForCulling

Return Type: AABB

boundingBoxForCulling() as AABB
Gets the bounding box for culling of the entity.

Returns: The bounding box for culling of the entity.

script.zs
// LightningBolt.boundingBoxForCulling() as AABB;
myLightningBolt.boundingBoxForCulling();

Return Type: AABB

canBeCollidedWith
Getter
Checks if the entity can be collided with.
script.zs
// LightningBolt.canBeCollidedWith as bool
myLightningBolt.canBeCollidedWith

Return Type: bool

canBeCollidedWith() as bool
Checks if the entity can be collided with.

Returns: true if the entity can be collided with.

script.zs
// LightningBolt.canBeCollidedWith() as bool;
myLightningBolt.canBeCollidedWith();

Return Type: bool

canCollideWith
canCollideWith(other as Entity) as bool
Checks if the entity can collide with the given entity.

Returns: true if the entity can collide with the given entity.

script.zs
// LightningBolt.canCollideWith(other as Entity) as bool;
myLightningBolt.canCollideWith(myEntity);

Parameters:

other Type: Entity - The entity to check if the entity can collide with.

Return Type: bool

canFreeze
Getter
Checks if the entity can freeze.
script.zs
// LightningBolt.canFreeze as bool
myLightningBolt.canFreeze

Return Type: bool

canFreeze() as bool
Checks if the entity can freeze.

Returns: Whether the entity can freeze.

script.zs
// LightningBolt.canFreeze() as bool;
myLightningBolt.canFreeze();

Return Type: bool

cause
Getter
Gets the cause of the lightning bolt if it exists.
script.zs
// LightningBolt.cause as ServerPlayer
myLightningBolt.cause

Return Type: ServerPlayer

cause() as ServerPlayer
Gets the cause of the lightning bolt if it exists.

Returns: The cause of the lightning bolt.

script.zs
// LightningBolt.cause() as ServerPlayer;
myLightningBolt.cause();

Return Type: ServerPlayer

clearFire
clearFire()
Clears the fire of the entity.
script.zs
// LightningBolt.clearFire();
myLightningBolt.clearFire();
closerThan
closerThan(other as Entity, distance as double) as bool
Checks if the entity is closer than the given distance to another entity.

Returns: true if the entity is closer than the given distance to the other entity.

script.zs
// LightningBolt.closerThan(other as Entity, distance as double) as bool;
myLightningBolt.closerThan(myEntity, myDouble);

Parameters:

other Type: Entity - The other entity to check the distance to.
distance Type: double - The distance to check.

Return Type: bool

commandSenderWorld
Getter
Gets the Level used when sending commands as this entity.
script.zs
// LightningBolt.commandSenderWorld as Level
myLightningBolt.commandSenderWorld

Return Type: Level

commandSenderWorld() as Level
Gets the Level used when sending commands as this entity.

Returns: The Level used when sending commands as this entity.

script.zs
// LightningBolt.commandSenderWorld() as Level;
myLightningBolt.commandSenderWorld();

Return Type: Level

controllingPassenger
Getter
Gets the controlling passenger of the entity.
script.zs
// LightningBolt.controllingPassenger as Entity
myLightningBolt.controllingPassenger

Return Type: Entity

controllingPassenger() as Entity
Gets the controlling passenger of the entity.

Returns: The controlling passenger of the entity.

script.zs
// LightningBolt.controllingPassenger() as Entity;
myLightningBolt.controllingPassenger();

Return Type: Entity

customData
Getter
Gets the custom NBT data for this Entity.
script.zs
// LightningBolt.customData as MapData
myLightningBolt.customData

Return Type: MapData

customData() as MapData
Gets the custom NBT data for this Entity.

Returns: The custom data for this Entity.

script.zs
// LightningBolt.customData() as MapData;
myLightningBolt.customData();

Return Type: MapData

customName
Getter
Gets the custom name of the entity.
script.zs
// LightningBolt.customName as Component
myLightningBolt.customName

Return Type: Component

Getter
script.zs
// LightningBolt.customName as Component
myLightningBolt.customName

Return Type: Component

customName() as Component
Gets the custom name of the entity.

Returns: The custom name of the entity.

script.zs
// LightningBolt.customName() as Component;
myLightningBolt.customName();

Return Type: Component

customName() as Component
script.zs
// LightningBolt.customName() as Component;
myLightningBolt.customName();

Return Type: Component

dampensVibrations
Getter
Checks if the entity dampens vibrations, such as net.minecraft.world.entity.item.ItemEntitys who's item is in the dampens_vibrations item tag.
script.zs
// LightningBolt.dampensVibrations as bool
myLightningBolt.dampensVibrations

Return Type: bool

dampensVibrations() as bool
Checks if the entity dampens vibrations, such as net.minecraft.world.entity.item.ItemEntitys who's item is in the dampens_vibrations item tag.

Returns: true if the entity dampens vibrations.

script.zs
// LightningBolt.dampensVibrations() as bool;
myLightningBolt.dampensVibrations();

Return Type: bool

data
Getter
Gets the NBT data of this Entity.
script.zs
// LightningBolt.data as MapData
myLightningBolt.data

Return Type: MapData

data() as MapData
Gets the NBT data of this Entity.

Returns: The NBT data of this Entity.

script.zs
// LightningBolt.data() as MapData;
myLightningBolt.data();

Return Type: MapData

deltaMovement
Getter
Gets the delta movement of the entity.
script.zs
// LightningBolt.deltaMovement as Vec3
myLightningBolt.deltaMovement

Return Type: Vec3

Setter
Sets the delta movement of the entity.
script.zs
// LightningBolt.deltaMovement = (deltaMovement as Vec3);
myLightningBolt.deltaMovement = myVec3;

Parameters:

deltaMovement Type: Vec3 - The delta movement to set.
deltaMovement() as Vec3
Gets the delta movement of the entity.

Returns: The delta movement of the entity.

script.zs
// LightningBolt.deltaMovement() as Vec3;
myLightningBolt.deltaMovement();

Return Type: Vec3

deltaMovement(deltaMovement as Vec3)
Sets the delta movement of the entity.
script.zs
// LightningBolt.deltaMovement(deltaMovement as Vec3);
myLightningBolt.deltaMovement(myVec3);

Parameters:

deltaMovement Type: Vec3 - The delta movement to set.
dimensionChangingDelay
Getter
Gets the dimension changing delay of the entity.
script.zs
// LightningBolt.dimensionChangingDelay as int
myLightningBolt.dimensionChangingDelay

Return Type: int

dimensionChangingDelay() as int
Gets the dimension changing delay of the entity.

Returns: The dimension changing delay of the entity.

script.zs
// LightningBolt.dimensionChangingDelay() as int;
myLightningBolt.dimensionChangingDelay();

Return Type: int

direction
Getter
Gets the direction of the entity.
script.zs
// LightningBolt.direction as Direction
myLightningBolt.direction

Return Type: Direction

direction() as Direction
Gets the direction of the entity.

Returns: The direction of the entity.

script.zs
// LightningBolt.direction() as Direction;
myLightningBolt.direction();

Return Type: Direction

discard
discard()
Discards the entity.
script.zs
// LightningBolt.discard();
myLightningBolt.discard();
dismountsUnderwater
Getter
Checks if the entity dismounts underwater.
script.zs
// LightningBolt.dismountsUnderwater as bool
myLightningBolt.dismountsUnderwater

Return Type: bool

dismountsUnderwater() as bool
Checks if the entity dismounts underwater.

Returns: true if the entity dismounts underwater.

script.zs
// LightningBolt.dismountsUnderwater() as bool;
myLightningBolt.dismountsUnderwater();

Return Type: bool

displayName
Getter
Gets the display name of the entity.
script.zs
// LightningBolt.displayName as Component
myLightningBolt.displayName

Return Type: Component

Getter
script.zs
// LightningBolt.displayName as Component
myLightningBolt.displayName

Return Type: Component

displayName() as Component
Gets the display name of the entity.

Returns: The display name of the entity.

script.zs
// LightningBolt.displayName() as Component;
myLightningBolt.displayName();

Return Type: Component

displayName() as Component
script.zs
// LightningBolt.displayName() as Component;
myLightningBolt.displayName();

Return Type: Component

distanceTo
distanceTo(entity as Entity) as float
Gets the distance to the given entity.

Returns: The distance to the given entity.

script.zs
// LightningBolt.distanceTo(entity as Entity) as float;
myLightningBolt.distanceTo(myEntity);

Parameters:

entity Type: Entity - The entity to get the distance to.

Return Type: float

distanceToSqr
distanceToSqr(x as double, y as double, z as double) as double
Gets the squared distance to the given position.

Returns: The squared distance to the given position.

script.zs
// LightningBolt.distanceToSqr(x as double, y as double, z as double) as double;
myLightningBolt.distanceToSqr(myDouble, myDouble, myDouble);

Parameters:

x Type: double - The x position to get the squared distance to.
y Type: double - The y position to get the squared distance to.
z Type: double - The z position to get the squared distance to.

Return Type: double

distanceToSqr(entity as Entity) as double
Gets the squared distance to the given entity.

Returns: The squared distance to the given entity.

script.zs
// LightningBolt.distanceToSqr(entity as Entity) as double;
myLightningBolt.distanceToSqr(myEntity);

Parameters:

entity Type: Entity - The entity to get the squared distance to.

Return Type: double

distanceToSqr(vec as Vec3) as double
Gets the squared distance to the given vector.

Returns: The squared distance to the given vector.

script.zs
// LightningBolt.distanceToSqr(vec as Vec3) as double;
myLightningBolt.distanceToSqr(myVec3);

Parameters:

vec Type: Vec3 - The vector to get the squared distance to.

Return Type: double

ejectPassengers
ejectPassengers()
Ejects the passengers of the entity.
script.zs
// LightningBolt.ejectPassengers();
myLightningBolt.ejectPassengers();
eyeHeight
Getter
Gets the eye height of the entity.
script.zs
// LightningBolt.eyeHeight as float
myLightningBolt.eyeHeight

Return Type: float

eyeHeight() as float
Gets the eye height of the entity.

Returns: The eye height of the entity.

script.zs
// LightningBolt.eyeHeight() as float;
myLightningBolt.eyeHeight();

Return Type: float

eyePosition
Getter
Gets the eye position of the entity.
script.zs
// LightningBolt.eyePosition as Vec3
myLightningBolt.eyePosition

Return Type: Vec3

eyePosition() as Vec3
Gets the eye position of the entity.

Returns: The eye position of the entity.

script.zs
// LightningBolt.eyePosition() as Vec3;
myLightningBolt.eyePosition();

Return Type: Vec3

eyeY
Getter
Gets the y coordinate of the entity's eyes.
script.zs
// LightningBolt.eyeY as double
myLightningBolt.eyeY

Return Type: double

eyeY() as double
Gets the y coordinate of the entity's eyes.

Returns: The y coordinate of the entity's eyes.

script.zs
// LightningBolt.eyeY() as double;
myLightningBolt.eyeY();

Return Type: double

fireImmune
Getter
Checks if the entity is fire immune.
script.zs
// LightningBolt.fireImmune as bool
myLightningBolt.fireImmune

Return Type: bool

fireImmune() as bool
Checks if the entity is fire immune.

Returns: true if the entity is fire immune.

script.zs
// LightningBolt.fireImmune() as bool;
myLightningBolt.fireImmune();

Return Type: bool

fireTicks
Getter
Gets the remaining fire ticks of the entity.
script.zs
// LightningBolt.fireTicks as int
myLightningBolt.fireTicks

Return Type: int

Setter
Sets the remaining fire ticks of the entity.
script.zs
// LightningBolt.fireTicks = (ticks as int);
myLightningBolt.fireTicks = myInt;

Parameters:

ticks Type: int - The number of ticks to set the remaining fire ticks to.
fireTicks(ticks as int)
Sets the remaining fire ticks of the entity.
script.zs
// LightningBolt.fireTicks(ticks as int);
myLightningBolt.fireTicks(myInt);

Parameters:

ticks Type: int - The number of ticks to set the remaining fire ticks to.
fireTicks() as int
Gets the remaining fire ticks of the entity.

Returns: The remaining fire ticks of the entity.

script.zs
// LightningBolt.fireTicks() as int;
myLightningBolt.fireTicks();

Return Type: int

firstPassenger
Getter
Gets the first passenger of the entity.
script.zs
// LightningBolt.firstPassenger as Entity
myLightningBolt.firstPassenger

Return Type: Entity

firstPassenger() as Entity
Gets the first passenger of the entity.

Returns: The first passenger of the entity.

script.zs
// LightningBolt.firstPassenger() as Entity;
myLightningBolt.firstPassenger();

Return Type: Entity

fluidJumpThreshold
Getter
Gets the fluid jump threshold of the entity.
script.zs
// LightningBolt.fluidJumpThreshold as double
myLightningBolt.fluidJumpThreshold

Return Type: double

fluidJumpThreshold() as double
Gets the fluid jump threshold of the entity.

Returns: The fluid jump threshold of the entity.

script.zs
// LightningBolt.fluidJumpThreshold() as double;
myLightningBolt.fluidJumpThreshold();

Return Type: double

forward
Getter
Gets the forward vector of the entity.
script.zs
// LightningBolt.forward as Vec3
myLightningBolt.forward

Return Type: Vec3

forward() as Vec3
Gets the forward vector of the entity.

Returns: The forward vector of the entity.

script.zs
// LightningBolt.forward() as Vec3;
myLightningBolt.forward();

Return Type: Vec3

getAttachmentData
getAttachmentData(type as AttachmentType<T>) as T
script.zs
// LightningBolt.getAttachmentData<T>(type as AttachmentType<T>) as T;
myLightningBolt.getAttachmentData<T>(myAttachmentType);

Parameters:

type Type: AttachmentType<T>

Return Type: T

getAttachmentData(type as Supplier<AttachmentType<T>>) as T
script.zs
// LightningBolt.getAttachmentData<T>(type as Supplier<AttachmentType<T>>) as T;
myLightningBolt.getAttachmentData<T>(mySupplier);

Parameters:

type Type: Supplier<AttachmentType<T>>

Return Type: T

getEyePosition
getEyePosition(partialTicks as float) as Vec3
Gets the eye position of the entity.

Returns: The eye position of the entity.

script.zs
// LightningBolt.getEyePosition(partialTicks as float) as Vec3;
myLightningBolt.getEyePosition(myFloat);

Parameters:

partialTicks Type: float - The partial ticks to get the eye position for.

Return Type: Vec3

getPosition
getPosition(partialTicks as float) as Vec3
Gets the position of the entity.

Returns: The position of the entity.

script.zs
// LightningBolt.getPosition(partialTicks as float) as Vec3;
myLightningBolt.getPosition(myFloat);

Parameters:

partialTicks Type: float - The partial ticks to get the position for.

Return Type: Vec3

getUpVector
getUpVector(partialTicks as float) as Vec3
Gets the up vector of the entity.

Returns: The up vector of the entity.

script.zs
// LightningBolt.getUpVector(partialTicks as float) as Vec3;
myLightningBolt.getUpVector(myFloat);

Parameters:

partialTicks Type: float - The partial ticks to get the up vector for.

Return Type: Vec3

getViewVector
getViewVector(partialTicks as float) as Vec3
Gets the view vector of the entity.

Returns: The view vector of the entity.

script.zs
// LightningBolt.getViewVector(partialTicks as float) as Vec3;
myLightningBolt.getViewVector(myFloat);

Parameters:

partialTicks Type: float - The partial ticks to get the view vector for.

Return Type: Vec3

getX
getX(scale as double) as double
Gets the x coordinate of the entity with the given scale.

Returns: The x coordinate of the entity.

script.zs
// LightningBolt.getX(scale as double) as double;
myLightningBolt.getX(myDouble);

Parameters:

scale Type: double - The scale to get the x coordinate of the entity.

Return Type: double

getY
getY(scale as double) as double
Gets the y coordinate of the entity with the given scale.

Returns: The y coordinate of the entity.

script.zs
// LightningBolt.getY(scale as double) as double;
myLightningBolt.getY(myDouble);

Parameters:

scale Type: double - The scale to get the y coordinate of the entity.

Return Type: double

getZ
getZ(scale as double) as double
Gets the z coordinate of the entity with the given scale.

Returns: The z coordinate of the entity.

script.zs
// LightningBolt.getZ(scale as double) as double;
myLightningBolt.getZ(myDouble);

Parameters:

scale Type: double - The scale to get the z coordinate of the entity.

Return Type: double

hasAttachmentData
hasAttachmentData(type as AttachmentType<T>) as bool
script.zs
// LightningBolt.hasAttachmentData<T>(type as AttachmentType<T>) as bool;
myLightningBolt.hasAttachmentData<T>(myAttachmentType);

Parameters:

type Type: AttachmentType<T>

Return Type: bool

hasAttachmentData(type as Supplier<AttachmentType<T>>) as bool
script.zs
// LightningBolt.hasAttachmentData<T>(type as Supplier<AttachmentType<T>>) as bool;
myLightningBolt.hasAttachmentData<T>(mySupplier);

Parameters:

type Type: Supplier<AttachmentType<T>>

Return Type: bool

hasCustomName
Getter
Checks if the entity has a custom name.
script.zs
// LightningBolt.hasCustomName as bool
myLightningBolt.hasCustomName

Return Type: bool

Getter
script.zs
// LightningBolt.hasCustomName as bool
myLightningBolt.hasCustomName

Return Type: bool

hasCustomName() as bool
Checks if the entity has a custom name.

Returns: true if the entity has a custom name.

script.zs
// LightningBolt.hasCustomName() as bool;
myLightningBolt.hasCustomName();

Return Type: bool

hasCustomName() as bool
script.zs
// LightningBolt.hasCustomName() as bool;
myLightningBolt.hasCustomName();

Return Type: bool

hasExactlyOnePlayerPassenger
Getter
Checks if the entity has exactly one player passenger.
script.zs
// LightningBolt.hasExactlyOnePlayerPassenger as bool
myLightningBolt.hasExactlyOnePlayerPassenger

Return Type: bool

hasExactlyOnePlayerPassenger() as bool
Checks if the entity has exactly one player passenger.

Returns: true if the entity has exactly one player passenger.

script.zs
// LightningBolt.hasExactlyOnePlayerPassenger() as bool;
myLightningBolt.hasExactlyOnePlayerPassenger();

Return Type: bool

hasGlowingTag
Getter
Checks if the entity is currently glowing.
script.zs
// LightningBolt.hasGlowingTag as bool
myLightningBolt.hasGlowingTag

Return Type: bool

hasGlowingTag() as bool
Checks if the entity is currently glowing.

Returns: true if the entity is currently glowing.

script.zs
// LightningBolt.hasGlowingTag() as bool;
myLightningBolt.hasGlowingTag();

Return Type: bool

hasIndirectPassenger
hasIndirectPassenger(entity as Entity) as bool
Checks if the entity has an indirect passenger.

Returns: true if the entity has an indirect passenger.

script.zs
// LightningBolt.hasIndirectPassenger(entity as Entity) as bool;
myLightningBolt.hasIndirectPassenger(myEntity);

Parameters:

entity Type: Entity - The entity to check.

Return Type: bool

hasPassenger
hasPassenger(entity as Entity) as bool
Checks if the entity has a passenger.

Returns: true if the entity has the given passenger.

script.zs
// LightningBolt.hasPassenger(entity as Entity) as bool;
myLightningBolt.hasPassenger(myEntity);

Parameters:

entity Type: Entity - The entity to check.

Return Type: bool

hasPassenger(predicate as function(t as Entity) as bool) as bool
Checks if the entity has a passenger that matches the given predicate.

Returns: true if the entity has a passenger that matches the predicate.

script.zs
// LightningBolt.hasPassenger(predicate as function(t as Entity) as bool) as bool;
myLightningBolt.hasPassenger(myPredicate);

Parameters:

predicate Type: function(t as Entity) as bool - The predicate to check.

Return Type: bool

hurt
hurt(source as DamageSource, amount as float) as bool
Hurts the entity with the given DamageSource and amount.

Returns: true if the entity was hurt.

script.zs
// LightningBolt.hurt(source as DamageSource, amount as float) as bool;
myLightningBolt.hurt(myDamageSource, myFloat);

Parameters:

source Type: DamageSource - The DamageSource to hurt the entity with.
amount Type: float - The amount of damage to deal.

Return Type: bool

id
Getter
Gets the ID of the entity.
script.zs
// LightningBolt.id as int
myLightningBolt.id

Return Type: int

id() as int
Gets the ID of the entity.

Returns: The ID of the entity.

script.zs
// LightningBolt.id() as int;
myLightningBolt.id();

Return Type: int

inBlockState
Getter
Gets the BlockState that this entity is currently inside.
script.zs
// LightningBolt.inBlockState as BlockState
myLightningBolt.inBlockState

Return Type: BlockState

inBlockState() as BlockState
Gets the BlockState that this entity is currently inside.

Returns: The block state that this entity is currently inside

script.zs
// LightningBolt.inBlockState() as BlockState;
myLightningBolt.inBlockState();

Return Type: BlockState

isAlive
Getter
Checks if the entity is alive.
script.zs
// LightningBolt.isAlive as bool
myLightningBolt.isAlive

Return Type: bool

isAlive() as bool
Checks if the entity is alive.

Returns: true if the entity is alive.

script.zs
// LightningBolt.isAlive() as bool;
myLightningBolt.isAlive();

Return Type: bool

isAlwaysTicking
Getter
Checks if the entity is always ticking.
script.zs
// LightningBolt.isAlwaysTicking as bool
myLightningBolt.isAlwaysTicking

Return Type: bool

isAlwaysTicking() as bool
Checks if the entity is always ticking.

Returns: true if the entity is always ticking.

script.zs
// LightningBolt.isAlwaysTicking() as bool;
myLightningBolt.isAlwaysTicking();

Return Type: bool

isAttackable
Getter
Checks if the entity is attackable.
script.zs
// LightningBolt.isAttackable as bool
myLightningBolt.isAttackable

Return Type: bool

isAttackable() as bool
Checks if the entity is attackable.

Returns: true if the entity is attackable.

script.zs
// LightningBolt.isAttackable() as bool;
myLightningBolt.isAttackable();

Return Type: bool

isColliding
isColliding(pos as BlockPos, state as BlockState) as bool
Checks if this entity is colliding with the given BlockState at the given BlockPos.

Returns: true if the entity is colliding with the block.

script.zs
// LightningBolt.isColliding(pos as BlockPos, state as BlockState) as bool;
myLightningBolt.isColliding(myBlockPos, myBlockState);

Parameters:

pos Type: BlockPos - The position of the block to check.
state Type: BlockState - The state of the block to check.

Return Type: bool

isCrouching
Getter
Checks if the entity is crouching.
script.zs
// LightningBolt.isCrouching as bool
myLightningBolt.isCrouching

Return Type: bool

isCrouching() as bool
Checks if the entity is crouching.

Returns: true if the entity is crouching.

script.zs
// LightningBolt.isCrouching() as bool;
myLightningBolt.isCrouching();

Return Type: bool

isCurrentlyGlowing
Getter
Checks if the entity is currently glowing.
script.zs
// LightningBolt.isCurrentlyGlowing as bool
myLightningBolt.isCurrentlyGlowing

Return Type: bool

isCurrentlyGlowing() as bool
Checks if the entity is currently glowing.

Returns: true if the entity is currently glowing.

script.zs
// LightningBolt.isCurrentlyGlowing() as bool;
myLightningBolt.isCurrentlyGlowing();

Return Type: bool

isCustomNameVisible
Getter
Checks if the custom name of the entity is visible.
script.zs
// LightningBolt.isCustomNameVisible as bool
myLightningBolt.isCustomNameVisible

Return Type: bool

isCustomNameVisible() as bool
Checks if the custom name of the entity is visible.

Returns: true if the custom name is visible.

script.zs
// LightningBolt.isCustomNameVisible() as bool;
myLightningBolt.isCustomNameVisible();

Return Type: bool

isDescending
Getter
Checks if the entity is descending.
script.zs
// LightningBolt.isDescending as bool
myLightningBolt.isDescending

Return Type: bool

isDescending() as bool
Checks if the entity is descending.

Returns: true if the entity is descending.

script.zs
// LightningBolt.isDescending() as bool;
myLightningBolt.isDescending();

Return Type: bool

isDiscrete
Getter
Checks if the entity is being discrete.
script.zs
// LightningBolt.isDiscrete as bool
myLightningBolt.isDiscrete

Return Type: bool

isDiscrete() as bool
Checks if the entity is being discrete.

Returns: true if the entity is being discrete.

script.zs
// LightningBolt.isDiscrete() as bool;
myLightningBolt.isDiscrete();

Return Type: bool

isFree
isFree(x as double, y as double, z as double) as bool
Checks if the offset position from the entity's current position has a collision with a block or a liquid.

Returns: true if the entity is free to move in the given position.

script.zs
// LightningBolt.isFree(x as double, y as double, z as double) as bool;
myLightningBolt.isFree(myDouble, myDouble, myDouble);

Parameters:

x Type: double - The x position to check.
y Type: double - The y position to check.
z Type: double - The z position to check.

Return Type: bool

isFullyFrozen
Getter
Checks if the entity is fully frozen.
script.zs
// LightningBolt.isFullyFrozen as bool
myLightningBolt.isFullyFrozen

Return Type: bool

isFullyFrozen() as bool
Checks if the entity is fully frozen.

Returns: true if the entity is fully frozen.

script.zs
// LightningBolt.isFullyFrozen() as bool;
myLightningBolt.isFullyFrozen();

Return Type: bool

isInLava
Getter
Checks if the entity is in lava.
script.zs
// LightningBolt.isInLava as bool
myLightningBolt.isInLava

Return Type: bool

isInLava() as bool
Checks if the entity is in lava.

Returns: true if the entity is in lava.

script.zs
// LightningBolt.isInLava() as bool;
myLightningBolt.isInLava();

Return Type: bool

isInvisible
Getter
Checks if the entity is invisible.
script.zs
// LightningBolt.isInvisible as bool
myLightningBolt.isInvisible

Return Type: bool

isInvisible() as bool
Checks if the entity is invisible.

Returns: true if the entity is invisible.

script.zs
// LightningBolt.isInvisible() as bool;
myLightningBolt.isInvisible();

Return Type: bool

isInvisibleTo
isInvisibleTo(player as Player) as bool
Checks if the entity is invisible to the given Player.

Returns: true if the entity is invisible to the player.

script.zs
// LightningBolt.isInvisibleTo(player as Player) as bool;
myLightningBolt.isInvisibleTo(myPlayer);

Parameters:

player Type: Player - The player to check.

Return Type: bool

isInvulnerable
Getter
Checks if the entity is invulnerable.
script.zs
// LightningBolt.isInvulnerable as bool
myLightningBolt.isInvulnerable

Return Type: bool

isInvulnerable() as bool
Checks if the entity is invulnerable.

Returns: true if the entity is invulnerable.

script.zs
// LightningBolt.isInvulnerable() as bool;
myLightningBolt.isInvulnerable();

Return Type: bool

isInvulnerableTo
isInvulnerableTo(source as DamageSource) as bool
Checks if the entity is invulnerable to the given DamageSource.

Returns: true if the entity is invulnerable to the damage source.

script.zs
// LightningBolt.isInvulnerableTo(source as DamageSource) as bool;
myLightningBolt.isInvulnerableTo(myDamageSource);

Parameters:

source Type: DamageSource - The damage source to check.

Return Type: bool

isInWall
Getter
Checks if the entity is in a wall.
script.zs
// LightningBolt.isInWall as bool
myLightningBolt.isInWall

Return Type: bool

isInWall() as bool
Checks if the entity is in a wall.

Returns: true if the entity is in a wall.

script.zs
// LightningBolt.isInWall() as bool;
myLightningBolt.isInWall();

Return Type: bool

isInWater
Getter
Checks if the entity is in water.
script.zs
// LightningBolt.isInWater as bool
myLightningBolt.isInWater

Return Type: bool

isInWater() as bool
Checks if the entity is in water.

Returns: true if the entity is in water.

script.zs
// LightningBolt.isInWater() as bool;
myLightningBolt.isInWater();

Return Type: bool

isInWaterOrBubble
Getter
Checks if the entity is in water or a bubble column.
script.zs
// LightningBolt.isInWaterOrBubble as bool
myLightningBolt.isInWaterOrBubble

Return Type: bool

isInWaterOrBubble() as bool
Checks if the entity is in water or a bubble column.

Returns: true if the entity is in water or a bubble column.

script.zs
// LightningBolt.isInWaterOrBubble() as bool;
myLightningBolt.isInWaterOrBubble();

Return Type: bool

isInWaterOrRain
Getter
Checks if the entity is in water or rain.
script.zs
// LightningBolt.isInWaterOrRain as bool
myLightningBolt.isInWaterOrRain

Return Type: bool

isInWaterOrRain() as bool
Checks if the entity is in water or rain.

Returns: true if the entity is in water or rain.

script.zs
// LightningBolt.isInWaterOrRain() as bool;
myLightningBolt.isInWaterOrRain();

Return Type: bool

isInWaterRainOrBubble
Getter
Checks if the entity is in water or rain or a bubble column.
script.zs
// LightningBolt.isInWaterRainOrBubble as bool
myLightningBolt.isInWaterRainOrBubble

Return Type: bool

isInWaterRainOrBubble() as bool
Checks if the entity is in water or rain or a bubble column.

Returns: true if the entity is in water or rain or a bubble column.

script.zs
// LightningBolt.isInWaterRainOrBubble() as bool;
myLightningBolt.isInWaterRainOrBubble();

Return Type: bool

isNoGravity
Getter
Checks if the entity has no gravity.
script.zs
// LightningBolt.isNoGravity as bool
myLightningBolt.isNoGravity

Return Type: bool

isNoGravity() as bool
Checks if the entity has no gravity.

Returns: true if the entity has no gravity.

script.zs
// LightningBolt.isNoGravity() as bool;
myLightningBolt.isNoGravity();

Return Type: bool

isOnFire
Getter
Checks if the entity is on fire.
script.zs
// LightningBolt.isOnFire as bool
myLightningBolt.isOnFire

Return Type: bool

isOnFire() as bool
Checks if the entity is on fire.

Returns: true if the entity is on fire.

script.zs
// LightningBolt.isOnFire() as bool;
myLightningBolt.isOnFire();

Return Type: bool

isOnPortalCooldown
Getter
Checks if the entity is on portal cooldown.
script.zs
// LightningBolt.isOnPortalCooldown as bool
myLightningBolt.isOnPortalCooldown

Return Type: bool

isOnPortalCooldown() as bool
Checks if the entity is on portal cooldown.

Returns: true if the entity is on portal cooldown.

script.zs
// LightningBolt.isOnPortalCooldown() as bool;
myLightningBolt.isOnPortalCooldown();

Return Type: bool

isPassenger
Getter
Checks if the entity is a passenger.
script.zs
// LightningBolt.isPassenger as bool
myLightningBolt.isPassenger

Return Type: bool

isPassenger() as bool
Checks if the entity is a passenger.

Returns: true if the entity is a passenger.

script.zs
// LightningBolt.isPassenger() as bool;
myLightningBolt.isPassenger();

Return Type: bool

isPassengerOfSameVehicle
isPassengerOfSameVehicle(entity as Entity) as bool
Checks if the entity is a passenger of the same vehicle.

Returns: true if the entity is a passenger of the same vehicle.

script.zs
// LightningBolt.isPassengerOfSameVehicle(entity as Entity) as bool;
myLightningBolt.isPassengerOfSameVehicle(myEntity);

Parameters:

entity Type: Entity - The entity to check.

Return Type: bool

isPickable
Getter
Checks if the entity is pickable.
script.zs
// LightningBolt.isPickable as bool
myLightningBolt.isPickable

Return Type: bool

isPickable() as bool
Checks if the entity is pickable.

Returns: true if the entity is pickable.

script.zs
// LightningBolt.isPickable() as bool;
myLightningBolt.isPickable();

Return Type: bool

isPushable
Getter
Checks if the entity is pushable.
script.zs
// LightningBolt.isPushable as bool
myLightningBolt.isPushable

Return Type: bool

isPushable() as bool
Checks if the entity is pushable.

Returns: true if the entity is pushable.

script.zs
// LightningBolt.isPushable() as bool;
myLightningBolt.isPushable();

Return Type: bool

isPushedByFluid
Getter
Checks if the entity is pushed by fluid.
script.zs
// LightningBolt.isPushedByFluid as bool
myLightningBolt.isPushedByFluid

Return Type: bool

isPushedByFluid() as bool
Checks if the entity is pushed by fluid.

Returns: true if the entity is pushed by fluid.

script.zs
// LightningBolt.isPushedByFluid() as bool;
myLightningBolt.isPushedByFluid();

Return Type: bool

isRemoved
Getter
Checks if the entity has been removed.
script.zs
// LightningBolt.isRemoved as bool
myLightningBolt.isRemoved

Return Type: bool

isRemoved() as bool
Checks if the entity has been removed.

Returns: Whether the entity has been removed.

script.zs
// LightningBolt.isRemoved() as bool;
myLightningBolt.isRemoved();

Return Type: bool

isShiftKeyDown
Getter
Checks if the shift key is down.
script.zs
// LightningBolt.isShiftKeyDown as bool
myLightningBolt.isShiftKeyDown

Return Type: bool

isShiftKeyDown() as bool
Checks if the shift key is down.

Returns: true if the shift key is down.

script.zs
// LightningBolt.isShiftKeyDown() as bool;
myLightningBolt.isShiftKeyDown();

Return Type: bool

isSilent
Getter
Checks if the entity is silent, meaning it won't play any sounds.
script.zs
// LightningBolt.isSilent as bool
myLightningBolt.isSilent

Return Type: bool

isSilent() as bool
Checks if the entity is silent, meaning it won't play any sounds.

Returns: true if the entity is silent.

script.zs
// LightningBolt.isSilent() as bool;
myLightningBolt.isSilent();

Return Type: bool

isSpectator
Getter
Checks if the entity is a spectator.
script.zs
// LightningBolt.isSpectator as bool
myLightningBolt.isSpectator

Return Type: bool

isSpectator() as bool
Checks if the entity is a spectator.

Returns: true if the entity is a spectator.

script.zs
// LightningBolt.isSpectator() as bool;
myLightningBolt.isSpectator();

Return Type: bool

isSprinting
Getter
Checks if the entity is sprinting.
script.zs
// LightningBolt.isSprinting as bool
myLightningBolt.isSprinting

Return Type: bool

isSprinting() as bool
Checks if the entity is sprinting.

Returns: true if the entity is sprinting.

script.zs
// LightningBolt.isSprinting() as bool;
myLightningBolt.isSprinting();

Return Type: bool

isSteppingCarefully
Getter
Checks if the entity is stepping carefully.
script.zs
// LightningBolt.isSteppingCarefully as bool
myLightningBolt.isSteppingCarefully

Return Type: bool

isSteppingCarefully() as bool
Checks if the entity is stepping carefully.

Returns: true if the entity is stepping carefully.

script.zs
// LightningBolt.isSteppingCarefully() as bool;
myLightningBolt.isSteppingCarefully();

Return Type: bool

isSuppressingBounce
Getter
Checks if the entity is suppressing bounce.
script.zs
// LightningBolt.isSuppressingBounce as bool
myLightningBolt.isSuppressingBounce

Return Type: bool

isSuppressingBounce() as bool
Checks if the entity is suppressing bounce.

Returns: true if the entity is suppressing bounce.

script.zs
// LightningBolt.isSuppressingBounce() as bool;
myLightningBolt.isSuppressingBounce();

Return Type: bool

isSwimming
Getter
Checks if the entity is swimming.
script.zs
// LightningBolt.isSwimming as bool
myLightningBolt.isSwimming

Return Type: bool

isSwimming() as bool
Checks if the entity is swimming.

Returns: true if the entity is swimming.

script.zs
// LightningBolt.isSwimming() as bool;
myLightningBolt.isSwimming();

Return Type: bool

isUnderWater
Getter
Checks if the entity is underwater.
script.zs
// LightningBolt.isUnderWater as bool
myLightningBolt.isUnderWater

Return Type: bool

isUnderWater() as bool
Checks if the entity is underwater.

Returns: true if the entity is underwater.

script.zs
// LightningBolt.isUnderWater() as bool;
myLightningBolt.isUnderWater();

Return Type: bool

isVehicle
Getter
Checks if the entity is a vehicle.
script.zs
// LightningBolt.isVehicle as bool
myLightningBolt.isVehicle

Return Type: bool

isVehicle() as bool
Checks if the entity is a vehicle.

Returns: true if the entity is a vehicle.

script.zs
// LightningBolt.isVehicle() as bool;
myLightningBolt.isVehicle();

Return Type: bool

isVisuallyCrawling
Getter
Checks if the entity is visually crawling.
script.zs
// LightningBolt.isVisuallyCrawling as bool
myLightningBolt.isVisuallyCrawling

Return Type: bool

isVisuallyCrawling() as bool
Checks if the entity is visually crawling.

Returns: true if the entity is visually crawling.

script.zs
// LightningBolt.isVisuallyCrawling() as bool;
myLightningBolt.isVisuallyCrawling();

Return Type: bool

isVisuallySwimming
Getter
Checks if the entity is visually swimming.
script.zs
// LightningBolt.isVisuallySwimming as bool
myLightningBolt.isVisuallySwimming

Return Type: bool

isVisuallySwimming() as bool
Checks if the entity is visually swimming.

Returns: true if the entity is visually swimming.

script.zs
// LightningBolt.isVisuallySwimming() as bool;
myLightningBolt.isVisuallySwimming();

Return Type: bool

kill
kill()
Kills the entity.
script.zs
// LightningBolt.kill();
myLightningBolt.kill();
lavaHurt
lavaHurt()
Causes the entity to take damage from lava.
script.zs
// LightningBolt.lavaHurt();
myLightningBolt.lavaHurt();
level
Getter
Gets the Level of the entity.
script.zs
// LightningBolt.level as Level
myLightningBolt.level

Return Type: Level

lookAngle
Getter
Gets the look angle of the entity.
script.zs
// LightningBolt.lookAngle as Vec3
myLightningBolt.lookAngle

Return Type: Vec3

lookAngle() as Vec3
Gets the look angle of the entity.

Returns: The look angle of the entity.

script.zs
// LightningBolt.lookAngle() as Vec3;
myLightningBolt.lookAngle();

Return Type: Vec3

maxAirSupply
Getter
Gets the maximum air supply of the entity.
script.zs
// LightningBolt.maxAirSupply as int
myLightningBolt.maxAirSupply

Return Type: int

maxAirSupply() as int
Gets the maximum air supply of the entity.

Returns: The maximum air supply of the entity.

script.zs
// LightningBolt.maxAirSupply() as int;
myLightningBolt.maxAirSupply();

Return Type: int

maxFallDistance
Getter
Gets the maximum fall distance of the entity.
script.zs
// LightningBolt.maxFallDistance as int
myLightningBolt.maxFallDistance

Return Type: int

maxFallDistance() as int
Gets the maximum fall distance of the entity.

Returns: The maximum fall distance of the entity.

script.zs
// LightningBolt.maxFallDistance() as int;
myLightningBolt.maxFallDistance();

Return Type: int

motionDirection
Getter
Gets the motion direction of the entity.
script.zs
// LightningBolt.motionDirection as Direction
myLightningBolt.motionDirection

Return Type: Direction

motionDirection() as Direction
Gets the motion direction of the entity.

Returns: The motion direction of the entity.

script.zs
// LightningBolt.motionDirection() as Direction;
myLightningBolt.motionDirection();

Return Type: Direction

moveRelative
moveRelative(amount as float, relative as Vec3)
Moves the entity relative to its current position.
script.zs
// LightningBolt.moveRelative(amount as float, relative as Vec3);
myLightningBolt.moveRelative(myFloat, myVec3);

Parameters:

amount Type: float - The amount to move the entity by.
relative Type: Vec3 - The relative position to move the entity by.
moveTo
moveTo(vec as Vec3)
Moves the entity to the given position.
script.zs
// LightningBolt.moveTo(vec as Vec3);
myLightningBolt.moveTo(myVec3);

Parameters:

vec Type: Vec3 - The position to move the entity to.
moveTo(x as double, y as double, z as double)
Moves the entity to the given position.
script.zs
// LightningBolt.moveTo(x as double, y as double, z as double);
myLightningBolt.moveTo(myDouble, myDouble, myDouble);

Parameters:

x Type: double - The x position to move the entity to.
y Type: double - The y position to move the entity to.
z Type: double - The z position to move the entity to.
moveTo(pos as BlockPos, yaw as float, pitch as float)
Moves the entity to the given position.
script.zs
// LightningBolt.moveTo(pos as BlockPos, yaw as float, pitch as float);
myLightningBolt.moveTo(myBlockPos, myFloat, myFloat);

Parameters:

pos Type: BlockPos - The position to move the entity to.
yaw Type: float - The yaw to move the entity to.
pitch Type: float - The pitch to move the entity to.
moveTo(x as double, y as double, z as double, yaw as float, pitch as float)
Moves the entity to the given position.
script.zs
// LightningBolt.moveTo(x as double, y as double, z as double, yaw as float, pitch as float);
myLightningBolt.moveTo(myDouble, myDouble, myDouble, myFloat, myFloat);

Parameters:

x Type: double - The x position to move the entity to.
y Type: double - The y position to move the entity to.
z Type: double - The z position to move the entity to.
yaw Type: float - The yaw to move the entity to.
pitch Type: float - The pitch to move the entity to.
name
Getter
Gets the name of the entity.
script.zs
// LightningBolt.name as Component
myLightningBolt.name

Return Type: Component

Getter
script.zs
// LightningBolt.name as Component
myLightningBolt.name

Return Type: Component

name() as Component
Gets the name of the entity.

Returns: The name of the entity.

script.zs
// LightningBolt.name() as Component;
myLightningBolt.name();

Return Type: Component

name() as Component
script.zs
// LightningBolt.name() as Component;
myLightningBolt.name();

Return Type: Component

onGround
Getter
Checks if the entity is on the ground.
script.zs
// LightningBolt.onGround as bool
myLightningBolt.onGround

Return Type: bool

onPos
Getter
Gets the position of the entity on the ground.
script.zs
// LightningBolt.onPos as BlockPos
myLightningBolt.onPos

Return Type: BlockPos

onPos() as BlockPos
Gets the position of the entity on the ground.

Returns: The position of the entity on the ground.

script.zs
// LightningBolt.onPos() as BlockPos;
myLightningBolt.onPos();

Return Type: BlockPos

passengers
Getter
Gets the passengers of the entity.
script.zs
// LightningBolt.passengers as List<Entity>
myLightningBolt.passengers

Return Type: List<Entity>

passengers() as List<Entity>
Gets the passengers of the entity.

Returns: The passengers of the entity.

script.zs
// LightningBolt.passengers() as List<Entity>;
myLightningBolt.passengers();

Return Type: List<Entity>

percentFrozen
Getter
Gets the percent the entity is frozen.
script.zs
// LightningBolt.percentFrozen as float
myLightningBolt.percentFrozen

Return Type: float

percentFrozen() as float
Gets the percent the entity is frozen.

Returns: The percent the entity is frozen.

script.zs
// LightningBolt.percentFrozen() as float;
myLightningBolt.percentFrozen();

Return Type: float

pistonPushReaction
Getter
Gets the piston push reaction of the entity.
script.zs
// LightningBolt.pistonPushReaction as PushReaction
myLightningBolt.pistonPushReaction

Return Type: PushReaction

pistonPushReaction() as PushReaction
Gets the piston push reaction of the entity.

Returns: The piston push reaction of the entity.

script.zs
// LightningBolt.pistonPushReaction() as PushReaction;
myLightningBolt.pistonPushReaction();

Return Type: PushReaction

playSound
playSound(sound as SoundEvent, volume as float, pitch as float)
Plays a sound at the entity's location.
script.zs
// LightningBolt.playSound(sound as SoundEvent, volume as float, pitch as float);
myLightningBolt.playSound(mySoundEvent, myFloat, myFloat);

Parameters:

sound Type: SoundEvent - The sound to play.
volume Type: float - The volume of the sound.
pitch Type: float - The pitch of the sound.
position
Getter
Gets the position of the entity.
script.zs
// LightningBolt.position as Vec3
myLightningBolt.position

Return Type: Vec3

position() as Vec3
Gets the position of the entity.

Returns: The position of the entity.

script.zs
// LightningBolt.position() as Vec3;
myLightningBolt.position();

Return Type: Vec3

positionRider
positionRider(entity as Entity)
Positions the rider of the entity.
script.zs
// LightningBolt.positionRider(entity as Entity);
myLightningBolt.positionRider(myEntity);

Parameters:

entity Type: Entity - The entity to position the rider of.
registryName
Getter
Gets the registry name of the entity.
script.zs
// LightningBolt.registryName as ResourceLocation
myLightningBolt.registryName

Return Type: ResourceLocation

registryName() as ResourceLocation
Gets the registry name of the entity.

Returns: The registry name of the entity.

script.zs
// LightningBolt.registryName() as ResourceLocation;
myLightningBolt.registryName();

Return Type: ResourceLocation

removeTag
removeTag(tagName as string) as bool
Removes a tag from the entity.

Returns: true if the tag was removed.

script.zs
// LightningBolt.removeTag(tagName as string) as bool;
myLightningBolt.removeTag(myString);

Parameters:

tagName Type: string - The name of the tag to remove.

Return Type: bool

removeVehicle
removeVehicle()
Removes the vehicle of the entity.
script.zs
// LightningBolt.removeVehicle();
myLightningBolt.removeVehicle();
rootVehicle
Getter
Gets the root vehicle of the entity.
script.zs
// LightningBolt.rootVehicle as Entity
myLightningBolt.rootVehicle

Return Type: Entity

rootVehicle() as Entity
Gets the root vehicle of the entity.

Returns: The root vehicle of the entity.

script.zs
// LightningBolt.rootVehicle() as Entity;
myLightningBolt.rootVehicle();

Return Type: Entity

sendMessage
sendMessage(component as Component)
Sends a message to the command source.
script.zs
// LightningBolt.sendMessage(component as Component);
myLightningBolt.sendMessage(myComponent);

Parameters:

component Type: Component - The message to send.
setAirSupply
setAirSupply(air as int)
Sets the air supply of the entity.
script.zs
// LightningBolt.setAirSupply(air as int);
myLightningBolt.setAirSupply(myInt);

Parameters:

air Type: int - The new air supply of the entity.
setAttachmentData
setAttachmentData(type as AttachmentType<T>, data as T) as T?
script.zs
// LightningBolt.setAttachmentData<T>(type as AttachmentType<T>, data as T) as T?;
myLightningBolt.setAttachmentData<T>(myAttachmentType, myT);

Parameters:

type Type: AttachmentType<T>
data Type: T

Return Type: T?

setAttachmentData(type as Supplier<AttachmentType<T>>, data as T) as T?
script.zs
// LightningBolt.setAttachmentData<T>(type as Supplier<AttachmentType<T>>, data as T) as T?;
myLightningBolt.setAttachmentData<T>(mySupplier, myT);

Parameters:

type Type: Supplier<AttachmentType<T>>
data Type: T

Return Type: T?

setCustomName
setCustomName(name as Component)
Sets the custom name of the entity.
script.zs
// LightningBolt.setCustomName(name as Component);
myLightningBolt.setCustomName(myComponent);

Parameters:

name Type: Component - The new custom name of the entity.
setCustomNameVisible
setCustomNameVisible(visible as bool)
Sets the custom name visible state of the entity.
script.zs
// LightningBolt.setCustomNameVisible(visible as bool);
myLightningBolt.setCustomNameVisible(myBool);

Parameters:

visible Type: bool - true if the custom name should be visible.
setDeltaMovement
setDeltaMovement(xDelta as double, yDelta as double, zDelta as double)
Sets the delta movement of the entity.
script.zs
// LightningBolt.setDeltaMovement(xDelta as double, yDelta as double, zDelta as double);
myLightningBolt.setDeltaMovement(myDouble, myDouble, myDouble);

Parameters:

xDelta Type: double - The x delta movement to set.
yDelta Type: double - The y delta movement to set.
zDelta Type: double - The z delta movement to set.
setGlowingTag
setGlowingTag(glowing as bool)
Makes the entity glow.
script.zs
// LightningBolt.setGlowingTag(glowing as bool);
myLightningBolt.setGlowingTag(myBool);

Parameters:

glowing Type: bool - true if the entity should be glowing.
setInvisible
setInvisible(invisible as bool)
Sets the invisible state of the entity.
script.zs
// LightningBolt.setInvisible(invisible as bool);
myLightningBolt.setInvisible(myBool);

Parameters:

invisible Type: bool - true if the entity should be invisible.
setInvulnerable
setInvulnerable(invulnerable as bool)
Sets the invulnerable state of the entity.
script.zs
// LightningBolt.setInvulnerable(invulnerable as bool);
myLightningBolt.setInvulnerable(myBool);

Parameters:

invulnerable Type: bool - true if the entity should be invulnerable.
setIsInPowderSnow
setIsInPowderSnow(inPowderSnow as bool)
Sets whether the entity is in powder snow.
script.zs
// LightningBolt.setIsInPowderSnow(inPowderSnow as bool);
myLightningBolt.setIsInPowderSnow(myBool);

Parameters:

inPowderSnow Type: bool - Whether the entity is in powder snow.
setNoGravity
setNoGravity(noGravity as bool)
Sets if the entity has no gravity.
script.zs
// LightningBolt.setNoGravity(noGravity as bool);
myLightningBolt.setNoGravity(myBool);

Parameters:

noGravity Type: bool - The no gravity state to set the entity to.
setOldPosAndRot
setOldPosAndRot()
Sets the old position and rotation of the entity.
script.zs
// LightningBolt.setOldPosAndRot();
myLightningBolt.setOldPosAndRot();
setOnGround
setOnGround(onGround as bool)
Sets if the entity is on the ground.
script.zs
// LightningBolt.setOnGround(onGround as bool);
myLightningBolt.setOnGround(myBool);

Parameters:

onGround Type: bool - The on ground state to set the entity to.
setPortalCooldown
setPortalCooldown()
Sets the portal cooldown of the entity.
script.zs
// LightningBolt.setPortalCooldown();
myLightningBolt.setPortalCooldown();
setPos
setPos(position as Vec3)
Sets the position of the entity.
script.zs
// LightningBolt.setPos(position as Vec3);
myLightningBolt.setPos(myVec3);

Parameters:

position Type: Vec3 - The position to set the entity to.
setPos(x as double, y as double, z as double)
Sets the position of the entity.
script.zs
// LightningBolt.setPos(x as double, y as double, z as double);
myLightningBolt.setPos(myDouble, myDouble, myDouble);

Parameters:

x Type: double - The x position to set the entity to.
y Type: double - The y position to set the entity to.
z Type: double - The z position to set the entity to.
setPosRaw
setPosRaw(x as double, y as double, z as double)
Sets the position of the entity to the given coordinates.
script.zs
// LightningBolt.setPosRaw(x as double, y as double, z as double);
myLightningBolt.setPosRaw(myDouble, myDouble, myDouble);

Parameters:

x Type: double - The x coordinate to set the position to.
y Type: double - The y coordinate to set the position to.
z Type: double - The z coordinate to set the position to.
setRemoved
setRemoved(var1 as RemovalReason)
Removes this entity with the given removal reason.
script.zs
// LightningBolt.setRemoved(var1 as RemovalReason);
myLightningBolt.setRemoved(myRemovalReason);

Parameters:

var1 Type: RemovalReason - The removal reason to set.
setShiftKeyDown
setShiftKeyDown(keyDown as bool)
Sets the shift key down state of the entity.
script.zs
// LightningBolt.setShiftKeyDown(keyDown as bool);
myLightningBolt.setShiftKeyDown(myBool);

Parameters:

keyDown Type: bool - true if the shift key is down.
setSilent
setSilent(silent as bool)
Sets if the entity is silent.
script.zs
// LightningBolt.setSilent(silent as bool);
myLightningBolt.setSilent(myBool);

Parameters:

silent Type: bool - The silent state to set the entity to.
setSprinting
setSprinting(sprinting as bool)
Sets the sprinting state of the entity.
script.zs
// LightningBolt.setSprinting(sprinting as bool);
myLightningBolt.setSprinting(myBool);

Parameters:

sprinting Type: bool - true if the entity should be sprinting.
setSwimming
setSwimming(swimming as bool)
Sets the swimming state of the entity.
script.zs
// LightningBolt.setSwimming(swimming as bool);
myLightningBolt.setSwimming(myBool);

Parameters:

swimming Type: bool - true if the entity should be swimming.
setTicksFrozen
setTicksFrozen(ticks as int)
Sets the number of ticks the entity has been frozen.
script.zs
// LightningBolt.setTicksFrozen(ticks as int);
myLightningBolt.setTicksFrozen(myInt);

Parameters:

ticks Type: int - The new number of ticks the entity has been frozen.
shouldBeSaved
Getter
Checks if the entity should be saved.
script.zs
// LightningBolt.shouldBeSaved as bool
myLightningBolt.shouldBeSaved

Return Type: bool

shouldBeSaved() as bool
Checks if the entity should be saved.

Returns: true if the entity should be saved.

script.zs
// LightningBolt.shouldBeSaved() as bool;
myLightningBolt.shouldBeSaved();

Return Type: bool

shouldInformAdmins
Getter
Checks if the commands from this source should inform admins.
script.zs
// LightningBolt.shouldInformAdmins as bool
myLightningBolt.shouldInformAdmins

Return Type: bool

shouldInformAdmins() as bool
Checks if the commands from this source should inform admins.

Returns: True if the commands from this source should inform admins, false otherwise.

script.zs
// LightningBolt.shouldInformAdmins() as bool;
myLightningBolt.shouldInformAdmins();

Return Type: bool

shouldShowName
Getter
Checks if the entity should show its name.
script.zs
// LightningBolt.shouldShowName as bool
myLightningBolt.shouldShowName

Return Type: bool

shouldShowName() as bool
Checks if the entity should show its name.

Returns: true if the entity should show its name.

script.zs
// LightningBolt.shouldShowName() as bool;
myLightningBolt.shouldShowName();

Return Type: bool

showVehicleHealth
Getter
Checks if the entity should show vehicle health.
script.zs
// LightningBolt.showVehicleHealth as bool
myLightningBolt.showVehicleHealth

Return Type: bool

showVehicleHealth() as bool
Checks if the entity should show vehicle health.

Returns: true if the entity should show vehicle health.

script.zs
// LightningBolt.showVehicleHealth() as bool;
myLightningBolt.showVehicleHealth();

Return Type: bool

soundSource
Getter
Gets the SoundSource of the entity.
script.zs
// LightningBolt.soundSource as SoundSource
myLightningBolt.soundSource

Return Type: SoundSource

soundSource() as SoundSource
Gets the SoundSource of the entity.

Returns: The sound source of the entity.

script.zs
// LightningBolt.soundSource() as SoundSource;
myLightningBolt.soundSource();

Return Type: SoundSource

startRiding
startRiding(entity as Entity) as bool
Starts riding the given entity.

Returns: true if the entity started riding.

script.zs
// LightningBolt.startRiding(entity as Entity) as bool;
myLightningBolt.startRiding(myEntity);

Parameters:

entity Type: Entity - The entity to start riding.

Return Type: bool

startRiding(entity as Entity, force as bool) as bool
Starts riding the given entity.

Returns: true if the entity started riding.

script.zs
// LightningBolt.startRiding(entity as Entity, force as bool) as bool;
myLightningBolt.startRiding(myEntity, myBool);

Parameters:

entity Type: Entity - The entity to start riding.
force Type: bool - true if the entity should be forced to start riding.

Return Type: bool

stopRiding
stopRiding()
Stops riding the entity.
script.zs
// LightningBolt.stopRiding();
myLightningBolt.stopRiding();
stringUUID
Getter
Gets the UUID of the entity as a string.
script.zs
// LightningBolt.stringUUID as string
myLightningBolt.stringUUID

Return Type: string

stringUUID() as string
Gets the UUID of the entity as a string.

Returns: The UUID of the entity as a string.

script.zs
// LightningBolt.stringUUID() as string;
myLightningBolt.stringUUID();

Return Type: string

tags
Getter
Gets the tags of the entity.
These tags are arbitrary strings that can be attached to an entity. A single entity is limited to 1024.
script.zs
// LightningBolt.tags as Set<string>
myLightningBolt.tags

Return Type: Set<string>

tags() as Set<string>
Gets the tags of the entity.
These tags are arbitrary strings that can be attached to an entity. A single entity is limited to 1024.

Returns: The tags of the entity.

script.zs
// LightningBolt.tags() as Set<string>;
myLightningBolt.tags();

Return Type: Set<string>

teamColor
Getter
Gets the team color of the entity.
script.zs
// LightningBolt.teamColor as int
myLightningBolt.teamColor

Return Type: int

teamColor() as int
Gets the team color of the entity.

Returns: The team color of the entity.

script.zs
// LightningBolt.teamColor() as int;
myLightningBolt.teamColor();

Return Type: int

teleportTo
teleportTo(x as double, y as double, z as double)
Teleports the entity to the given position.
script.zs
// LightningBolt.teleportTo(x as double, y as double, z as double);
myLightningBolt.teleportTo(myDouble, myDouble, myDouble);

Parameters:

x Type: double - The x coordinate to teleport to.
y Type: double - The y coordinate to teleport to.
z Type: double - The z coordinate to teleport to.
ticksFrozen
Getter
Gets the number of ticks the entity has been frozen.
script.zs
// LightningBolt.ticksFrozen as int
myLightningBolt.ticksFrozen

Return Type: int

ticksFrozen() as int
Gets the number of ticks the entity has been frozen.

Returns: The number of ticks the entity has been frozen.

script.zs
// LightningBolt.ticksFrozen() as int;
myLightningBolt.ticksFrozen();

Return Type: int

ticksRequiredToFreeze
Getter
Gets the number of ticks required to freeze the entity.
script.zs
// LightningBolt.ticksRequiredToFreeze as int
myLightningBolt.ticksRequiredToFreeze

Return Type: int

ticksRequiredToFreeze() as int
Gets the number of ticks required to freeze the entity.

Returns: The number of ticks required to freeze the entity.

script.zs
// LightningBolt.ticksRequiredToFreeze() as int;
myLightningBolt.ticksRequiredToFreeze();

Return Type: int

turn
turn(yaw as double, pitch as double)
Turns the entity.
script.zs
// LightningBolt.turn(yaw as double, pitch as double);
myLightningBolt.turn(myDouble, myDouble);

Parameters:

yaw Type: double - The yaw to turn the entity to.
pitch Type: double - The pitch to turn the entity to.
type
Getter
Gets the EntityType of the entity.
script.zs
// LightningBolt.type as EntityType<Entity>
myLightningBolt.type

Return Type: EntityType<Entity>

type() as EntityType<Entity>
Gets the EntityType of the entity.

Returns: The EntityType of the entity.

script.zs
// LightningBolt.type() as EntityType<Entity>;
myLightningBolt.type();

Return Type: EntityType<Entity>

unRide
unRide()
Removes any passengers and stops riding the current entity.
script.zs
// LightningBolt.unRide();
myLightningBolt.unRide();
updateCustomData
updateCustomData(data as MapData)
Updates the custom NBT data for this Entity.
script.zs
// LightningBolt.updateCustomData(data as MapData);
myLightningBolt.updateCustomData({custom: "data"});

Parameters:

data Type: MapData - The custom data to store.
updateCustomEntityTag
updateCustomEntityTag(level as Level, player as Player, data as MapData)
script.zs
// LightningBolt.updateCustomEntityTag(level as Level, player as Player, data as MapData);
myLightningBolt.updateCustomEntityTag(myLevel, myPlayer, myMapData);

Parameters:

level Type: Level
player Type: Player
data Type: MapData
updateData
updateData(data as MapData)
Updates the NBT data of this Entity.
script.zs
// LightningBolt.updateData(data as MapData);
myLightningBolt.updateData({key: "value"});

Parameters:

data Type: MapData - The new Data for this Entity
uuid
Getter
Gets the UUID of the entity.
script.zs
// LightningBolt.uuid as UUID
myLightningBolt.uuid

Return Type: UUID

uuid() as UUID
Gets the UUID of the entity.

Returns: The UUID of the entity.

script.zs
// LightningBolt.uuid() as UUID;
myLightningBolt.uuid();

Return Type: UUID

vehicle
Getter
Gets the vehicle of the entity.
script.zs
// LightningBolt.vehicle as Entity
myLightningBolt.vehicle

Return Type: Entity

vehicle() as Entity
Gets the vehicle of the entity.

Returns: The vehicle of the entity.

script.zs
// LightningBolt.vehicle() as Entity;
myLightningBolt.vehicle();

Return Type: Entity

visualOnly
Getter
Checks if the lightning bolt is visual only.
script.zs
// LightningBolt.visualOnly as bool
myLightningBolt.visualOnly

Return Type: bool

Setter
Sets whether the lightning bolt is visual only.
script.zs
// LightningBolt.visualOnly = (visualOnly as bool);
myLightningBolt.visualOnly = myBool;

Parameters:

visualOnly Type: bool - Whether the lightning bolt is visual only.
visualOnly(visualOnly as bool)
Sets whether the lightning bolt is visual only.
script.zs
// LightningBolt.visualOnly(visualOnly as bool);
myLightningBolt.visualOnly(myBool);

Parameters:

visualOnly Type: bool - Whether the lightning bolt is visual only.
visualOnly() as bool
Checks if the lightning bolt is visual only.

Returns: Whether the lightning bolt is visual only.

script.zs
// LightningBolt.visualOnly() as bool;
myLightningBolt.visualOnly();

Return Type: bool

x
Getter
Gets the x coordinate of the entity.
script.zs
// LightningBolt.x as double
myLightningBolt.x

Return Type: double

x() as double
Gets the x coordinate of the entity.

Returns: The x coordinate of the entity.

script.zs
// LightningBolt.x() as double;
myLightningBolt.x();

Return Type: double

y
Getter
Gets the y coordinate of the entity.
script.zs
// LightningBolt.y as double
myLightningBolt.y

Return Type: double

y() as double
Gets the y coordinate of the entity.

Returns: The y coordinate of the entity.

script.zs
// LightningBolt.y() as double;
myLightningBolt.y();

Return Type: double

z
Getter
Gets the z coordinate of the entity.
script.zs
// LightningBolt.z as double
myLightningBolt.z

Return Type: double

z() as double
Gets the z coordinate of the entity.

Returns: The z coordinate of the entity.

script.zs
// LightningBolt.z() as double;
myLightningBolt.z();

Return Type: double

Previous
FallingBlockEntity Mob
Next