Model

View source
ceramic.Entity → tracker.Model (Class) → ceramic.SpriteSheet, ceramic.SpriteSheetAnimation, ceramic.SpriteSheetFrame, ceramic.TilemapData, ceramic.TilemapLayerData, ceramic.Tileset, ceramic.TilesetImage, elements.PendingDialog, elements.Theme, elements.UserData, elements.WindowData
Implements: Serializable, Observable

Instance Members

observedDirty: Bool

Default is false, automatically set to true when any of this instance's observable variables has changed.

serializer: SerializeModel
sharer: ShareModel
dirty: Bool
new(): Void

Events

@event observedDirty(instance: Model, fromSerializedField: Bool)

Event when any observable value as changed on this instance.

Name Type
instance Model
fromSerializedField Bool
onObservedDirty(owner, handler) onceObservedDirty(owner, handler) offObservedDirty(?handler) listensObservedDirty()
@event _modelDirty(model: Model)
Name Type
model Model
on_modelDirty(owner, handler) once_modelDirty(owner, handler) off_modelDirty(?handler) listens_modelDirty()
@event serialize()

Event when this object gets serialized.

onSerialize(owner, handler) onceSerialize(owner, handler) offSerialize(?handler) listensSerialize()
@event deserialize()

Event when this object gets deserialized.

onDeserialize(owner, handler) onceDeserialize(owner, handler) offDeserialize(?handler) listensDeserialize()

Private Members

emitObservedDirty(instance: Model, fromSerializedField: Bool): Void

Event when any observable value as changed on this instance.

Name Type
instance Model
fromSerializedField Bool
emitModelDirty(model: Model): Void

modelDirty event

Name Type
model Model
willSerialize(): Void

Called right before the object will be serialized.

didDeserialize(): Void

Called right after the object has been deserialized. Could be useful to override it to check data integrity when running a newer model version etc...

serializeShouldDestroy(): Bool

Called right before the object is destroyed because it is not used anymore.

Returns Description
Bool true (default) if the destroy should happen or not
hxSerialize(s: haxe.Serializer): Void
Name Type
s haxe.Serializer
hxUnserialize(u: haxe.Unserializer): Void
Name Type
u haxe.Unserializer
emitSerialize(): Void

Event when this object gets serialized.

emitDeserialize(): Void

Event when this object gets deserialized.

Metadata

Name Parameters
:build tracker.macros.SerializableMacro.build()
:autoBuild tracker.macros.SerializableMacro.build()
:build tracker.macros.ObservableMacro.build()
:autoBuild tracker.macros.ObservableMacro.build()
:build ceramic.macros.EntityMacro.buildForCompletion()
:autoBuild ceramic.macros.EntityMacro.buildForCompletion()
:build tracker.macros.EventsMacro.build()
:autoBuild tracker.macros.EventsMacro.build()
:keepSub -