DamageSource - CraftTweaker Documentation

Version:

Language:

Home Migration Guide Getting Started With Scripts Commands Examples

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.util.DamageSource;

Methods

canBypassCreative

Name: canBypassCreative

Checks if the damage can bypass creative mode.

Returns: Whether or not the damage can bypass creative mode.
Return Type: boolean

ZenScript
 Copy
// DamageSource.canBypassCreative() as boolean

myDamageSource.canBypassCreative();

getDamageLocation

Name: getDamageLocation

Gets the location where the damage occurred.

Returns: The location of the damage.
Return Type: MCVector3d?

ZenScript
 Copy
// DamageSource.getDamageLocation() as MCVector3d?

myDamageSource.getDamageLocation();

getDamageType

Name: getDamageType

Gets the type of damage.

Returns: The type of damage.
Return Type: string

ZenScript
 Copy
// DamageSource.getDamageType() as string

myDamageSource.getDamageType();

getHungerDamage

Name: getHungerDamage

Gets the amount of exhaustion to add to the player's hunger bar if they get hit by this damage.

Returns: The amount of exhaustion to add to the player's hunger bar.
Return Type: float

ZenScript
 Copy
// DamageSource.getHungerDamage() as float

myDamageSource.getHungerDamage();

getImmediateSource

Name: getImmediateSource

Gets the immediate source of the damage, like an arrow.

Returns: The immediate source of the damage.
Return Type: MCEntity?

ZenScript
 Copy
// DamageSource.getImmediateSource() as MCEntity?

myDamageSource.getImmediateSource();

getTrueSource

Name: getTrueSource

Gets the true source of the damage, like the player who shot the arrow.

Returns: The true source of the damage.
Return Type: MCEntity?

ZenScript
 Copy
// DamageSource.getTrueSource() as MCEntity?

myDamageSource.getTrueSource();

isAbsoluteDamage

Name: isAbsoluteDamage

Checks if the damage is absolute.

Returns: Whether or not the damage is absolute.
Return Type: boolean

ZenScript
 Copy
// DamageSource.isAbsoluteDamage() as boolean

myDamageSource.isAbsoluteDamage();

isCreativePlayer

Name: isCreativePlayer

Gets whether the damage was inflicted by a creative player.

Returns: Whether the damage was inflicted by a creative player.
Return Type: boolean

ZenScript
 Copy
// DamageSource.isCreativePlayer() as boolean

myDamageSource.isCreativePlayer();

isDifficultyScaled

Name: isDifficultyScaled

Gets whether the damage changes strength based on the current difficulty.

Returns: Whether the damage changes strength according to difficulty.
Return Type: boolean

ZenScript
 Copy
// DamageSource.isDifficultyScaled() as boolean

myDamageSource.isDifficultyScaled();

isExplosionDamage

Name: isExplosionDamage

Checks if the damage is caused by an explosion.

Returns: Whether or not the damage is caused by an explosion.
Return Type: boolean

ZenScript
 Copy
// DamageSource.isExplosionDamage() as boolean

myDamageSource.isExplosionDamage();

isFireDamage

Name: isFireDamage

Checks if the damage is caused by fire or burning.

Returns: Whether or not the damage is caused by fire or burning.
Return Type: boolean

ZenScript
 Copy
// DamageSource.isFireDamage() as boolean

myDamageSource.isFireDamage();

isMagicDamage

Name: isMagicDamage

Checks if the damage is caused by magic.

Returns: Whether or not the damage is caused by magic.
Return Type: boolean

ZenScript
 Copy
// DamageSource.isMagicDamage() as boolean

myDamageSource.isMagicDamage();

isProjectileDamage

Name: isProjectileDamage

Checks if the damage is caused by a projectile.

Returns: Whether or not the damage is caused by a projectile.
Return Type: boolean

ZenScript
 Copy
// DamageSource.isProjectileDamage() as boolean

myDamageSource.isProjectileDamage();

isUnblockableDamage

Name: isUnblockableDamage

Checks if the damage can be blocked.

Returns: Whether or not the damage can be blocked.
Return Type: boolean

ZenScript
 Copy
// DamageSource.isUnblockableDamage() as boolean

myDamageSource.isUnblockableDamage();

Properties

Name	Type	Has Getter	Has Setter	Description
Name absolute	Type boolean	Has Getter true	Has Setter false	Description Checks if the damage is absolute.
Name bypassCreative	Type boolean	Has Getter true	Has Setter false	Description Checks if the damage can bypass creative mode.
Name creativePlayer	Type boolean	Has Getter true	Has Setter false	Description Gets whether the damage was inflicted by a creative player.
Name difficultyScaled	Type boolean	Has Getter true	Has Setter false	Description Gets whether the damage changes strength based on the current difficulty.
Name explosion	Type boolean	Has Getter true	Has Setter false	Description Checks if the damage is caused by an explosion.
Name fire	Type boolean	Has Getter true	Has Setter false	Description Checks if the damage is caused by fire or burning.
Name hungerDamage	Type float	Has Getter true	Has Setter false	Description Gets the amount of exhaustion to add to the player's hunger bar if they get hit by this damage.
Name immediateSource	Type MCEntity?	Has Getter true	Has Setter false	Description Gets the immediate source of the damage, like an arrow.
Name Localisation	Type MCVector3d?	Has Getter true	Has Setter false	Description Gets the location where the damage occurred.
Name magic	Type boolean	Has Getter true	Has Setter false	Description Checks if the damage is caused by magic.
Name projectile	Type boolean	Has Getter true	Has Setter false	Description Checks if the damage is caused by a projectile.
Name trueSource	Type MCEntity?	Has Getter true	Has Setter false	Description Gets the true source of the damage, like the player who shot the arrow.
Name type	Type string	Has Getter true	Has Setter false	Description Gets the type of damage.
Name unblockable	Type boolean	Has Getter true	Has Setter false	Description Checks if the damage can be blocked.