Cobblemon Wiki - User contributions [en]

Poser

2024-10-20T09:49:40Z

Patch Notes Guy: Fix typo

Under construction. Dont look or else!

{{TOC|right}}
== Preface ==
The new <code>poser</code> JSON controls all the animations of a Pokémon just as the old [[Poser]] did. It contains the same information for when the Pokémon will perform certain animations, but has received many requested upgrades. Some of these upgrades include multi-bone look animations, support for move animations, and even selecting from a pool of animations for quirks. Functionality of the new Poser will always be maintained and should let addon creators have the same options as the [https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/pokemon/gen1/SquirtleModel.kt hard-coded Kotlin Posers.]

== Poser Properties ==
Before breaking down each section of the new Poser file, let's take a look at all its different properties and how to use them. This section includes all of the different functions of the poser, any configurable options for said function, and how to write each function. You will notice that the poser now includes something in the format of <code>q.<function></code>. These are molang functions which allow you to do many new things. The q stands for query and its just part of the standard format for these new functions. Some functions can even go inside of other functions. It's not terribly complicated once you read what each one does. They allow addon creators to do many things they couldn't before!

=== Poses & Animations ===
There's a handful of Pose types and Animation types that you can make animations for. <code>Poses</code> are the states a Pokémon is in, like idle or moving. Poses are for assigning animations like your ground idles, ground walks, water idles, etc. The <code>animation types</code> are the different events in battles that you can assign animations to for each Pokémon. Animation types would include your faints, cries, and attack animations. Below is a list of currently available Animation types and Poses to choose from. 

==== Animations ====
* '''faint''': <code>animation.<pokemon>.faint</code> - The animation that plays when a Pokémon faints.
* '''cry''': <code>animation.<pokemon>.cry</code> - The animation that plays when a Pokémon is called out or when it starts battle.
* '''recoil''': <code>animation.<pokemon>.recoil</code> - The animation that plays when a Pokémon takes damage in battle.
* '''physical''': <code>animation.<pokemon>.physical</code> - The animation that plays when a Pokémon uses a physical move in battle.
* '''special''': <code>animation.<pokemon>.special</code> - The animation that plays when a Pokémon uses a special move in battle.
* '''status''': <code>animation.<pokemon>.status</code> - The animation that plays when a pokemon uses a status move in battle.

==== Poses ====
* '''"STAND"''': <code>animation.<pokemon>.ground_idle</code> - The animation that plays when a Pokémon is idle on land.
** This pose type is also used for battle-idles: <code>animation.<pokemon>.battle_idle</code>
* '''"PORTRAIT"''': <code>animation.<pokemon>.portrait</code> - The animation that plays in the Party Overlay, or left hand party GUI
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"PROFILE"''': <code>animation.<pokemon>.profile</code> - The animation that plays in the Party Menu, or when you press M.
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"WALK"''': <code>animation.<pokemon>.ground_walk</code> - The animation that plays when a Pokémon is moving on land
* '''"HOVER"''': <code>animation.<pokemon>.air_idle</code> - The animation that plays when a Pokémon is idle in the air.
* '''"FLY"''': <code>animation.<pokemon>.air_fly</code> - The animation that plays when a Pokémon is moving in the air.
* '''"FLOAT"''': <code>animation.<pokemon>.water_idle</code> - The animation that plays when a Pokémon is idle in or on water.
* '''"SWIM"''': <code>animation.<pokemon>.water_swim</code> - The animation that plays when a Pokémon is moving in or on water.
* '''"SLEEP"''': <code>animation.<pokemon>.sleep</code> - The animation that plays when a Pokémon is asleep. Usually on land.
* '''"SHOULDER_LEFT"''': <code>animation.<pokemon>.shoulder_left</code> - The animation that plays when the Pokémon is on the player's left shoulder.
* '''"SHOULDER_RIGHT"''': <code>animation.<pokemon>.shoulder_right</code> - The animation that plays when the Pokémon is on the player's right shoulder.

==== q.bedrock_stateful ====
The function <code>q.bedrock_stateful()</code> allows you to assign a stateful animation to an animation type. <code>Stateful animations</code> are meant to animate just a few bones of the Pokémon and get overlaid on the current pose. An example would be cries only animating the mouth or head of the Pokémon. A stateful animation won't take control of the whole model to play its animation.


Here is an example of the 2 stateful animations, cry and recoil, in the poser:
"cry": "q.bedrock_stateful('blastoise', 'cry')",
"recoil": "q.bedrock_stateful('blastoise', 'recoil')",


==== q.bedrock_primary ====
The function <code>q.bedrock_primary()</code> allows you to assign a primary animation to an animation type. <code>Primary animations</code> are meant to take control of the entire model to play its animation and will clear any previous animations it was doing. An example would be a Pokémon's physical attack animation. When a Pokémon uses a physical move, it should clear the battle idle animation and play its physical animation instead. These animations often move the whole body and many of its limbs. When the physical animation is done, it returns control of the model to the battle idle after the physical animation has finished and should play a short transition animation in between.


Since Primary animations behave in a similar way to swapping poses, they can use special transition animation types via the <code>q.curve</code> property written within its sub properties. These provide different types of smoothness to the interpolation and will be explained in the next section.


Below is an example of the 4 primary animation in the poser:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('blastoise', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('blastoise', 'status', q.curve('symmetrical_wide'))"


==== q.curve ====
The function <code>q.curve()</code> is a sub function for <code>q.bedrock_primary()</code> which allows the animation to interpolate back into the main pose. This allows the transition between animations to behave similarly to linear keyframes and smooth keyframes when animating.


The q.curve function comes with 3 options for now which are:
* <code>one</code>: Does not interpolate at all. Just jumps from one animation to the next. Preferred for faint animations.
* <code>symmetric</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench. Not preferable, but is an option.
* <code>symmetrical_wide</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench, but with a wider margin. The preferred choice when transitioning from moves.

Below is an example of the 2 main q.curve types:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",

==== q.bedrock ====
The <code>q.bedrock()</code> function is the familiar animation format from the [[Poser | old poser]] which got converted into a molang function. It's the same thing as before, just in a new look. You are still just listing your Pokémon and then the animation in the parenthesis. This function is mainly used to assign poses their animations. These animations are meant to be overwritten by Primary or Stateful animations whenever convenient.
Below is an example of the <code>q.bedrock</code> function assigning a walk animation to the <code>"WALK"</code> pose type:
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.bedrock('blastoise', 'ground_walk')"
]
},

=== Portraits and Profiles & Scale and Translation ===
Portrait and Profile are the poses that are used when rendering any Pokémon in a GUI or Menu. Portrait is used for the left hand party screen, or Party Overlay, and Profile is used for the Party Menu. The poser file assigns some <code>Scale</code> and <code>Translation</code> values to these poses which control the camera location for rendering the Pokémon. There is a dev tool that you can enable in the [[Config]] which allows you to use some customizable keys to move the camera around the Pokémon in these menus. This tool will print the Scale and Translation values when the associated hotkey is pressed. 

<code>Translation</code> values control the location of the camera for the Portrait or Profile. Translation is a set of 3 values which represent xyz coordinates. You will mainly be changing the first 2 values, or the x and y axis values. X for left and right, and Y for up and down. The Z value is rarely used, but is important for really big models that are not being fully rendered in the menus. It often needs a larger Z value.

<code>Scale</code> values control the amount of zoom for the Portrait or Profile. A value less than one should make it zoom out and a value greater than one will zoom in. Sometimes with larger models, the camera cannot render the whole Pokémon no matter how far you zoom out. The back side of the Pokémon may not be rendered. This means you need to increase the Translation z value.

Below is a short breakdown of the previously mentioned properties:
"<abbr title="This property controls the size of the Pokémon in the party menu on the left side of the screen. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitScale</abbr>": 1.65,
"<abbr title="This property controls the location of the Pokémon in the party menu on the left side of the screen. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitTranslation</abbr>": [0, -0.6, 0],
"<abbr title="These refer to the full body view of the Pokémon seen in GUI, but most notably the summary UI. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">profileScale</abbr>": 1,
"<abbr title="This property controls the location of the Pokémon seen in GUI, but most notably the summary UI. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick
edits.)">profileTranslation</abbr>": [0, 0.15, 0],


=== Conditions ===
You can expand the amount of animations a Pokémon can have and when they should be played by using <code>conditions</code>. Conditions are what allow for battle animations despite the <code>standing</code> and <code>battle-idle</code> poses both using the <code>"STAND"</code> pose type. Typically, if you want different animations using the same pose types, then you must set one pose's condition to true, and the other pose's matching condition to false. You can mix and match these conditions to make something like an animation that only plays in battle, if it is raining while the sun is setting. 

List of Currently Implemented Conditions:
* <code>"isBattle"</code>: The Pokémon must be in a battle.
* <code>"isTouchingWater"</code>: The Pokémon must be touching water. Not necessarily underwater.
* <code>"isTouchingWaterOrRain"</code>: The Pokémon must be touching water or rain. Again, not necessarily underwater.
* <code>"isSubmergedInWater"</code>: The Pokémon must be underwater. The red line on the hitbox must be below the surface.
* <code>"isStandingOnRedSand"</code>: The Pokémon must be standing on red sand.
* <code>"isStandingOnSand"</code>: The Pokémon must be standing on sand
* <code>"isStandingOnSandOrRedSand"</code>: The Pokémon must be standing on either sand or red sand.
* <code>"isDusk"</code>: It must be "Dusk" time in the world, or roughly at sunset.

Below is an example of 2 poses using the <code>"STAND"</code> pose type and <code>Conditions</code> to separate the battle-idle animation from the ground idle animation:
* In these scenarios, you want one pose to have the condition set to true, and any other pose that shares the same pose type to have the condition set to false.
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.bedrock('blastoise', 'battle_idle')"
]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.bedrock('blastoise', 'ground_idle')"
]
},


=== Transformed Parts ===
This function allows you to transform parts of the model when the Pokémon is in a certain pose. You can change the location, rotation, and visibility of bones for each pose. This allows you to make some slight adjustments to an in-game animation without having to edit the animation itself. While there aren't many examples of this function, it's most common use is to hide model parts when a Pokémon is not in its battle idle. This is the case with Rillaboom and its drum.

A great use for location and rotation transformation is to adjust shoulder animations. You don't have to account for the model location on the player shoulder when making the animation. If it doesn't line up in the game, you can move the whole model using this function.

The visibility transformation allows you to hide a specific bone in the model when the Pokémon is currently in a pose. This can be used to hide certain bones if needed. This allows you to do things like making Rillaboom use its drum for its battle-idle. It also allows Typhlosion to have its flames ignited only during battle. Something to keep in mind is that if you want a bone to be visible only during battle, then you must set this bone as invisible for all other poses. This is why <code>transformedParts</code> is written under every pose in the poser file breakdown.

Below is an example of all the transformed part properties being used. This is mostly a demonstration of your options when using this function. If this example was applied in game, Charizard's wings would be detached from its body, but only the left wing would be invisible. Realistically, you would never want to do something like that.

"<abbr title="This property will allow you to manipulate the model parts without having to edit things in blockbench! You can select a bone from the model, and edit this bone specifically for this pose.">transformedParts</abbr>": [
{
"<abbr title="Here, we are selecting a bone from the model. In this case, it's charizard's right wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_right</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move 10 units on the x axis. This would be 10 units to the right if you were looking at charizard.">10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's right wing to be visible.">true</abbr>
},
{
"<abbr title="Here, we are selecting a second bone from the model. In this case, it's charizard's left wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_left</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move -10 units on the x axis. This would be 10 units to the left if you were looking at charizard.">-10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's left wing to be invisible.">false</abbr>
}
]


=== Look Animation(s) ===
The new Poser allows you to manipulate the look animation in a number of ways. Creators can now list multiple look animations where each one can define its own head bone and edit some of the properties of the look animation. Changing the properties allows you to manipulate the sight cone of the Pokémon if desired. This can help prevent some odd clipping or extend/shorten how far it can look up and down or left and right. Having multiple look animations allows for Pokémon with multiple heads to turn each head individually. You could even assign the torso and head bones to look at the same time while limiting the range for each. This can be helpful for Pokémon with little to no neck and they have to look with their body more than their head. 

The <code>q.look()</code> function is the format of this new look animation. When using this function, all the properties must be listed in a specific order and the name of the bone must be in single quotes. (the apostrophe key) 

* Please refer to the image below to visualize pitch, yaw, and the origin.
* Pressing F3+B in game can show the hitboxes. That blue line shows where the pokemon is looking at and if its looking at nothing, it is centered at 0 pitch and yaw. You can call this the origin.
[[File:Sight_Cones.png|800px|caption|The default sight cone visualized.]]


The properties of <code>q.look</code> must be in the following order:
* With the exception of the bone name, these are also the default values for each property
# Bone name: <code>'head_ai'</code> - The name of the bone on the model which will perform the look animation
# Pitch Multiplier - <code>1</code> - Multiplies the amount of pitch gained by this amount. Can use -1 to invert the pitch!
# Yaw Multiplier - <code>1</code> - Multiplies the amount of yaw gained by this amount. Can use -1 to invert the yaw!
# Max Pitch - <code>70</code> - How many degrees the Pokémon can look down from origin.
# Min Pitch - <code>-45</code> - How many degrees the Pokémon can look up from origin.
# Max Yaw - <code>45</code> - How many degrees the Pokémon can look right from origin.
# Min Yaw - <code>-45</code> - How many degrees the Pokémon can look left from origin.

A look animation using the previously listed values would look something like this inside of the standing pose:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai', 1, 1, 70, -45, 45, -45)",
"q.bedrock('riolu', 'ground_idle')"
],

If you want to use the default values and keep it short, you can also write it like this:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai')",
"q.bedrock('riolu', 'ground_idle')"
],

If you want to list multiple head bones, you can write the q.look function multiple times:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai')",
"q.look('torso')",
"q.bedrock('riolu', 'ground_idle')"
],


=== Quirks ===
Quirk animations are stateful animations (for now) that you can have play over the main animation for a pose. The new poser format introduced a shorthand method to writing in your quirk animations in the <code>q.bedrock_quirk()</code> format. The [[Poser#Quirks | old Poser method for quirks]] can be condensed into one line using this function. When using this function, all the properties must be listed in specific order, placed inside of single quotes (the apostrophe key) unless its a number, and separated by commas.

If your poser and animations are made just right, then you can have a single Pokémon running so many quirk animations at once. Remember that you can combine any of the following quirk examples if you have lots of animations like Blastoise.

The properties of <code>q.bedrock_quirk</code> must be in the following order:
# Animation Group: <code>'blastoise'</code> - the name of the Pokémon
# Animation Name(s): <code>'quirk_ground_idle'</code> - the name of the animation. Supports a pool of animations using the <code>q.array</code> function
# Minimum seconds between occurences: <code>20</code> - The decimal-friendly number of seconds that is the minimum between the quirk playing once and it playing a second time.
# Maximum seconds between occurences: <code>60</code> - What do you think?
# Loop times: <code>1</code> - The number of times the animation should play for the quirk

The previously listed properties would get written as a quirk like so:
"quirks": [
"q.bedrock_quirk('blastoise', 'quirk_ground_idle', 20, 60, 1)"
]

You don't need to include all the properties if you just want to use the default values of 8-30 seconds between quirks. You can write it like so to use the default values and keep it short:
"quirks": [
"q.bedrock_quirk('blastoise', 'blink')"
]

==== q.array ====
You can replace your animation name with the <code>q.array()</code> function to have the quirk pick from a list of animations to play. This can be helpful if you have a lot of quirks that you want to play under one pose. You simply need to put the list of animations inside of the parenthesis, include each animation name inside of single quotes, and separate them with a comma.
* Example: <code>q.array('quirk_battle_idle', 'quirk_battle_idle2')</code>
** These quirks are for Blastoise adjusting each of its cannons. Writing it this way lets Blastoise adjust only one cannon at a time, but it's a random cannon each time.

So if you were to make that into a quirk, it would look like this:
"quirks": [
"q.bedrock_quirk('blastoise', q.array('quirk_battle_idle', 'quirk_battle_idle2'), 30, 60, 1)"
]


=== Placeholder Animations ===
The new poser allows creators to use the placeholder animations which the JSON poser could not access before. These placeholder animations are based on the body type or limb features of the Pokémon. Each placeholder features a very simple animation that swings a limb back and forth. For now, you'll have to figure out how to configure these yourself lol

Here is a list of all the Placeholder animations:
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L172 "q.quadruped_walk()"]</code> - A basic walk animation for Pokémon with 4 legs
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L192 "q.biped_walk()"]</code> - A basic walking animation for Pokémon who stand on 2 legs.
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L208 "q.bimanual_swing()"]</code> - A basic arm swinging animation for Pokémon with 2 arms that usually stand on 2 legs.
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L224 "q.sine_wing_flap()"]</code> - A basic wing flap animation for a pair of wings on a Pokémon.



== Poser File Breakdown ==
Soon™


== Poser File Example ==
Instead of making <code>poser</code> files from scratch each time, you can use other custom Pokémon posers as a template. Just be aware of the animations each Pokémon has. Also be aware that not all Pokémon have a bone called <code>head</code>.

Here is an example of a poser file for a custom <code>riolu</code> that includes all currently implemented poses and their appropriate animations.
* Riolu obviously can't fly. This is just an example as no Pokémon can do everything currently.
* Blink animations are not applied to the sleep pose. This is because you don't blink when you sleep!
{
"portraitScale": 2.3,
"portraitTranslation": [-0.1, 0.58, 0],
"profileScale": 0.75,
"profileTranslation": [0, 0.68, 0],
"animations": {
"faint": "q.bedrock_primary('riolu', 'faint', q.curve('one'))",
"cry": "q.bedrock_stateful('riolu', 'cry')",
"recoil": "q.bedrock_stateful('riolu', 'recoil')",
"physical": "q.bedrock_primary('riolu', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('riolu', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('riolu', 'status', q.curve('symmetrical_wide'))"
},
"poses": {
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'battle_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'ground_idle')"
],
"quirks": [
"q.bedrock_quirk('riolu', 'blink')"
]
},
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'ground_walk')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"hover": {
"poseTypes": ["HOVER"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'air_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"fly": {
"poseTypes": ["FLY"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'air_fly')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"float": {
"poseTypes": ["FLOAT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'water_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"swim": {
"poseTypes": ["SWIM"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'water_swim')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"sleep": {
"poseTypes": ["SLEEP"],
"animations": ["q.bedrock('riolu', 'sleep')"]
},
"shoulder_left": {
"poseTypes": ["SHOULDER_LEFT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'shoulder_left')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"shoulder_right": {
"poseTypes": ["SHOULDER_RIGHT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'shoulder_right')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
}
}
}

{{Addon Creation}}

Config

2024-03-03T03:48:05Z

Patch Notes Guy: Updated spawning options

{| class="wikitable sortable"
|-
! Category
! Setting
! Default
! Min-Max/Options
! Description
|-
| Pokemon || maxPokemonLevel || 100 || 1-1000 || The maximum level Pokémon can get to.
|-
| Pokemon || maxPokemonFriendship || 255 || 0-1000 || The maximum friendship value.
|-
| Pokemon || announceDropItems || true || true/false || Whether to notify the Player of dropped items from defeating wild Pokémon.
|-
| Pokemon || defaultDropItemMethod || on-entity || on-entity/on-player/to-inventory ||
'''entity:''' Drops the item on the entity that is dying, if it exists. If not, drops at the position parsed into drops.
'''player:''' Drops the item on the player that caused the drop, if they exist. If not, drops at the position parsed into drops.
'''inventory:''' Puts the item in the player's inventory or drops it on the ground if the inventory is full. If the player that caused the drop doesn't exist, it drops at the position parsed into drops.
|-
| Pokemon || ambientPokemonCryTicks || 1080 || || Ticks between Pokémon cries. (Currently unused)
|-
| Pokemon || experienceMultiplier || 2 || || Additional Exp multiplier for Exp calculation.
|-
| Pokemon || ninjaskCreatesShedinja || true || true/false || Whether to give the Player a Shedinja using the first available Pokéball in their inventory when evolving a Nincada.
|-
| Pokemon || displayEntityLevelLabel || true || true/false || Whether to display the level above a Pokémon.
|-
| Pokemon || captureCalculator || cobblemon || cobblemon || The ID of the capture calculator. Can be added by another mod. If the ID doesn't exist it uses the default capture calculator.
|-
| Pokemon || playerDamagePokemon || true || true/false || Whether Players can attack Pokémon like normal Minecraft entities.
|-
| Pokemon || maxDynamaxLevel || 10 || 0-10 || The maximum Dynamax level Pokémon can be upgraded to.
|-
| Storage || defaultBoxCount || 30 || 1-1000 || The number of boxes available in the PC.
|-
| Storage || pokemonSaveIntervalSeconds || 30 || 1-120 || Seconds between saving storage data to file. eg Party & PC data.
|-
| Storage || storageFormat || nbt || nbt/json/mongodb || The storage format used for storing Cobblemon data.
|-
| Storage || preventCompletePartyDeposit || false || true/false || Whether to prevent Players from depositing their last Party Pokémon into the PC.
|-
| Storage || mongoDBConnectionString || mongodb://localhost:27017 || mongodb://IP address:port || The database connection string for your mongoDB database for Cobblemon data storage.
|-
| Storage || mongoDBDatabaseName || cobblemon || || The name of the mongoDB for Cobblemon data storage.
|-
| Spawning || maxVerticalCorrectionBlocks || 64 || 1-200 || The maximum number of blocks that can be corrected when choosing a spawning area. The larger this value, the more reliably spawning will work in vertically bumpy terrain such as mountains. Raising this value only has a very small, negative impact on performance.
|-
| Spawning || minimumLevelRangeMax || 10 || 1-1000 || The value considered to be the highest party Pokémon level when a player's party is empty or extremely low level. The higher this value, the higher the levels of Pokémon can be around players with no or very weak Pokémon.
|-
| Spawning || enableSpawning || true || true/false || Whether to allow Pokémon to spawn.
|-
| Spawning || minimumDistanceBetweenEntities || 8.0 || || The minimum block distance between spawning Pokémon and existing Entities in the World. This prevents clustered Pokémon spawning.
|-
| Spawning || maxNearbyBlocksHorizontalRange || 4 || || The maximum number of horizontal blocks away that a block can be for it to still be considered 'nearby' in a spawn condition. Lowering this value can slightly improve performance.
|-
| Spawning || maxNearbyBlocksVerticalRange || 2 || || The maximum number of vertical blocks away that a block can be for it to still be considered 'nearby' in a spawn condition. Lowering this value can slightly improve performance.
|-
| Spawning || maxVerticalSpace || 8 || || How far to check above a spawn location to investigate head room. This value exists for performance reasons but should never be less than the largest 'height'/'depth' condition in a spawn file.
|-
| Spawning || worldSliceDiameter || 8 || || The diameter of the world slices that a spawn action can occur in. When this value is large, there is more reliably frequent spawning at the cost of performance.
|-
| Spawning || worldSliceHeight || 16 || || The height of the world slices that a spawn action can occur in. When this value is large, there is more reliably frequent spawning at the cost of performance.
|-
| Spawning || ticksBetweenSpawnAttempts || 20.0 || || The amount of ticks (~20/second) between spawn attempts.
|-
| Spawning || minimumSliceDistanceFromPlayer || 16.0 || || Minimum amount of blocks from the Player that Pokémon can spawn.
|-
| Spawning || maximumSliceDistanceFromPlayer || 64.0 || || Maximum amount of blocks from the Player that Pokémon can spawn.
|-
| Spawning || exportSpawnConfig || false || true/false || Whether to generate the spawn config for more specific spawning settings.
|-
| Spawning || savePokemonToWorld || true || true/false || Whether to save Pokémon to the World so they exist after a Chunk/World is reloaded.
|-
| Spawning || pokemonPerChunk || 1.0 || || The amount of Pokémon allowed within a Chunk when spawning.
|-
| Spawning || baseApricornTreeGenerationChance || 0.1 || || Multiplier on biome-based chance for Apricorn trees to spawn during world generation.
|-
| Spawning || shinyRate || 8192.0 || || The chance for a spawned Pokémon to be shiny. If 0 no spawned Pokémon will be shiny. Calculated as 1/x.
|-
| Spawning || teraTypeRate || 20.0 || || The chance for a spawned Pokémon to have a Tera type that doesn't match it's typing. Calculated as 1/x.
|-
| Starter || exportStarterConfig || false || true/false || Whether to generate starter.json for editing the starter list.
|-
| Battles || autoUpdateShowdown || true || true/false || Whether to automatically update Showdown to the version shipped in the current Cobblemon version.
|-
| Battles || defaultFleeDistance || 32 || || How far away a Player must get to flee a battle (non-PvP). If the value is -1, battles cannot be fled.
|-
| Battles || allowExperienceFromPvP || true || true/false || Whether to allow Exp gain from PvP battles.
|-
| Battles || experienceShareMultiplier || 0.5 || || Multiplier of how much of the total Exp is given to a Pokémon holding an Exp. Share.
|-
| Battles || luckyEggMultiplier || 1.5 || || Multiplier of how much of the total Exp is given to a Pokémon holding a Lucky Egg.
|-
| Battles || allowSpectating || true || true/false || Whether to allow battles to be spectated.
|-
| Battles || walkingInBattleAnimations || false || true/false || Whether to allow walking animations to play during battle animations.
|-
| Passive Status || || 180-300 || || Range of seconds before clearing the status effect. The value is selected randomly from the range each time an effect is applied.
|-
| Healing || infiniteHealerCharge || false || true/false || Whether Healing Machines have infinite charges to heal Pokémon.
|-
| Healing || maxHealerCharge || 6.0 || || The maximum amount of full HP restoration Healing Machines can have. 1 charge is equivalent to a Max Revive, plus PP restoration.
|-
| Healing || chargeGainedPerTick || 0.000333333 || 0.0-maxHealerCharge || The amount of charge a Healing Machine gains per Server tick.
|-
| Healing || defaultFaintTimer || 300 || ||
|-
| Healing || faintAwakenHealthPercent || 0.2 || ||
|-
| Healing || healPercent || 0.05 || ||
|-
| Healing || healTimer || 60 || ||
|-
| World || appleLeftoversChance || 0.025 || || The chance to drop Leftovers when a Player eats an item that has <code>#cobblemon:held/leaves_leftovers</code>.
|-
| World || maxRootsInArea || 5 || || The maximum number of <code>#cobblemon:roots</code> that can generate within a 8x2x8 sphere.
|-
| World || bigRootPropagationChance || 0.1 || || The chance that Big Roots will grow more roots where possible.
|-
| World || energyRootChance || 0.25 || || The chance that a Big Root will grow an Energy Root.
|-
| World || defaultPasturedPokemonLimit || 16 || || The maximum Pokémon that can be placed in a Pasture block.
|-
| World || pastureBlockUpdateTicks || 40 || || The number of server ticks between Pasture block updates.
|-
| World || pastureMaxWanderDistance || 64 || || The maximum amount of blocks a Pokémon can move from the Pasture block.
|-
| World || pastureMaxPerChunk || 4.0 || || The maximum number of pastured Pokémon that can be sent out in a chunk.
|-
| World || maxInsertedFossilItems || 2 || || The maximum amount of fossils that can be added to the FossilAnalyzer.
|}

Config

2024-03-03T03:43:51Z

Patch Notes Guy: Updated spawning options

{| class="wikitable sortable"
|-
! Category
! Setting
! Default
! Min-Max/Options
! Description
|-
| Pokemon || maxPokemonLevel || 100 || 1-1000 || The maximum level Pokémon can get to.
|-
| Pokemon || maxPokemonFriendship || 255 || 0-1000 || The maximum friendship value.
|-
| Pokemon || announceDropItems || true || true/false || Whether to notify the Player of dropped items from defeating wild Pokémon.
|-
| Pokemon || defaultDropItemMethod || on-entity || on-entity/on-player/to-inventory ||
'''entity:''' Drops the item on the entity that is dying, if it exists. If not, drops at the position parsed into drops.
'''player:''' Drops the item on the player that caused the drop, if they exist. If not, drops at the position parsed into drops.
'''inventory:''' Puts the item in the player's inventory or drops it on the ground if the inventory is full. If the player that caused the drop doesn't exist, it drops at the position parsed into drops.
|-
| Pokemon || ambientPokemonCryTicks || 1080 || || Ticks between Pokémon cries. (Currently unused)
|-
| Pokemon || experienceMultiplier || 2 || || Additional Exp multiplier for Exp calculation.
|-
| Pokemon || ninjaskCreatesShedinja || true || true/false || Whether to give the Player a Shedinja using the first available Pokéball in their inventory when evolving a Nincada.
|-
| Pokemon || displayEntityLevelLabel || true || true/false || Whether to display the level above a Pokémon.
|-
| Pokemon || captureCalculator || cobblemon || cobblemon || The ID of the capture calculator. Can be added by another mod. If the ID doesn't exist it uses the default capture calculator.
|-
| Pokemon || playerDamagePokemon || true || true/false || Whether Players can attack Pokémon like normal Minecraft entities.
|-
| Pokemon || maxDynamaxLevel || 10 || 0-10 || The maximum Dynamax level Pokémon can be upgraded to.
|-
| Storage || defaultBoxCount || 30 || 1-1000 || The number of boxes available in the PC.
|-
| Storage || pokemonSaveIntervalSeconds || 30 || 1-120 || Seconds between saving storage data to file. eg Party & PC data.
|-
| Storage || storageFormat || nbt || nbt/json/mongodb || The storage format used for storing Cobblemon data.
|-
| Storage || preventCompletePartyDeposit || false || true/false || Whether to prevent Players from depositing their last Party Pokémon into the PC.
|-
| Storage || mongoDBConnectionString || mongodb://localhost:27017 || mongodb://IP address:port || The database connection string for your mongoDB database for Cobblemon data storage.
|-
| Storage || mongoDBDatabaseName || cobblemon || || The name of the mongoDB for Cobblemon data storage.
|-
| Spawning || maxVerticalCorrectionBlocks || 64 || 1-200 ||
|-
| Spawning || minimumLevelRangeMax || 10 || 1-1000 ||
|-
| Spawning || enableSpawning || true || true/false || Whether to allow Pokémon to spawn.
|-
| Spawning || minimumDistanceBetweenEntities || 8.0 || || The minimum block distance between spawning Pokémon and existing Entities in the World. This prevents clustered Pokémon spawning.
|-
| Spawning || maxNearbyBlocksHorizontalRange || 4 || || The maximum number of horizontal blocks away that a block can be for it to still be considered 'nearby' in a spawn condition. Lowering this value can slightly improve performance.
|-
| Spawning || maxNearbyBlocksVerticalRange || 2 || || The maximum number of vertical blocks away that a block can be for it to still be considered 'nearby' in a spawn condition. Lowering this value can slightly improve performance.
|-
| Spawning || maxVerticalSpace || 8 || || How far to check above a spawn location to investigate head room. This value exists for performance reasons but should never be less than the largest 'height'/'depth' condition in a spawn file.
|-
| Spawning || worldSliceDiameter || 8 || || The diameter of the world slices that a spawn action can occur in. When this value is large, there is more reliably frequent spawning at the cost of performance.
|-
| Spawning || worldSliceHeight || 16 || || The height of the world slices that a spawn action can occur in. When this value is large, there is more reliably frequent spawning at the cost of performance.
|-
| Spawning || ticksBetweenSpawnAttempts || 20.0 || || The amount of ticks (~20/second) between spawn attempts.
|-
| Spawning || minimumSliceDistanceFromPlayer || 16.0 || || Minimum amount of blocks from the Player that Pokémon can spawn.
|-
| Spawning || maximumSliceDistanceFromPlayer || 64.0 || || Maximum amount of blocks from the Player that Pokémon can spawn.
|-
| Spawning || exportSpawnConfig || false || true/false || Whether to generate the spawn config for more specific spawning settings.
|-
| Spawning || savePokemonToWorld || true || true/false || Whether to save Pokémon to the World so they exist after a Chunk/World is reloaded.
|-
| Spawning || pokemonPerChunk || 1.0 || || The amount of Pokémon allowed within a Chunk when spawning.
|-
| Spawning || baseApricornTreeGenerationChance || 0.1 || || Multiplier on biome-based chance for Apricorn trees to spawn during world generation.
|-
| Spawning || shinyRate || 8192.0 || || The chance for a spawned Pokémon to be shiny. If 0 no spawned Pokémon will be shiny. Calculated as 1/x.
|-
| Spawning || teraTypeRate || 20.0 || || The chance for a spawned Pokémon to have a Tera type that doesn't match it's typing. Calculated as 1/x.
|-
| Starter || exportStarterConfig || false || true/false || Whether to generate starter.json for editing the starter list.
|-
| Battles || autoUpdateShowdown || true || true/false || Whether to automatically update Showdown to the version shipped in the current Cobblemon version.
|-
| Battles || defaultFleeDistance || 32 || || How far away a Player must get to flee a battle (non-PvP). If the value is -1, battles cannot be fled.
|-
| Battles || allowExperienceFromPvP || true || true/false || Whether to allow Exp gain from PvP battles.
|-
| Battles || experienceShareMultiplier || 0.5 || || Multiplier of how much of the total Exp is given to a Pokémon holding an Exp. Share.
|-
| Battles || luckyEggMultiplier || 1.5 || || Multiplier of how much of the total Exp is given to a Pokémon holding a Lucky Egg.
|-
| Battles || allowSpectating || true || true/false || Whether to allow battles to be spectated.
|-
| Battles || walkingInBattleAnimations || false || true/false || Whether to allow walking animations to play during battle animations.
|-
| Passive Status || || 180-300 || || Range of seconds before clearing the status effect. The value is selected randomly from the range each time an effect is applied.
|-
| Healing || infiniteHealerCharge || false || true/false || Whether Healing Machines have infinite charges to heal Pokémon.
|-
| Healing || maxHealerCharge || 6.0 || || The maximum amount of full HP restoration Healing Machines can have. 1 charge is equivalent to a Max Revive, plus PP restoration.
|-
| Healing || chargeGainedPerTick || 0.000333333 || 0.0-maxHealerCharge || The amount of charge a Healing Machine gains per Server tick.
|-
| Healing || defaultFaintTimer || 300 || ||
|-
| Healing || faintAwakenHealthPercent || 0.2 || ||
|-
| Healing || healPercent || 0.05 || ||
|-
| Healing || healTimer || 60 || ||
|-
| World || appleLeftoversChance || 0.025 || || The chance to drop Leftovers when a Player eats an item that has <code>#cobblemon:held/leaves_leftovers</code>.
|-
| World || maxRootsInArea || 5 || || The maximum number of <code>#cobblemon:roots</code> that can generate within a 8x2x8 sphere.
|-
| World || bigRootPropagationChance || 0.1 || || The chance that Big Roots will grow more roots where possible.
|-
| World || energyRootChance || 0.25 || || The chance that a Big Root will grow an Energy Root.
|-
| World || defaultPasturedPokemonLimit || 16 || || The maximum Pokémon that can be placed in a Pasture block.
|-
| World || pastureBlockUpdateTicks || 40 || || The number of server ticks between Pasture block updates.
|-
| World || pastureMaxWanderDistance || 64 || || The maximum amount of blocks a Pokémon can move from the Pasture block.
|-
| World || pastureMaxPerChunk || 4.0 || || The maximum number of pastured Pokémon that can be sent out in a chunk.
|-
| World || maxInsertedFossilItems || 2 || || The maximum amount of fossils that can be added to the FossilAnalyzer.
|}

Spawn Rules

2023-12-23T05:10:06Z

Patch Notes Guy: The example should probably be enabled

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": "true",
"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')"
}
]

Spawn Rules

2023-12-23T05:05:57Z

Patch Notes Guy: More formatting improvements

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')"
}
]

Spawn Rules

2023-12-23T05:03:58Z

Patch Notes Guy: Some formatting improvements

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')"
}
]
}

Spawn Rules

2023-12-23T05:02:35Z

Patch Notes Guy: Rough draft of spawn rules.

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')"
}
]
}

Apricorn

2023-02-19T10:23:46Z

Patch Notes Guy:

{{InfoboxBlock
| image = File:apricorn block stage 0.png
| image2 = File:apricorn block stage 1.png
| image3 = File:apricorn block stage 2.png
| image4 = File:red apricorn block.png
| image5 = File:apricorn block stage 0.png
| image6 = File:apricorn block stage 1.png
| image7 = File:apricorn block stage 2.png
| image8 = File:yellow apricorn block.png
| image9 = File:apricorn block stage 0.png
| image10 = File:apricorn block stage 1.png
| image11 = File:apricorn block stage 2.png
| image12 = File:green apricorn block.png
| image13 = File:apricorn block stage 0.png
| image14 = File:apricorn block stage 1.png
| image15 = File:apricorn block stage 2.png
| image16 = File:blue apricorn block.png
| image17 = File:apricorn block stage 0.png
| image18 = File:apricorn block stage 1.png
| image19 = File:apricorn block stage 2.png
| image20 = File:pink apricorn block.png
| image21 = File:apricorn block stage 0.png
| image22 = File:apricorn block stage 1.png
| image23 = File:apricorn block stage 2.png
| image24 = File:white apricorn block.png
| image25 = File:apricorn block stage 0.png
| image26 = File:apricorn block stage 1.png
| image27 = File:apricorn block stage 2.png
| image28 = File:black apricorn block.png
| item = File:red apricorn.png
| itemtooltip = Red Apricorn
| item2 = File:yellow apricorn.png
| itemtooltip2 = Yellow Apricorn
| item3 = File:green apricorn.png
| itemtooltip3 = Green Apricorn
| item4 = File:blue apricorn.png
| itemtooltip4 = Blue Apricorn
| item5 = File:pink apricorn.png
| itemtooltip5 = Pink Apricorn
| item6 = File:white apricorn.png
| itemtooltip6 = White Apricorn
| item7 = File:black apricorn.png
| itemtooltip7 = Black Apricorn
| stacklimit = 64
| hardness = 0.2
| resistance = 3
}}

An '''apricorn''' is a fruit that can be used to craft Poké Balls.

==Obtaining==
Apricorns can be found growing naturally on [[Apricorn Tree|apricorn trees]]. Interacting with one when fully grown will yield a single apricorn and will leave behind an apricorn in its first growth stage.

==Usage==
Bonemeal can be used on a growing apricorn to speed up its growth.

Putting an apricorn in a composter has a 65% chance of raising the compost level by 1.

Apricorns can be placed on [[Apricorn Leaves|apricorn leaves]] in Creative Mode to create new buds.

==Gallery==
<gallery>
apricorn tree.png | Apricorns at various stages growing on an apricorn tree
</gallery>

{{Blocks}}

Apricorn

2023-02-19T10:22:45Z

Patch Notes Guy: Another language test

{{InfoboxBlock
| image = File:apricorn block stage 0.png
| image2 = File:apricorn block stage 1.png
| image3 = File:apricorn block stage 2.png
| image4 = File:red apricorn block.png
| image5 = File:apricorn block stage 0.png
| image6 = File:apricorn block stage 1.png
| image7 = File:apricorn block stage 2.png
| image8 = File:yellow apricorn block.png
| image9 = File:apricorn block stage 0.png
| image10 = File:apricorn block stage 1.png
| image11 = File:apricorn block stage 2.png
| image12 = File:green apricorn block.png
| image13 = File:apricorn block stage 0.png
| image14 = File:apricorn block stage 1.png
| image15 = File:apricorn block stage 2.png
| image16 = File:blue apricorn block.png
| image17 = File:apricorn block stage 0.png
| image18 = File:apricorn block stage 1.png
| image19 = File:apricorn block stage 2.png
| image20 = File:pink apricorn block.png
| image21 = File:apricorn block stage 0.png
| image22 = File:apricorn block stage 1.png
| image23 = File:apricorn block stage 2.png
| image24 = File:white apricorn block.png
| image25 = File:apricorn block stage 0.png
| image26 = File:apricorn block stage 1.png
| image27 = File:apricorn block stage 2.png
| image28 = File:black apricorn block.png
| item = File:red apricorn.png
| itemtooltip = Red Apricorn
| item2 = File:yellow apricorn.png
| itemtooltip2 = Yellow Apricorn
| item3 = File:green apricorn.png
| itemtooltip3 = Green Apricorn
| item4 = File:blue apricorn.png
| itemtooltip4 = Blue Apricorn
| item5 = File:pink apricorn.png
| itemtooltip5 = Pink Apricorn
| item6 = File:white apricorn.png
| itemtooltip6 = White Apricorn
| item7 = File:black apricorn.png
| itemtooltip7 = Black Apricorn
| stacklimit = 64
| hardness = 0.2
| resistance = 3
}}

An '''apricorn''' is a fruit that can be used to craft Poké Balls.

[[:fr:Apricorn]]

==Obtaining==
Apricorns can be found growing naturally on [[Apricorn Tree|apricorn trees]]. Interacting with one when fully grown will yield a single apricorn and will leave behind an apricorn in its first growth stage.

==Usage==
Bonemeal can be used on a growing apricorn to speed up its growth.

Putting an apricorn in a composter has a 65% chance of raising the compost level by 1.

Apricorns can be placed on [[Apricorn Leaves|apricorn leaves]] in Creative Mode to create new buds.

==Gallery==
<gallery>
apricorn tree.png | Apricorns at various stages growing on an apricorn tree
</gallery>

{{Blocks}}