SummoningInfo
Link to summoninginfo
This class was added by a mod with mod-id zensummoning. So you need to have this mod installed if you want to use this feature.
Importing the class
Link to 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 Copyimport mods.zensummoning.SummoningInfo;
Static Methods
Link to static-methods
Name: create
Creates a new SummoningInfo with default values.
See other methods for adding more customization.
Same as constructor.
Returns: new info
Return Type: SummoningInfo
ZenScript Copy// SummoningInfo.create() as SummoningInfo
SummoningInfo.create();
Constructors
Link to constructors
No Description Provided
ZenScript Copynew SummoningInfo() as SummoningInfo
new SummoningInfo();
Methods
Link to methods
Name: addCondition
Adds an additional condition for the summoning to work. This can be used to require a gamestage (or deny one I guess)
Return Type: SummoningInfo
ZenScript Copy// SummoningInfo.addCondition(condition as Predicate<SummoningAttempt>, failureMessage as string, jeiDescription as string) as SummoningInfo
mySummoningInfo.addCondition(Predicate for summoning to succeed, Chat message to show on failure, Line to show in JEI preview);
| Parameter | Type | Description |
|---|---|---|
Parameter condition | Type Predicate<SummoningAttempt> | Description condition |
Parameter failureMessage | Type string | Description chat message on failure |
Parameter jeiDescription | Type string | Description No Description Provided |
Name: addMob
Adds a new mob to the summoning. Returns itself for builder pattern.
Return Type: SummoningInfo
ZenScript Copy// SummoningInfo.addMob(info as MobInfo) as SummoningInfo
mySummoningInfo.addMob(MobInfo.create().setMob("minecraft:zombie"));
| Parameter | Type | Description |
|---|---|---|
Parameter info | Type MobInfo | Description mob to add |
Name: setCatalyst
Sets the catalyst that will be used to start the ritual.
Return Type: SummoningInfo
ZenScript Copy// SummoningInfo.setCatalyst(ingredient as IIngredientWithAmount) as SummoningInfo
mySummoningInfo.setCatalyst(<item:minecraft:stick> * 2);
| Parameter | Type | Description |
|---|---|---|
Parameter ingredient | Type IIngredientWithAmount | Description catalyst |
Name: setConsumeCatalyst
Determines whether or not the catalyst will be consumed.
Return Type: SummoningInfo
ZenScript Copy// SummoningInfo.setConsumeCatalyst(value as boolean) as SummoningInfo
mySummoningInfo.setConsumeCatalyst(false);
| Parameter | Type | Description |
|---|---|---|
Parameter value | Type boolean | Description consumed |
Name: setMutator
Custom callback to determine if a summon should be allowed.
Return Type: SummoningInfo
ZenScript Copy// SummoningInfo.setMutator(mutator as Consumer<SummoningAttempt>) as SummoningInfo
mySummoningInfo.setMutator((attempt as SummoningAttempt) => {
if (attempt.world.raining) {
attempt.success = false;
attempt.message = "Can't summon this in the rain!";
} else {
attempt.message = "Good Luck!";
}
});
| Parameter | Type | Description |
|---|---|---|
Parameter mutator | Type Consumer<SummoningAttempt> | Description callback |
Name: setReagents
Sets the ingredients to be required to start the summon.
Return Type: SummoningInfo
ZenScript Copy// SummoningInfo.setReagents(reagents as IIngredientWithAmount[]) as SummoningInfo
mySummoningInfo.setReagents([<item:minecraft:stone>, <item:minecraft:egg>*12]);
| Parameter | Type | Description |
|---|---|---|
Parameter reagents | Type IIngredientWithAmount[] | Description ingredient list |
Name: setSound
Sets the sound played when a summon completes.
Return Type: SummoningInfo
ZenScript Copy// SummoningInfo.setSound(sound as string) as SummoningInfo
mySummoningInfo.setSound("entity.evoker.prepare_wololo");
| Parameter | Type | Description |
|---|---|---|
Parameter sound | Type string | Description sound resource location |
Name: setWeight
Sets the weight that this summoning has. Summonings with the same catalyst and reagents are determined randomly using this.
Return Type: SummoningInfo
ZenScript Copy// SummoningInfo.setWeight(weight as double) as SummoningInfo
mySummoningInfo.setWeight(3);
| Parameter | Type | Description |
|---|---|---|
Parameter weight | Type double | Description |