| Package | org.flixel |
| Class | public class FlxSave |
| Property | Defined by | ||
|---|---|---|---|
| data : Object
Allows you to directly access the data container in the local shared object.
| FlxSave | ||
| name : String
The name of the local shared object.
| FlxSave | ||
| Property | Defined by | ||
|---|---|---|---|
| _so : SharedObject
The local shared object itself.
| FlxSave | ||
| Method | Defined by | ||
|---|---|---|---|
|
FlxSave()
Blanks out the containers.
| FlxSave | ||
|
bind(Name:String):Boolean
Automatically creates or reconnects to locally saved data.
| FlxSave | ||
|
erase(MinFileSize:uint = 0):Boolean
Erases everything stored in the local shared object.
| FlxSave | ||
|
forceSave(MinFileSize:uint = 0):Boolean
Writes the local shared object to disk immediately.
| FlxSave | ||
|
read(FieldName:String):Object
If you don't like to access the data object directly, you can use this to read from it.
| FlxSave | ||
|
write(FieldName:String, FieldValue:Object, MinFileSize:uint = 0):Boolean
If you don't like to access the data object directly, you can use this to write to it.
| FlxSave | ||
| data | property |
public var data:ObjectAllows you to directly access the data container in the local shared object.
The default value is null.
| name | property |
public var name:StringThe name of the local shared object.
The default value is null.
| _so | property |
protected var _so:SharedObjectThe local shared object itself.
The default value is null.
| FlxSave | () | constructor |
public function FlxSave()Blanks out the containers.
| bind | () | method |
public function bind(Name:String):BooleanAutomatically creates or reconnects to locally saved data.
ParametersName:String — The name of the object (should be the same each time to access old data).
|
Boolean — Whether or not you successfully connected to the save data.
|
| erase | () | method |
public function erase(MinFileSize:uint = 0):BooleanErases everything stored in the local shared object.
ParametersMinFileSize:uint (default = 0) — If you need X amount of space for your save, specify it here.
|
Boolean — Whether or not the clear and flush was successful.
|
| forceSave | () | method |
public function forceSave(MinFileSize:uint = 0):BooleanWrites the local shared object to disk immediately.
ParametersMinFileSize:uint (default = 0) — If you need X amount of space for your save, specify it here.
|
Boolean — Whether or not the flush was successful.
|
| read | () | method |
public function read(FieldName:String):ObjectIf you don't like to access the data object directly, you can use this to read from it.
ParametersFieldName:String — The name of the data field you want to read
|
Object — The value of the data field you are reading (null if it doesn't exist).
|
| write | () | method |
public function write(FieldName:String, FieldValue:Object, MinFileSize:uint = 0):BooleanIf you don't like to access the data object directly, you can use this to write to it.
ParametersFieldName:String — The name of the data field you want to create or overwrite.
|
|
FieldValue:Object — The data you want to store.
|
|
MinFileSize:uint (default = 0) — If you need X amount of space for your save, specify it here.
|
Boolean — Whether or not the write and flush were successful.
|