SPlayerInventory (CodelanxLib 0.3.1-SNAPSHOT API)

java.lang.Object
- com.codelanx.codelanxlib.serialize.SPlayerInventory

All Implemented Interfaces:

ConfigurationSerializable
```
public class SPlayerInventory
extends Object
implements ConfigurationSerializable
```
Represents a PlayerInventory that is capable of being serialized

Since:

0.0.1

Version:

0.0.1

Author:

1Rogue

Field Summary

Fields
Modifier and Type	Field and Description
`protected ItemStack`	`boots` The `ItemStack` stored on the player's feet
`protected ItemStack`	`chest` The `ItemStack` stored on the player's torso
`protected ItemStack`	`helmet` The `ItemStack` stored on the player's head
`protected SInventory`	`inv` The general contents of the player's inventory
`protected ItemStack`	`legs` The `ItemStack` stored on the player's legs

Constructor Summary

Constructors
Constructor and Description
`SPlayerInventory(Map<String,Object> config)` `ConfigurationSerializable` constructor.
`SPlayerInventory(PlayerInventory inv)` Copies the contents of the passed `PlayerInventory`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SPlayerInventory`	`deserialize(Map<String,Object> config)` Creates a new `SPlayerInventory` object and returns it.
`ItemStack`	`getBoots()` Returns the item in the boots slot of the `PlayerInventory`
`ItemStack`	`getChestplate()` Returns the item in the torso slot of the `PlayerInventory`
`ItemStack`	`getHelmet()` Returns the item in the helmet slot of the `PlayerInventory`
`SInventory`	`getInventory()` Returns the underlying `SInventory` object that stores normal inventory items
`ItemStack`	`getLeggings()` Returns the item in the pants slot of the `PlayerInventory`
`Map<String,Object>`	`serialize()`
`void`	`set(PlayerInventory inv)` Sets the current contents of this class into a passed `PlayerInventory`
`static SPlayerInventory`	`valueOf(Map<String,Object> config)` Creates a new `SPlayerInventory` object and returns it.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - helmet
```
protected final ItemStack helmet
```
    The ItemStack stored on the player's head
  - chest
```
protected final ItemStack chest
```
    The ItemStack stored on the player's torso
  - legs
```
protected final ItemStack legs
```
    The ItemStack stored on the player's legs
  - boots
```
protected final ItemStack boots
```
    The ItemStack stored on the player's feet
  - inv
```
protected final SInventory inv
```
    The general contents of the player's inventory
- Constructor Detail
  - SPlayerInventory
```
public SPlayerInventory(PlayerInventory inv)
```
    Copies the contents of the passed PlayerInventory
    
    Parameters:
    
    inv - The PlayerInventory to copy
    
    Since:
    
    0.0.1
  - SPlayerInventory
```
public SPlayerInventory(Map<String,Object> config)
```
    ConfigurationSerializable constructor. Should not be used by anything other than Bukkit.
    
    Parameters:
    
    config - A serialized Map of this object
    
    Since:
    
    0.0.1
- Method Detail
  - getHelmet
```
public ItemStack getHelmet()
```
    Returns the item in the helmet slot of the PlayerInventory
    
    Returns:
    
    The helmet in the PlayerInventory
    
    Since:
    
    0.1.0
  - getChestplate
```
public ItemStack getChestplate()
```
    Returns the item in the torso slot of the PlayerInventory
    
    Returns:
    
    The torso in the PlayerInventory
    
    Since:
    
    0.1.0
  - getLeggings
```
public ItemStack getLeggings()
```
    Returns the item in the pants slot of the PlayerInventory
    
    Returns:
    
    The pants in the PlayerInventory
    
    Since:
    
    0.1.0
  - getBoots
```
public ItemStack getBoots()
```
    Returns the item in the boots slot of the PlayerInventory
    
    Returns:
    
    The boots in the PlayerInventory
    
    Since:
    
    0.1.0
  - getInventory
```
public SInventory getInventory()
```
    Returns the underlying SInventory object that stores normal inventory items
    
    Returns:
    
    The underlying SInventory object
    
    Since:
    
    0.0.1
  - set
```
public void set(PlayerInventory inv)
```
    Sets the current contents of this class into a passed PlayerInventory
    
    Parameters:
    
    inv - The PlayerInventory to store into
    
    Since:
    
    0.0.1
  - serialize
```
public Map<String,Object> serialize()
```
    Specified by:
    
    serialize in interface ConfigurationSerializable
    
    Returns:
    
    Since:
    
    0.0.1
  - valueOf
```
public static SPlayerInventory valueOf(Map<String,Object> config)
```
    Creates a new SPlayerInventory object and returns it. Should only be used by Bukkit
    
    Parameters:
    
    config - A serialized Map of this object
    
    Returns:
    
    A new SPlayerInventory object
    
    Since:
    
    0.0.1
  - deserialize
```
public static SPlayerInventory deserialize(Map<String,Object> config)
```
    Creates a new SPlayerInventory object and returns it. Should only be used by Bukkit
    
    Parameters:
    
    config - A serialized Map of this object
    
    Returns:
    
    A new SPlayerInventory object
    
    Since:
    
    0.0.1

Class SPlayerInventory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

helmet

chest

legs

boots

inv

Constructor Detail

SPlayerInventory

SPlayerInventory

Method Detail

getHelmet

getChestplate

getLeggings

getBoots

getInventory

set

serialize

valueOf

deserialize