Spawn Rules - Revision history

Hiroku: it's not a future feature anymore weee

2024-06-28T05:47:47Z

it's not a future feature anymore weee

← Older revision		Revision as of 05:47, 28 June 2024
Line 1:		Line 1:
	~~Coming in 1.5~~

	Spawn Rules are a datapack feature that allow addons to modify spawning behaviour in a global way. Spawn Rules contain a set of rule components, and there are several component types to choose from. Spawn rules are loaded from the `spawn_rules` folder.		Spawn Rules are a datapack feature that allow addons to modify spawning behaviour in a global way. Spawn Rules contain a set of rule components, and there are several component types to choose from. Spawn rules are loaded from the `spawn_rules` folder.

Patch Notes Guy: The example should probably be enabled

2023-12-23T05:10:06Z

The example should probably be enabled

← Older revision		Revision as of 05:10, 23 December 2023
Line 79:		Line 79:
	{		{
	"displayName": "Pikachu Daylight Multiplier - (Example file)",		"displayName": "Pikachu Daylight Multiplier - (Example file)",
	"enabled": "~~false~~",		"enabled": "true",
	"components": [		"components": [
	{		{

Patch Notes Guy: More formatting improvements

2023-12-23T05:05:57Z

More formatting improvements

← Older revision		Revision as of 05:05, 23 December 2023
Line 10:		Line 10:
	"contextSelector": "v.context.light > 8",		"contextSelector": "v.context.light > 8",
	"weight": "v.weight * 20"		"weight": "v.weight * 20"
	}

	"filter":		"filter":
Line 19:		Line 19:
	"contextSelector": "v.context.light < 8",		"contextSelector": "v.context.light < 8",
	"allow": "false"		"allow": "false"
	}

	"location":		"location":
Line 26:		Line 26:
	"type": "location",		"type": "location",
	"allow": "v.y > 100 \|\| v.world.is_of('minecraft:overworld')"		"allow": "v.y > 100 \|\| v.world.is_of('minecraft:overworld')"
	}


	Spawn Detail Properties		Spawn Detail Properties
	Every spawn detail that is made available under the name "spawn" has properties that can be checked in your spawn rule components.		Every spawn detail that is made available under the name "spawn" has properties that can be checked in your spawn rule components.
	- "weight": The base weight of the spawn.		* "weight": The base weight of the spawn.
	- "percentage": The base percentage spawn chance (usually null)		* "percentage": The base percentage spawn chance (usually null)
	- "id": The unique ID of the spawn.		* "id": The unique ID of the spawn.
	- "bucket": The bucket of the spawn.		* "bucket": The bucket of the spawn.
	- "width": The specified width required for spawning.		* "width": The specified width required for spawning.
	- "height": The specified height required for spawning.		* "height": The specified height required for spawning.
	- "context": The context type of the spawn.		* "context": The context type of the spawn.
	- "labels": A list of label strings.		* "labels": A list of label strings.


	Pokémon Spawn Detail Properties		Pokémon Spawn Detail Properties
	Pokémon spawn details have more properties than the general spawn detail.		Pokémon spawn details have more properties than the general spawn detail.
	- "pokemon": The specified Pokémon as a variable. This is what was specified in the file.		* "pokemon": The specified Pokémon as a variable. This is what was specified in the file.


	Pokémon Properties		Pokémon Properties
	Pokémon Properties referenced from MoLang expressions have many properties.		Pokémon Properties referenced from MoLang expressions have many properties.
	- "species": The species of the Pokémon, such as cobblemon:bulbasaur, if set.		* "species": The species of the Pokémon, such as cobblemon:bulbasaur, if set.
	- "level": The level of the Pokémon, if set.		* "level": The level of the Pokémon, if set.
	- "shiny": True or false depending on if the Pokémon is explicitly marked as either. It can be null.		* "shiny": True or false depending on if the Pokémon is explicitly marked as either. It can be null.
	- "gender": The gender name, if set.		* "gender": The gender name, if set.
	- "friendship": The friendship value of the Pokémon, if set.		* "friendship": The friendship value of the Pokémon, if set.


	Location properties		Location properties
	When using the "location" rule component, many variables are supplied.		When using the "location" rule component, many variables are supplied.
	- "x": The x coordinate being checked.		* "x": The x coordinate being checked.
	- "y": The y coordinate being checked.		* "y": The y coordinate being checked.
	- "z": The z coordinate being checked.		* "z": The z coordinate being checked.
	- "context": The context type being checked, such as "grounded" or "seafloor".		* "context": The context type being checked, such as "grounded" or "seafloor".
	- "world": The world it's in. This contains two functions, is_of and is_in for checking the ID or if it fits a specific tag, respectively. For example, v.world.is_in('yourmod:your_world_tag').		* "world": The world it's in. This contains two functions, is_of and is_in for checking the ID or if it fits a specific tag, respectively. For example, v.world.is_in('yourmod:your_world_tag').
	- "dimension_type": The dimension it's in. This contains the same two functions as the "world" property.		* "dimension_type": The dimension it's in. This contains the same two functions as the "world" property.


	Context properties		Context properties
	When using a context selector, a context will be added as a variable and it contains many variables.		When using a context selector, a context will be added as a variable and it contains many variables.
	- "light": The light level, from 0 to 15.		* "light": The light level, from 0 to 15.
	- "x": The x coordinate.		* "x": The x coordinate.
	- "y": The y coordinate.		* "y": The y coordinate.
	- "z": The z coordinate.		* "z": The z coordinate.
	- "moon_phase": The phase of the moon, between 0 and 7 inclusive.		* "moon_phase": The phase of the moon, between 0 and 7 inclusive.
	- "world": The world of the context, in the same format in the "location" properties.		* "world": The world of the context, in the same format in the "location" properties.
	- "biome": The biome of the context. This, like world and dimension type, contains two functions: is_of and is_in.		* "biome": The biome of the context. This, like world and dimension type, contains two functions: is_of and is_in.


Line 94:		Line 98:
	}		}
	]		]
	}

Patch Notes Guy: Some formatting improvements

2023-12-23T05:03:58Z

Some formatting improvements

Patch Notes Guy: Rough draft of spawn rules.

2023-12-23T05:02:35Z

Rough draft of spawn rules.

New page

Coming in 1.5

Spawn Rules are a datapack feature that allow addons to modify spawning behaviour in a global way. Spawn Rules contain a set of rule components, and there are several component types to choose from. Spawn rules are loaded from the `spawn_rules` folder.

"weight":
The weight rule component allows you to selectively modify the weight of spawn details as they are used. For example, you can make the weight of a Pikachu spawn in an area that is well lit to be multiplied by 20.
{
"type": "weight",
"spawnSelector": "v.spawn.pokemon.species == 'pikachu'",
"contextSelector": "v.context.light > 8",
"weight": "v.weight * 20"
}

"filter":
The filter rule component allows you to block or allow spawns. This is like adding a global rule against spawning. For example, you can make Pikachu unable to spawn in an area that is not well lit.
{
"type": "filter",
"spawnSelector": "v.spawn.pokemon.species == 'pikachu'",
"contextSelector": "v.context.light < 8",
"allow": "false"
}

"location":
The location rule component allows you to block or allow locations to be considered for any spawning. This is more aggressive than the filter rule component because it cancels the spawning process much sooner. This is best used to create no-spawn zones.
{
"type": "location",
"allow": "v.y > 100 || v.world.is_of('minecraft:overworld')"
}

Spawn Detail Properties
Every spawn detail that is made available under the name "spawn" has properties that can be checked in your spawn rule components.
"weight": The base weight of the spawn.
"percentage": The base percentage spawn chance (usually null)
"id": The unique ID of the spawn.
"bucket": The bucket of the spawn.
"width": The specified width required for spawning.
"height": The specified height required for spawning.
"context": The context type of the spawn.
"labels": A list of label strings.

Pokémon Spawn Detail Properties
Pokémon spawn details have more properties than the general spawn detail.
"pokemon": The specified Pokémon as a variable. This is what was specified in the file.

Pokémon Properties
Pokémon Properties referenced from MoLang expressions have many properties.
"species": The species of the Pokémon, such as cobblemon:bulbasaur, if set.
"level": The level of the Pokémon, if set.
"shiny": True or false depending on if the Pokémon is explicitly marked as either. It can be null.
"gender": The gender name, if set.
"friendship": The friendship value of the Pokémon, if set.

Location properties
When using the "location" rule component, many variables are supplied.
"x": The x coordinate being checked.
"y": The y coordinate being checked.
"z": The z coordinate being checked.
"context": The context type being checked, such as "grounded" or "seafloor".
"world": The world it's in. This contains two functions, is_of and is_in for checking the ID or if it fits a specific tag, respectively. For example, v.world.is_in('yourmod:your_world_tag').
"dimension_type": The dimension it's in. This contains the same two functions as the "world" property.

Context properties
When using a context selector, a context will be added as a variable and it contains many variables.
"light": The light level, from 0 to 15.
"x": The x coordinate.
"y": The y coordinate.
"z": The z coordinate.
"moon_phase": The phase of the moon, between 0 and 7 inclusive.
"world": The world of the context, in the same format in the "location" properties.
"biome": The biome of the context. This, like world and dimension type, contains two functions: is_of and is_in.

Example (weird) spawn rule:
{
"displayName": "Pikachu Daylight Multiplier - (Example file)",
"enabled": "false",
"components": [
{
"type": "weight",
"spawnSelector": "v.spawn.pokemon.species == 'pikachu'",
"contextSelector": "v.context.light > 8",
"weight": "v.weight * 20"
},
{
"type": "filter",
"spawnSelector": "v.spawn.pokemon.species == 'pikachu'",
"contextSelector": "v.context.light < 8",
"allow": "false"
},
{
"type": "location",
"allow": "v.y > 100 || v.world.is_of('minecraft:overworld')"
}
]
}

← Older revision		Revision as of 05:03, 23 December 2023
Line 31:		Line 31:
	Spawn Detail Properties		Spawn Detail Properties
	Every spawn detail that is made available under the name "spawn" has properties that can be checked in your spawn rule components.		Every spawn detail that is made available under the name "spawn" has properties that can be checked in your spawn rule components.
	"weight": The base weight of the spawn.		- "weight": The base weight of the spawn.
	"percentage": The base percentage spawn chance (usually null)		- "percentage": The base percentage spawn chance (usually null)
	"id": The unique ID of the spawn.		- "id": The unique ID of the spawn.
	"bucket": The bucket of the spawn.		- "bucket": The bucket of the spawn.
	"width": The specified width required for spawning.		- "width": The specified width required for spawning.
	"height": The specified height required for spawning.		- "height": The specified height required for spawning.
	"context": The context type of the spawn.		- "context": The context type of the spawn.
	"labels": A list of label strings.		- "labels": A list of label strings.

	Pokémon Spawn Detail Properties		Pokémon Spawn Detail Properties
	Pokémon spawn details have more properties than the general spawn detail.		Pokémon spawn details have more properties than the general spawn detail.
	"pokemon": The specified Pokémon as a variable. This is what was specified in the file.		- "pokemon": The specified Pokémon as a variable. This is what was specified in the file.

	Pokémon Properties		Pokémon Properties
	Pokémon Properties referenced from MoLang expressions have many properties.		Pokémon Properties referenced from MoLang expressions have many properties.
	"species": The species of the Pokémon, such as cobblemon:bulbasaur, if set.		- "species": The species of the Pokémon, such as cobblemon:bulbasaur, if set.
	"level": The level of the Pokémon, if set.		- "level": The level of the Pokémon, if set.
	"shiny": True or false depending on if the Pokémon is explicitly marked as either. It can be null.		- "shiny": True or false depending on if the Pokémon is explicitly marked as either. It can be null.
	"gender": The gender name, if set.		- "gender": The gender name, if set.
	"friendship": The friendship value of the Pokémon, if set.		- "friendship": The friendship value of the Pokémon, if set.

	Location properties		Location properties
	When using the "location" rule component, many variables are supplied.		When using the "location" rule component, many variables are supplied.
	"x": The x coordinate being checked.		- "x": The x coordinate being checked.
	"y": The y coordinate being checked.		- "y": The y coordinate being checked.
	"z": The z coordinate being checked.		- "z": The z coordinate being checked.
	"context": The context type being checked, such as "grounded" or "seafloor".		- "context": The context type being checked, such as "grounded" or "seafloor".
	"world": The world it's in. This contains two functions, is_of and is_in for checking the ID or if it fits a specific tag, respectively. For example, v.world.is_in('yourmod:your_world_tag').		- "world": The world it's in. This contains two functions, is_of and is_in for checking the ID or if it fits a specific tag, respectively. For example, v.world.is_in('yourmod:your_world_tag').
	"dimension_type": The dimension it's in. This contains the same two functions as the "world" property.		- "dimension_type": The dimension it's in. This contains the same two functions as the "world" property.

	Context properties		Context properties
	When using a context selector, a context will be added as a variable and it contains many variables.		When using a context selector, a context will be added as a variable and it contains many variables.
	"light": The light level, from 0 to 15.		- "light": The light level, from 0 to 15.
	"x": The x coordinate.		- "x": The x coordinate.
	"y": The y coordinate.		- "y": The y coordinate.
	"z": The z coordinate.		- "z": The z coordinate.
	"moon_phase": The phase of the moon, between 0 and 7 inclusive.		- "moon_phase": The phase of the moon, between 0 and 7 inclusive.
	"world": The world of the context, in the same format in the "location" properties.		- "world": The world of the context, in the same format in the "location" properties.
	"biome": The biome of the context. This, like world and dimension type, contains two functions: is_of and is_in.		- "biome": The biome of the context. This, like world and dimension type, contains two functions: is_of and is_in.