ORK Framework  2.25.2
API Documentation
ORKFramework.IComponentSaveData Interface Reference

Interface used for saving/loading component data of a combatant with a save game. Will automatically save the data of components implementing this interface that are attached to a combatant's game object. Please note that only members of the player group are saved, but this can also be used to store data of remembered combatant spawner combatants. More...

Inheritance diagram for ORKFramework.IComponentSaveData:
ORKFramework.ISaveData

Public Member Functions

string GetSaveKey ()
 The data of a component is stored with a save key to know which component will get which data. The save key mustn't contain any spaces. More...
 
- Public Member Functions inherited from ORKFramework.ISaveData
DataObject SaveGame ()
 Used to save the data - you need to add the data to a ORKFramework.DataObject. More...
 
void LoadGame (DataObject data)
 Used to load the data - you need to get the data from the ORKFramework.DataObject. More...
 

Detailed Description

Interface used for saving/loading component data of a combatant with a save game. Will automatically save the data of components implementing this interface that are attached to a combatant's game object. Please note that only members of the player group are saved, but this can also be used to store data of remembered combatant spawner combatants.

Member Function Documentation

◆ GetSaveKey()

string ORKFramework.IComponentSaveData.GetSaveKey ( )

The data of a component is stored with a save key to know which component will get which data. The save key mustn't contain any spaces.

Returns
The key used for saving this data.