ORK Framework  2.22.0
API Documentation
ORKFramework.InventorySettings Class Reference
Inheritance diagram for ORKFramework.InventorySettings:
ORKFramework.BaseSettings ORKFramework.CoreSettings ORKFramework.IBaseData

Public Member Functions

 InventorySettings (ORKProjectAsset project)
 
override void SetRealIDs ()
 Sets the RealID values (indexes). More...
 
override void SetData (DataObject data)
 Sets the variables of the class using a ORKFramework.DataObject. More...
 
override string GetName (int index)
 Gets the name of a data. More...
 
override string[] GetNames (bool addIndex)
 Gets a list of names of all data. More...
 
override int Add ()
 Adds new data. More...
 
override int Copy (int index)
 Creates a copy of the data with the specified index. More...
 
override void Remove (int index)
 Removes the data with the specified index. More...
 
override void Move (int index, bool down)
 Moves the data with the specified index. More...
 
bool IsGroup ()
 
bool IsIndividual ()
 
void AddDropOffset (ref Vector3 position)
 
- Public Member Functions inherited from ORKFramework.BaseSettings
override void DataAdded (ORKDataType type, int index)
 Automatic data updated function when adding new data. More...
 
override void DataRemoved (ORKDataType type, int index, int index2)
 Automatic data update function when removing data. More...
 
override void DataMoved (ORKDataType type, bool down, int index, int index2)
 Automatic data update function when moving data. More...
 
override void DataLoaded ()
 Called after loading the project data of all settings. Handles final data checks. More...
 
- Public Member Functions inherited from ORKFramework.CoreSettings
virtual void LoadProject (ORKProjectAsset project)
 Loads the settings found in the ORK Project asset. More...
 
virtual void GetSaveData (ref Dictionary< string, ORKDataFile > list, bool encrypt)
 Gets the save data. More...
 
virtual void GetLoadData (ref Dictionary< string, ORKDataFile > list, ORKProjectAsset project)
 Gets the load data from the ORK Project asset. More...
 
virtual void GetGameVariables (ref List< string > list)
 Gets the game variables found in this settings. More...
 
virtual DataObject GetData ()
 Gets a ORKFramework.DataObject representing the class. More...
 
virtual void EditorAutoSetup (string fieldName)
 Called for all fields using the autoSetup option of the ORKFramework.ORKEditorLayoutAttribute. More...
 
void SetRealIDs (BaseIndexData[] d)
 Sets the RealID values (indexes) of the data. More...
 

Public Attributes

CombatantScope type = CombatantScope.Group
 
InventoryAddType itemAddType = InventoryAddType.Add
 
InventoryAddType weaponAddType = InventoryAddType.Add
 
InventoryAddType armorAddType = InventoryAddType.Add
 
bool limitQuantity = false
 
int quantityLimit = 99
 
bool limitStackQuantity = false
 
int stackQuantityLimit = 99
 
bool limit = false
 
bool blockAdd = false
 
bool limitOnlyLeader = false
 
FloatValue limitValue
 
InventoryFullCast[] fullCast = new InventoryFullCast[0]
 
bool useDelay = false
 
FloatValue delayTime
 
MarkNewContentSettings markNewContent = new MarkNewContentSettings()
 
bool dropOnGround = false
 
LayerMask dropMask = -1
 
EventStartType dropStartType = EventStartType.Interact
 
bool dropUseRotation = false
 
bool dropSaveUpdatedPosition = false
 
Vector2 dropOffsetX = new Vector2(1, -1)
 
Vector2 dropOffsetY = new Vector2(1, -1)
 
Vector2 dropOffsetZ = new Vector2(1, 1)
 
ItemCollectionChoice itemCollection = new ItemCollectionChoice()
 
ItemBoxChoice itemBoxCollection = new ItemBoxChoice()
 
QuantityTextSettings quantityText = new QuantityTextSettings()
 
CraftingRecipeLayout craftignLayout = new CraftingRecipeLayout()
 
InventoryNotificationSettings notifications = new InventoryNotificationSettings()
 

Properties

override string FILENAME [get]
 
override int Count [get]
 
- Properties inherited from ORKFramework.CoreSettings
abstract string FILENAME [get]
 Gets the filename used for saving the settings. More...
 
abstract int Count [get]
 

Member Function Documentation

override int ORKFramework.InventorySettings.Add ( )
virtual

Adds new data.

Implements ORKFramework.CoreSettings.

override int ORKFramework.InventorySettings.Copy ( int  index)
virtual

Creates a copy of the data with the specified index.

Parameters
indexThe data index.

Implements ORKFramework.CoreSettings.

override string ORKFramework.InventorySettings.GetName ( int  index)
virtual

Gets the name of a data.

Returns
The name.
Parameters
indexThe data index.

Implements ORKFramework.CoreSettings.

override string [] ORKFramework.InventorySettings.GetNames ( bool  addIndex)
virtual

Gets a list of names of all data.

Returns
The list of names.
Parameters
addIndexIf true, the index of the data will be added to the names.

Implements ORKFramework.CoreSettings.

override void ORKFramework.InventorySettings.Move ( int  index,
bool  down 
)
virtual

Moves the data with the specified index.

Parameters
indexThe data index.
downIf true, the data will be moved down.

Implements ORKFramework.CoreSettings.

override void ORKFramework.InventorySettings.Remove ( int  index)
virtual

Removes the data with the specified index.

Parameters
indexThe data index.

Implements ORKFramework.CoreSettings.

override void ORKFramework.InventorySettings.SetData ( DataObject  data)
virtual

Sets the variables of the class using a ORKFramework.DataObject.

Parameters
dataORKFramework.DataObject containing the data.

Reimplemented from ORKFramework.CoreSettings.

override void ORKFramework.InventorySettings.SetRealIDs ( )
virtual

Sets the RealID values (indexes).

Implements ORKFramework.CoreSettings.