.. _properties:

Properties
==========

Define stat changes applied to the player drinking this `fluid <https://pz-wiki-modding.github.io/PZ-API-Docs/scripts/fluid.html>`_.


Hierarchy
---------

**Valid Parent Blocks:**

- :ref:`fluid`


ID Properties
-------------

This block should not have an ID.


Parameters
----------

.. _properties-alcohol:

alcohol
^^^^^^^

:Type: float

No description

.. _properties-calories:

Calories
^^^^^^^^

:Type: float

The number of calories this fluid provides when consumed.

.. _properties-carbohydrates:

Carbohydrates
^^^^^^^^^^^^^

:Type: float

The amount of carbohydrates this fluid provides when consumed.

.. _properties-endurancechange:

enduranceChange
^^^^^^^^^^^^^^^

:Type: float

The amount of endurance given back.

.. _properties-fatiguechange:

fatigueChange
^^^^^^^^^^^^^

:Type: float

The amount of fatigue this fluid changes when consumed. Positive values increase fatigue, negative values decrease it.

.. _properties-flureduction:

fluReduction
^^^^^^^^^^^^

:Type: float

No description

.. _properties-foodsicknesschange:

foodSicknessChange
^^^^^^^^^^^^^^^^^^

:Type: float

The amount of food sickness provides.

.. _properties-hungerchange:

HungerChange
^^^^^^^^^^^^

:Type: float

The amount of hunger this fluid changes when consumed. Positive values increase hunger, negative values decrease it.

.. _properties-lipids:

Lipids
^^^^^^

:Type: float

The amount of lipids (fats) this fluid provides when consumed.

.. _properties-painreduction:

painReduction
^^^^^^^^^^^^^

:Type: float

The amount of pain this fluid reduces when consumed.

.. _properties-proteins:

Proteins
^^^^^^^^

:Type: float

The amount of proteins this fluid provides when consumed.

.. _properties-stresschange:

StressChange
^^^^^^^^^^^^

:Type: float

The amount of stress this fluid changes when consumed. Positive values increase stress, negative values decrease it.

.. _properties-thirstchange:

ThirstChange
^^^^^^^^^^^^

:Type: float

The amount of thirst this fluid changes when consumed. Positive values increase thirst, negative values decrease it.

.. _properties-unhappychange:

UnhappyChange
^^^^^^^^^^^^^

:Type: float

The amount of unhappiness this fluid changes when consumed. Positive values increase unhappiness, negative values decrease it.