EffectData
Link to effectdata
Holds the data an MCPotionEffect should have to pass a parent predicate check.
This predicate can check various properties of the effect, such as its duration or amplifier value. It is also able to verify whether the effect has been applied by the ambient or by a potion and whether the effect has visible particles or not.
By default, no restrictions are placed on the effect's data.
导入类
Link to 导入类
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 Copyimport crafttweaker.api.predicate.EffectData;
Extending AnyDefaultingVanillaWrappingPredicate
Link to extending-anydefaultingvanillawrappingpredicate
EffectData extends AnyDefaultingVanillaWrappingPredicate. That means all methods available in AnyDefaultingVanillaWrappingPredicate are also available in EffectData
使用方式
Link to 使用方式
Name: withAmbient
Indicates that the effect must be environmental.
An example of such effect is the one applied by a beacon.
If the predicate had already been set to check the opposite condition, the setting will be overwritten.
Returns: This predicate for chaining.
Return Type: EffectData
ZenScript Copy// EffectData.withAmbient() as EffectData
myEffectData.withAmbient();
Name: withBoundedAmplifier
Sets both the minimum and maximum value the amplifier should be to min
and max
respectively.
If the amplifier had already some bounds specified, then they will be overwritten with the new values.
Both minimum and maximum values are inclusive, meaning that a value that is equal to either min
or
max
will pass the check.
Returns: This predicate for chaining.
Return Type: EffectData
ZenScript CopyEffectData.withBoundedAmplifier(min as int, max as int) as EffectData
参数 | 类型 | 描述 |
---|---|---|
参数 min | 类型 int | 描述 The minimum value the amplifier should be. |
参数 max | 类型 int | 描述 The maximum value the amplifier should be. |
Name: withBoundedDuration
Sets both the minimum and maximum value the duration should be to min
and max
respectively.
If the duration had already some bounds specified, then they will be overwritten with the new values.
Both minimum and maximum values are inclusive, meaning that a value that is equal to either min
or
max
will pass the check.
Returns: This predicate for chaining.
Return Type: EffectData
ZenScript CopyEffectData.withBoundedDuration(min as int, max as int) as EffectData
参数 | 类型 | 描述 |
---|---|---|
参数 min | 类型 int | 描述 The minimum value the duration should be. |
参数 max | 类型 int | 描述 The maximum value the duration should be. |
Name: withExactAmplifier
Sets the amplifier to exactly match the given value
.
If the amplifier had already some bounds specified, then they will be overwritten with the new value.
Returns: This predicate for chaining.
Return Type: EffectData
ZenScript CopyEffectData.withExactAmplifier(value as int) as EffectData
参数 | 类型 | 描述 |
---|---|---|
参数 value | 类型 int | 描述 The exact value the amplifier should be. |
Name: withExactDuration
Sets the duration to exactly match the given value
.
If the duration had already some bounds specified, then they will be overwritten with the new value.
Returns: This predicate for chaining.
Return Type: EffectData
ZenScript CopyEffectData.withExactDuration(value as int) as EffectData
参数 | 类型 | 描述 |
---|---|---|
参数 value | 类型 int | 描述 The exact value the duration should be. |
Name: withInvisibility
Indicates that the effect's particles must be invisible.
If the predicate had already been set to check the opposite condition, the setting will be overwritten.
Returns: This predicate for chaining.
Return Type: EffectData
ZenScript Copy// EffectData.withInvisibility() as EffectData
myEffectData.withInvisibility();
Name: withMaximumAmplifier
Sets the maximum value the amplifier should be to max
.
If the amplifier had already some bounds specified, then the maximum value of the bound will be overwritten with the value specified in max
. On the other hand, if the amplifier didn't have any bounds set, the maximum is set, leaving the lower end unbounded.
The maximum value is inclusive, meaning that a value that is equal to max
will pass the check.
Returns: This predicate for chaining.
Return Type: EffectData
ZenScript CopyEffectData.withMaximumAmplifier(max as int) as EffectData
参数 | 类型 | 描述 |
---|---|---|
参数 max | 类型 int | 描述 The maximum value the amplifier should be. |
Name: withMaximumDuration
Sets the maximum value the duration should be to max
.
If the duration had already some bounds specified, then the maximum value of the bound will be overwritten with the value specified in max
. On the other hand, if the duration didn't have any bounds set, the maximum is set, leaving the lower end unbounded.
The maximum value is inclusive, meaning that a value that is equal to max
will pass the check.
Returns: This predicate for chaining.
Return Type: EffectData
ZenScript CopyEffectData.withMaximumDuration(max as int) as EffectData
参数 | 类型 | 描述 |
---|---|---|
参数 max | 类型 int | 描述 The maximum value the duration should be. |
Name: withMinimumAmplifier
Sets the minimum value the amplifier should be to min
.
If the amplifier had already some bounds specified, then the minimum value of the bound will be overwritten with the value specified in min
. On the other hand, if the amplifier didn't have any bounds set, the minimum is set, leaving the upper end unbounded.
The minimum value is inclusive, meaning that a value that is equal to min
will pass the check.
Returns: This predicate for chaining.
Return Type: EffectData
ZenScript CopyEffectData.withMinimumAmplifier(min as int) as EffectData
参数 | 类型 | 描述 |
---|---|---|
参数 min | 类型 int | 描述 The minimum value the amplifier should be. |
Name: withMinimumDuration
Sets the minimum value the duration should be to min
.
If the duration had already some bounds specified, then the minimum value of the bound will be overwritten with the value specified in min
. On the other hand, if the duration didn't have any bounds set, the minimum is set, leaving the upper end unbounded.
The minimum value is inclusive, meaning that a value that is equal to min
will pass the check.
Returns: This predicate for chaining.
Return Type: EffectData
ZenScript CopyEffectData.withMinimumDuration(min as int) as EffectData
参数 | 类型 | 描述 |
---|---|---|
参数 min | 类型 int | 描述 The minimum value the duration should be. |
Name: withVisibility
Indicates that the effect's particles must be visible.
If the predicate had already been set to check the opposite condition, the setting will be overwritten.
Returns: This predicate for chaining.
Return Type: EffectData
ZenScript Copy// EffectData.withVisibility() as EffectData
myEffectData.withVisibility();
Name: withoutAmbient
Indicates that the effect must not be environmental.
If the predicate had already been set to check the opposite condition, the setting will be overwritten.
Returns: This predicate for chaining.
Return Type: EffectData
ZenScript Copy// EffectData.withoutAmbient() as EffectData
myEffectData.withoutAmbient();