Version:

Language:

DamageSourcePredicate

Represents a predicate for a DamageSource.

The predicate can be used to match against a various set of types that identify the damage source type and characteristics, such as being caused by magic or bypassing invulnerability. Moreover, the predicate can also check for specific properties of the entity that caused the damage or the direct entity (refer to TargetedEntity for the semantic difference), via EntityPredicates.

By default, any damage source will pass this predicate's checks.

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.predicate.DamageSourcePredicate;

Extending AnyDefaultingVanillaWrappingPredicate

DamageSourcePredicate extends AnyDefaultingVanillaWrappingPredicate. That means all methods available in AnyDefaultingVanillaWrappingPredicate are also available in DamageSourcePredicate

Methods

withArmorBypass

Name: withArmorBypass

Indicates that the damage source must be able to bypass armor protection (for example, suffocation)

If the predicate had already been set to check the opposite condition, the setting will be overwritten.

Returns: This predicate for chaining.
Return Type: DamageSourcePredicate

ZenScript
 Copy
// DamageSourcePredicate.withArmorBypass() as DamageSourcePredicate

myDamageSourcePredicate.withArmorBypass();

withDirectEntityPredicate

Name: withDirectEntityPredicate

Creates and sets the EntityPredicate that will be used to check the entity that directly caused damage.

For the specific semantic meaning, refer to TargetedEntity.

Any changes that have been made to the entity predicate previously, if any, will be discarded.

Returns: This predicate for chaining.
Return Type: DamageSourcePredicate

ZenScript
 Copy
DamageSourcePredicate.withDirectEntityPredicate(builder as Consumer<EntityPredicate>) as DamageSourcePredicate

Parameter	Type	Description
Parameter constructor	Type Consumer<EntityPredicate>	Description A consumer used to configure the EntityPredicate.

withExplosionSource

Name: withExplosionSource

Indicates that the damage must have been caused by an explosion.

If the predicate had already been set to check the opposite condition, the setting will be overwritten.

Returns: This predicate for chaining.
Return Type: DamageSourcePredicate

ZenScript
 Copy
// DamageSourcePredicate.withExplosionSource() as DamageSourcePredicate

myDamageSourcePredicate.withExplosionSource();

withFireSource

Name: withFireSource

Indicates that the damage must have been caused by fire.

If the predicate had already been set to check the opposite condition, the setting will be overwritten.

Returns: This predicate for chaining.
Return Type: DamageSourcePredicate

ZenScript
 Copy
// DamageSourcePredicate.withFireSource() as DamageSourcePredicate

myDamageSourcePredicate.withFireSource();

withInvulnerabilityBypass

Name: withInvulnerabilityBypass

Indicates that the damage source must be able to bypass invulnerability (for example, void damage).

If the predicate had already been set to check the opposite condition, the setting will be overwritten.

Returns: This predicate for chaining.
Return Type: DamageSourcePredicate

ZenScript
 Copy
// DamageSourcePredicate.withInvulnerabilityBypass() as DamageSourcePredicate

myDamageSourcePredicate.withInvulnerabilityBypass();

withLightningSource

Name: withLightningSource

Indicates that the damage must have been caused by a lightning strike.

If the predicate had already been set to check the opposite condition, the setting will be overwritten.

Returns: This predicate for chaining.
Return Type: DamageSourcePredicate

ZenScript
 Copy
// DamageSourcePredicate.withLightningSource() as DamageSourcePredicate

myDamageSourcePredicate.withLightningSource();

withMagicBypass

Name: withMagicBypass

Indicates that the damage source must be able to bypass magic protection (for example, starvation).

If the predicate had already been set to check the opposite condition, the setting will be overwritten.

Returns: This predicate for chaining.
Return Type: DamageSourcePredicate

ZenScript
 Copy
// DamageSourcePredicate.withMagicBypass() as DamageSourcePredicate

myDamageSourcePredicate.withMagicBypass();

withMagicSource

Name: withMagicSource

Indicates that the damage must have been caused by magic sources.

If the predicate had already been set to check the opposite condition, the setting will be overwritten.

Returns: This predicate for chaining.
Return Type: DamageSourcePredicate

ZenScript
 Copy
// DamageSourcePredicate.withMagicSource() as DamageSourcePredicate

myDamageSourcePredicate.withMagicSource();

withProjectileSource

Name: withProjectileSource

Indicates that the damage must have been caused by a projectile.

If the predicate had already been set to check the opposite condition, the setting will be overwritten.

Returns: This predicate for chaining.
Return Type: DamageSourcePredicate

ZenScript
 Copy
// DamageSourcePredicate.withProjectileSource() as DamageSourcePredicate

myDamageSourcePredicate.withProjectileSource();

withSourceEntityPredicate

Name: withSourceEntityPredicate

Creates and sets the EntityPredicate that will be used to check the entity that caused damage.

For the specific semantic meaning, refer to TargetedEntity.

Any changes that have been made to the entity predicate previously, if any, will be discarded.

Returns: This predicate for chaining.
Return Type: DamageSourcePredicate

ZenScript
 Copy
DamageSourcePredicate.withSourceEntityPredicate(builder as Consumer<EntityPredicate>) as DamageSourcePredicate

Parameter	Type	Description
Parameter constructor	Type Consumer<EntityPredicate>	Description A consumer used to configure the EntityPredicate.

withoutArmorBypass

Name: withoutArmorBypass

Indicates that the damage source must not be able to bypass armor protection.

If the predicate had already been set to check the opposite condition, the setting will be overwritten.

Returns: This predicate for chaining.
Return Type: DamageSourcePredicate

ZenScript
 Copy
// DamageSourcePredicate.withoutArmorBypass() as DamageSourcePredicate

myDamageSourcePredicate.withoutArmorBypass();

withoutExplosionSource

Name: withoutExplosionSource

Indicates that the damage must not have been caused by an explosion.

If the predicate had already been set to check the opposite condition, the setting will be overwritten.

Returns: This predicate for chaining.
Return Type: DamageSourcePredicate

ZenScript
 Copy
// DamageSourcePredicate.withoutExplosionSource() as DamageSourcePredicate

myDamageSourcePredicate.withoutExplosionSource();

withoutFireSource

Name: withoutFireSource

Indicates that the damage must not have been caused by fire.

If the predicate had already been set to check the opposite condition, the setting will be overwritten.

Returns: This predicate for chaining.
Return Type: DamageSourcePredicate

ZenScript
 Copy
// DamageSourcePredicate.withoutFireSource() as DamageSourcePredicate

myDamageSourcePredicate.withoutFireSource();

withoutInvulnerabilityBypass

Name: withoutInvulnerabilityBypass

Indicates that the damage source must not be able to bypass invulnerability.

If the predicate had already been set to check the opposite condition, the setting will be overwritten.

Returns: This predicate for chaining.
Return Type: DamageSourcePredicate

ZenScript
 Copy
// DamageSourcePredicate.withoutInvulnerabilityBypass() as DamageSourcePredicate

myDamageSourcePredicate.withoutInvulnerabilityBypass();

withoutLightningSource

Name: withoutLightningSource

Indicates that the damage must not have been caused by a lightning strike.

If the predicate had already been set to check the opposite condition, the setting will be overwritten.

Returns: This predicate for chaining.
Return Type: DamageSourcePredicate

ZenScript
 Copy
// DamageSourcePredicate.withoutLightningSource() as DamageSourcePredicate

myDamageSourcePredicate.withoutLightningSource();

withoutMagicBypass

Name: withoutMagicBypass

Indicates that the damage source must not be able to bypass magic protection.

If the predicate had already been set to check the opposite condition, the setting will be overwritten.

Returns: This predicate for chaining.
Return Type: DamageSourcePredicate

ZenScript
 Copy
// DamageSourcePredicate.withoutMagicBypass() as DamageSourcePredicate

myDamageSourcePredicate.withoutMagicBypass();

withoutMagicSource

Name: withoutMagicSource

Indicates that the damage must not have been caused by magic sources.

If the predicate had already been set to check the opposite condition, the setting will be overwritten.

Returns: This predicate for chaining.
Return Type: DamageSourcePredicate

ZenScript
 Copy
// DamageSourcePredicate.withoutMagicSource() as DamageSourcePredicate

myDamageSourcePredicate.withoutMagicSource();

withoutProjectileSource

Name: withoutProjectileSource

Indicates that the damage must not have been caused by a projectile.

If the predicate had already been set to check the opposite condition, the setting will be overwritten.

Returns: This predicate for chaining.
Return Type: DamageSourcePredicate

ZenScript
 Copy
// DamageSourcePredicate.withoutProjectileSource() as DamageSourcePredicate

myDamageSourcePredicate.withoutProjectileSource();