LokSceneStorageManager¶
Inherits:
The LokSceneStorageManager class can be communicate with the LokGlobalStorageManager Singleton.
Description¶
This class is useful when it is desired to trigger the LokGlobalStorageManager methods through signal emissions in the scene tree using the inspector, for example. Also, this class can be used to perform certain operations including only some nodes of the current scene.
Version: 1.0.0 Author: github.com/nadjiel <github.com/nadjiel>_
Property Index¶
Type |
Name |
Default value |
|---|---|---|
|
Method Index¶
Property Descriptions¶
LokStorageManager _global_manager = LokGlobalStorageManager¶
The _global_manager property should not be altered since it’s just a reference to the LokGlobalStorageManager autoload. Its reference is stored here instead of called directly to make mocking it with unit testing easier.
Method Descriptions¶
void _push_error_no_manager()¶
The _push_error_no_manager method pushes an error indicating that no LokGlobalStorageManager was found in the _global_manager property, which shouldn’t happen if that property wasn’t altered, as recommended in its description.
Dictionary save_data(String file_id = current_file, String version_number = current_version, LokStorageAccessor <LokStorageAccessor>`[] included_accessors = ``accessors`, bool replace = false)¶
The save_data method is an intermidiate to calling the LokGlobalStorageManager.save_data method. Using this method, though, only the LokAccessorGroup.accessors of this LokSceneStorageManager are included in the saving process, by default. To read more about the parameters and return of this method, see the LokStorageManager.save_data description. The start and finish of this operation is notified via the LokStorageManager.saving_started and LokStorageManager.saving_finished signals.
Dictionary load_data(String file_id = current_file, LokStorageAccessor <LokStorageAccessor>`[] included_accessors = ``accessors`, String <String>`[] partition_ids = ``[]`, String <String>`[] version_numbers = ``[]`)¶
The load_data method is an intermidiate to calling the LokGlobalStorageManager.load_data method. Using this method, though, only the LokAccessorGroup.accessors of this LokSceneStorageManager are included in the loading process, by default. To read more about the parameters and return of this method, see the LokStorageManager.load_data description. The start and finish of this operation is notified via the LokStorageManager.loading_started and LokStorageManager.loading_finished signals.
Dictionary read_data(String file_id = current_file, LokStorageAccessor <LokStorageAccessor>`[] included_accessors = ``accessors`, String <String>`[] partition_ids = ``[]`, String <String>`[] version_numbers = ``[]`)¶
The read_data method is an intermidiate to calling the LokGlobalStorageManager.read_data method. Using this method, though, only the LokAccessorGroup.accessors of this LokSceneStorageManager are included in the reading process, by default. To read more about the parameters and return of this method, see the LokStorageManager.read_data description. The start and finish of this operation is notified via the LokStorageManager.reading_started and LokStorageManager.reading_finished signals.
Dictionary remove_data(String file_id = current_file, LokStorageAccessor <LokStorageAccessor>`[] included_accessors = ``accessors`, String <String>`[] partition_ids = ``[]`, String <String>`[] version_numbers = ``[]`)¶
The remove_data method is an intermidiate to calling the LokGlobalStorageManager.remove_data method. Using this method, though, only the LokAccessorGroup.accessors of this LokSceneStorageManager are included in the removing process, by default. To read more about the parameters and return of this method, see the LokStorageManager.remove_data description. The start and finish of this operation is notified via the LokStorageManager.removing_started and LokStorageManager.removing_finished signals.