unreal.MagicLeapSecureStorage

class unreal.MagicLeapSecureStorage(outer=None, name='None')

Bases: unreal.BlueprintFunctionLibrary

Function library for the Magic Leap Secure Storage API. Currently supports bool, uint8, int32, float, FString, FVector, FRotator and FTransform via Blueprints. Provides a template function for any non specialized types to be used via C++.

C++ Source:

• Plugin: MagicLeap

• Module: MagicLeapSecureStorage

• File: MagicLeapSecureStorage.h

classmethod delete_secure_data(key) → bool

Deletes the data associated with the specified key. deprecated: This function has been replaced by UGameplayStatics::SaveGameToSlot()

Parameters

key (str) – The string key of the data to delete.

Returns

True if the data was deleted successfully or did not exist altogether, false otherwise.

Return type

bool

classmethod get_secure_bool(key) → bool or None

Retrieves the boolean associated with the specified key. deprecated: This function has been replaced by UGameplayStatics::SaveGameToSlot()

Parameters

key (str) – The string key to look for.

Returns

True if the key was found and output parameter was successfully populated with the data, false otherwise.

data_to_retrieve (bool): Reference to the variable that will be populated with the stored data.

Return type

bool or None

classmethod get_secure_byte(key) → uint8 or None

Retrieves the byte (uint8) associated with the specified key. deprecated: This function has been replaced by UGameplayStatics::SaveGameToSlot()

Parameters

key (str) – The string key to look for.

Returns

True if the key was found and output parameter was successfully populated with the data, false otherwise.

data_to_retrieve (uint8): Reference to the variable that will be populated with the stored data.

Return type

uint8 or None

classmethod get_secure_float(key) → float or None

Retrieves the float associated with the specified key. deprecated: This function has been replaced by UGameplayStatics::SaveGameToSlot()

Parameters

key (str) – The string key to look for.

Returns

True if the key was found and output parameter was successfully populated with the data, false otherwise.

data_to_retrieve (float): Reference to the variable that will be populated with the stored data.

Return type

float or None

classmethod get_secure_int(key) → int32 or None

Retrieves the integer (int32) associated with the specified key. deprecated: This function has been replaced by UGameplayStatics::SaveGameToSlot()

Parameters

key (str) – The string key to look for.

Returns

True if the key was found and output parameter was successfully populated with the data, false otherwise.

data_to_retrieve (int32): Reference to the variable that will be populated with the stored data.

Return type

int32 or None

classmethod get_secure_int64(key) → int64 or None

Retrieves the 64 bit integer associated with the specified key. deprecated: This function has been replaced by UGameplayStatics::SaveGameToSlot()

Parameters

key (str) – The string key to look for.

Returns

True if the key was found and output parameter was successfully populated with the data, false otherwise.

data_to_retrieve (int64): Reference to the variable that will be populated with the stored data.

Return type

int64 or None

classmethod get_secure_rotator(key) → Rotator or None

Retrieves the rotator associated with the specified key. deprecated: This function has been replaced by UGameplayStatics::SaveGameToSlot()

Parameters

key (str) – The string key to look for.

Returns

True if the key was found and output parameter was successfully populated with the data, false otherwise.

data_to_retrieve (Rotator): Reference to the variable that will be populated with the stored data.

Return type

Rotator or None

classmethod get_secure_save_game(key) → SaveGame or None

Retrieves a USaveGame object associated with the specified key. deprecated: This function has been replaced by UGameplayStatics::SaveGameToSlot()

Parameters

key (str) – The string key to look for.

Returns

True if the key was found and output parameter was successfully populated with the data, false otherwise.

object_to_retrieve (SaveGame): Reference to a USaveGame object that will be populated with the serialized data.

Return type

SaveGame or None

classmethod get_secure_string(key) → str or None

Retrieves the string associated with the specified key. deprecated: This function has been replaced by UGameplayStatics::SaveGameToSlot()

Parameters

key (str) – The string key to look for.

Returns

True if the key was found and output parameter was successfully populated with the data, false otherwise.

data_to_retrieve (str): Reference to the variable that will be populated with the stored data.

Return type

str or None

classmethod get_secure_transform(key) → Transform or None

Retrieves the transform associated with the specified key. deprecated: This function has been replaced by UGameplayStatics::SaveGameToSlot()

Parameters

key (str) – The string key to look for.

Returns

True if the key was found and output parameter was successfully populated with the data, false otherwise.

data_to_retrieve (Transform): Reference to the variable that will be populated with the stored data.

Return type

Transform or None

classmethod get_secure_vector(key) → Vector or None

Retrieves the vector associated with the specified key. deprecated: This function has been replaced by UGameplayStatics::SaveGameToSlot()

Parameters

key (str) – The string key to look for.

Returns

True if the key was found and output parameter was successfully populated with the data, false otherwise.

data_to_retrieve (Vector): Reference to the variable that will be populated with the stored data.

Return type

Vector or None

classmethod put_secure_bool(key, data_to_store) → bool

Stores the boolean under the specified key. An existing key would be overwritten. deprecated: This function has been replaced by UGameplayStatics::SaveGameToSlot()

Parameters

• key (str) – String key associated with the data.

• data_to_store (bool) – The data to store.

Returns

True if the data was stored successfully, false otherwise.

Return type

bool

classmethod put_secure_byte(key, data_to_store) → bool

Stores the byte (uint8) under the specified key. An existing key would be overwritten. deprecated: This function has been replaced by UGameplayStatics::SaveGameToSlot()

Parameters

• key (str) – String key associated with the data.

• data_to_store (uint8) – The data to store.

Returns

True if the data was stored successfully, false otherwise.

Return type

bool

classmethod put_secure_float(key, data_to_store) → bool

Stores the float under the specified key. An existing key would be overwritten. deprecated: This function has been replaced by UGameplayStatics::SaveGameToSlot()

Parameters

• key (str) – String key associated with the data.

• data_to_store (float) – The data to store.

Returns

True if the data was stored successfully, false otherwise.

Return type

bool

classmethod put_secure_int(key, data_to_store) → bool

Stores the integer (int32) under the specified key. An existing key would be overwritten. deprecated: This function has been replaced by UGameplayStatics::SaveGameToSlot()

Parameters

• key (str) – String key associated with the data.

• data_to_store (int32) – The data to store.

Returns

True if the data was stored successfully, false otherwise.

Return type

bool

classmethod put_secure_int64(key, data_to_store) → bool

Stores the 64 bit integer under the specified key. An existing key would be overwritten. deprecated: This function has been replaced by UGameplayStatics::SaveGameToSlot()

Parameters

• key (str) – String key associated with the data.

• data_to_store (int64) – The data to store.

Returns

True if the data was stored successfully, false otherwise.

Return type

bool

classmethod put_secure_rotator(key, data_to_store) → bool

Stores the rotator under the specified key. An existing key would be overwritten. deprecated: This function has been replaced by UGameplayStatics::SaveGameToSlot()

Parameters

• key (str) – String key associated with the data.

• data_to_store (Rotator) – The data to store.

Returns

True if the data was stored successfully, false otherwise.

Return type

bool

classmethod put_secure_save_game(key, object_to_store) → bool

Stores the USaveGame object under the specified key. An existing key would be overwritten. deprecated: This function has been replaced by UGameplayStatics::SaveGameToSlot()

Parameters

• key (str) – String key associated with the data.

• object_to_store (SaveGame) – The USaveGame object to serialize and store.

Returns

True if the data was stored successfully, false otherwise.

Return type

bool

classmethod put_secure_string(key, data_to_store) → bool

Stores the string under the specified key. An existing key would be overwritten. deprecated: This function has been replaced by UGameplayStatics::SaveGameToSlot()

Parameters

• key (str) – String key associated with the data.

• data_to_store (str) – The data to store.

Returns

True if the data was stored successfully, false otherwise.

Return type

bool

classmethod put_secure_transform(key, data_to_store) → bool

Stores the transform under the specified key. An existing key would be overwritten. deprecated: This function has been replaced by UGameplayStatics::SaveGameToSlot()

Parameters

• key (str) – String key associated with the data.

• data_to_store (Transform) – The data to store.

Returns

True if the data was stored successfully, false otherwise.

Return type

bool

classmethod put_secure_vector(key, data_to_store) → bool

Stores the vector under the specified key. An existing key would be overwritten. deprecated: This function has been replaced by UGameplayStatics::SaveGameToSlot()

Parameters

• key (str) – String key associated with the data.

• data_to_store (Vector) – The data to store.

Returns

True if the data was stored successfully, false otherwise.

Return type

bool