Pikifen/Object categories/Drop

Drops are any kind of droplet that can be drunk by a Pikmin or a leader. Once the Pikmin or leader has finished slurping up their portion, they will be affected in some way, like having their maturity boosted, or having the number of sprays increased.

Examples of drop types include nectar, which flowers up the Pikmin, ultra-spicy nectar, which gives the leaders one extra usage of ultra-spicy spray, etc.

To create a new type of drop, please follow the creating object types tutorial.

Overview
A drop type object can only be drunk by either a Pikmin or a leader, not both. For Pikmin, their maturity can be increased, for leaders, their spray count for a given spray can be increased, and for either, they can undergo a status effect. Each type of drop can also have a different amount of doses, and shrink down at different speeds.

Drop type objects are hardcoded in the engine to sit there and, when an object that wants to drink them approaches, have their doses dropped down by one, and give the corresponding object an effect once that dose is finished being slurped. They can also be bumped against to slosh around in place.

Attributes
Besides the global object type attributes, a drop type has the following attributes.

Mandatory

 *  : What type of object will consume this drop.  or.
 *  : What will happen to the consumer once they've drunk it.  to cause a Pikmin's maturity to change,   to change the number of available sprays of a given type, or   to apply a status effect to the object that drank it.

Recommended

 *  : When it increases a Pikmin's maturity or the number of a spray, this is the amount to increase by. To maturate a Pikmin directly to the flower stage, you want to give this the value . You can also write negative values to lower a Pikmin's maturity or a spray count. Defaults to 2.
 *  : How many objects this drop can serve. Defaults to 1.

Optional

 *  : When an object drinks it, the drop will decrease in size. This is purely visual. This number specifies the speed of the shrinking in percentage per second. 40 is a good amount for nectar, and 120 is a good amount for spray nectar. Defaults to 40.
 *  : If this drop increases the amount of a spray, write the spray type's name here. Defaults to not set.
 *  : If this drop gives the consumer a status effect, write its name here. Defaults to not set.

Animations
A drop type needs to have the following animations:


 *  : Idling.
 *  : Falling down. Normally used after it's thrown when being spawn, like when it pops out of an egg.
 *  : Lands on the floor from falling.
 *  : When it's been bumped against.

Script
A drop type's script cannot be changed.

Object spawn script variables
Besides the global spawn script variables, drop type objects do not read any specific script variables.