# 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   | 布尔值 | 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   | 布尔值 | If the energy should actually be inserted or not. |


:::


## 参数

| 名称              | 类型  | 可获得  | 可设置   | 描述                                                   |
| --------------- | --- | ---- | ----- | ---------------------------------------------------- |
| canExtract      | 布尔值 | true | false | Checks if energy can be extracted from this storage. |
| canReceive      | 布尔值 | 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	类型布尔值	描述 If the energy should actually be extracted or not.

参数	类型	描述
参数 maxReceive	类型 int	描述 The max amount of energy to be inserted.
参数 simulate	类型布尔值	描述 If the energy should actually be inserted or not.

名称	类型	可获得	可设置	描述
名称 canExtract	类型布尔值	可获得 true	可设置 false	描述 Checks if energy can be extracted from this storage.
名称 canReceive	类型布尔值	可获得 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.