Packageru.antkarlov.anthill
Classpublic class AntCookie
InheritanceAntCookie Inheritance Object

Language Version : ActionScript 3
Since : 23.08.2012
Runtime Versions : AIR 1.0, Flash Player 9.0.0

Обертка для работы с SharedObject для создания локальных игровых сохранений.



Public Properties
 PropertyDefined By
  data : Object
Указатель на данные в хранилище.
AntCookie
  name : String
Имя хранилища.
AntCookie
Protected Properties
 PropertyDefined By
  _share : SharedObject
Указатель на SharedObject.
AntCookie
Public Methods
 MethodDefined By
  
AntCookie
  
clear(aMinFileSize:uint = 0):Boolean
Очищает хранилище.
AntCookie
  
forceSave(aMinFileSize:uint = 0):Boolean
Принудительное сохранение данных в хранилище.
AntCookie
  
open(aName:String):Boolean
Открывает хранилище с указанным именем для работы.
AntCookie
  
read(aKey:String):Object
Считывает данные из хранилища.
AntCookie
  
toString():String
Возвращает все содержимое хранилища в виде текстовой строки.
AntCookie
  
write(aKey:String, aValue:Object, aMinFileSize:uint = 0):Boolean
Записывает данные в хранилище.
AntCookie
Property Detail
_shareproperty
protected var _share:SharedObject

Указатель на SharedObject.

dataproperty 
public var data:Object

Указатель на данные в хранилище.

nameproperty 
public var name:String

Имя хранилища.

Constructor Detail
AntCookie()Constructor
public function AntCookie()

Method Detail
clear()method
public function clear(aMinFileSize:uint = 0):Boolean

Очищает хранилище.

Parameters

aMinFileSize:uint (default = 0) — Минимальный размер файла хранилища в байтах. Используется если необходимо гарантированно получить необходимый объем дискового пространства для сохранения.

Returns
Boolean — Возвращает true если хранилище успешно очищено.
forceSave()method 
public function forceSave(aMinFileSize:uint = 0):Boolean

Принудительное сохранение данных в хранилище.

Parameters

aMinFileSize:uint (default = 0) — Минимальный размер файла хранилища в байтах. Используется если необходимо гарантированно получить необходимый объем дискового пространства для сохранения.

Returns
Boolean — Возвращает true если сохранение прошло успешно.
open()method 
public function open(aName:String):Boolean

Открывает хранилище с указанным именем для работы. Данный метод метод необходимо вызывать прежде чем считывать и записывать данные.

Parameters

aName:String — Имя хранилища.

Returns
Boolean — Возвращает true если хранилище открыто и готово к работе.
read()method 
public function read(aKey:String):Object

Считывает данные из хранилища.

Parameters

aKey:String — Имя данных которые необходимо считать.

Returns
Object — Возвращает null если данных с указанным именем не существует или если хранилище не доступно.
toString()method 
public function toString():String

Возвращает все содержимое хранилища в виде текстовой строки. Используется для просмотра содержимого хранилища в отладочных целях.

Returns
String
write()method 
public function write(aKey:String, aValue:Object, aMinFileSize:uint = 0):Boolean

Записывает данные в хранилище.

Parameters

aKey:String — Ключевое имя записываемых данных по которому их потом можно будет извлеч.
 
aValue:Object — Значение или какие либо данные которые необходимо сохранить в хранилище.
 
aMinFileSize:uint (default = 0) — Минимальный размер файла хранилища в байтах. Используется если необходимо гарантированно получить необходимый объем дискового пространства для сохранения.

Returns
Boolean — Возвращает true если данные успешно записаны в хранилище.