# IEnergyStorage

## Импорт класса

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
import crafttweaker.api.capability.IEnergyStorage;
```


## Методы

:::group{name=canExtract}

Checks if energy can be extracted from this storage.

Returns: true if the storage can be extracted from, false otherwise.  
Return Type: boolean

```zenscript
// IEnergyStorage.canExtract() as boolean

myIEnergyStorage.canExtract();
```

:::

:::group{name=canReceive}

Checks if this storage can receive energy.

Returns: true if this storage can receive energy, false otherwise.  
Return Type: boolean

```zenscript
// IEnergyStorage.canReceive() as boolean

myIEnergyStorage.canReceive();
```

:::

:::group{name=extractEnergy}

Extracts energy from the storage.

Returns: the amount of energy that was extracted.  
Return Type: int

```zenscript
// IEnergyStorage.extractEnergy(maxExtract as int, simulate as boolean) as int

myIEnergyStorage.extractEnergy(400, false);
```

| Параметр   | Тип     | Описание                                           |
| ---------- | ------- | -------------------------------------------------- |
| maxExtract | int     | The max amount of energy to be extracted.          |
| simulate   | boolean | If the energy should actually be extracted or not. |


:::

:::group{name=getEnergyStored}

Gets the amount of energy stored.

Returns: The amount of energy stored.  
Return Type: int

```zenscript
// IEnergyStorage.getEnergyStored() as int

myIEnergyStorage.getEnergyStored();
```

:::

:::group{name=getMaxEnergyStored}

Gets the max energy that can be stored.

Returns: The max energy that can be stored.  
Return Type: int

```zenscript
// IEnergyStorage.getMaxEnergyStored() as int

myIEnergyStorage.getMaxEnergyStored();
```

:::

:::group{name=receiveEnergy}

Adds energy to the storage.

Returns: the amount of energy that was accepted.  
Return Type: int

```zenscript
// IEnergyStorage.receiveEnergy(maxReceive as int, simulate as boolean) as int

myIEnergyStorage.receiveEnergy(300, false);
```

| Параметр   | Тип     | Описание                                          |
| ---------- | ------- | ------------------------------------------------- |
| maxReceive | int     | The max amount of energy to be inserted.          |
| simulate   | boolean | If the energy should actually be inserted or not. |


:::


## Свойства

| Название        | Тип     | Имеет Getter | Имеет Setter | Описание                                             |
| --------------- | ------- | ------------ | ------------ | ---------------------------------------------------- |
| canExtract      | boolean | true         | false        | Checks if energy can be extracted from this storage. |
| canReceive      | boolean | true         | false        | Checks if this storage can receive energy.           |
| energyStored    | int     | true         | false        | Gets the amount of energy stored.                    |
| maxEnergyStored | int     | true         | false        | Gets the max energy that can be stored.              |



Параметр	Тип	Описание
Параметр maxExtract	Тип int	Описание The max amount of energy to be extracted.
Параметр simulate	Тип boolean	Описание If the energy should actually be extracted or not.

Параметр	Тип	Описание
Параметр maxReceive	Тип int	Описание The max amount of energy to be inserted.
Параметр simulate	Тип boolean	Описание If the energy should actually be inserted or not.

Название	Тип	Имеет Getter	Имеет Setter	Описание
Название canExtract	Тип boolean	Имеет Getter true	Имеет Setter false	Описание Checks if energy can be extracted from this storage.
Название canReceive	Тип boolean	Имеет Getter true	Имеет Setter false	Описание Checks if this storage can receive energy.
Название energyStored	Тип int	Имеет Getter true	Имеет Setter false	Описание Gets the amount of energy stored.
Название maxEnergyStored	Тип int	Имеет Getter true	Имеет Setter false	Описание Gets the max energy that can be stored.