Class ObjectDefinition

Hierarchy

Asset
- ObjectDefinition

Implements

IObjectDefinition

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ObjectDefinition(props?: ObjectProps<ObjectDefinition>): ObjectDefinition

Overrides UniqueObject.constructor
- Defined in src/behavior/ObjectDefinition.ts:26
Parameters
- Optional props: ObjectProps<ObjectDefinition>
Returns ObjectDefinition

Properties

_pins

_pins: ReferenceArray<BasePin> = new ReferenceArray(BasePin)

deleted

deleted: AsyncEvent<string> = new AsyncEvent<string>()

id

id: string

isPersistent

isPersistent: boolean = false

name

name: string

Optional templatePath

templatePath: undefined | string

Accessors

declaration

get declaration(): null | ObjectDeclaration
set declaration(decl: ObjectDeclaration | null): void

- Defined in src/behavior/ObjectDefinition.ts:19
Returns null | ObjectDeclaration
- Defined in src/behavior/ObjectDefinition.ts:16
Parameters
- decl: ObjectDeclaration | null
Returns void

declarationId

get declarationId(): undefined | string

- Defined in src/behavior/ObjectDefinition.ts:20
Returns undefined | string

pins

get pins(): ReferenceArray<BasePin>

- Defined in src/behavior/ObjectDefinition.ts:21
Returns ReferenceArray<BasePin>

Methods

copy

copy(): UniqueObject

Inherited from UniqueObject.copy

Overrides SerializableObject.copy
- Defined in src/core/UniqueObject.ts:24
Returns UniqueObject

deserialize

deserialize(json: SerializedObjectType): Promise<SerializableObject> | SerializableObject

Inherited from SerializableObject.deserialize
- Defined in src/core/SerializableObject.ts:45
Parameters
- json: SerializedObjectType
Returns Promise<SerializableObject> | SerializableObject

destroy

destroy(): void

Overrides Asset.destroy
- Defined in src/behavior/ObjectDefinition.ts:47
Returns void

findPinByName

findPinByName(name: string): undefined | BasePin

- Defined in src/behavior/ObjectDefinition.ts:71
Parameters
- name: string
Returns undefined | BasePin

getPins

getPins(): ReferenceArray<BasePin>

- Defined in src/behavior/ObjectDefinition.ts:63
Returns ReferenceArray<BasePin>

isA

isA<T>(type: object): boolean

Inherited from SerializableObject.isA
- Defined in src/core/SerializableObject.ts:23
Type parameters
- T
Parameters
- type: object
  - constructor: function
    - new __type(...args: any[]): T
    - Defined in src/core/SerializableObject.ts:23
      Parameters
      - Rest ...args: any[]
      Returns T
Returns boolean

isLoaded

isLoaded(): boolean

Overrides Asset.isLoaded
- Defined in src/behavior/ObjectDefinition.ts:38
Returns boolean

save

save(folderPath?: undefined | string): void

Inherited from Asset.save
- Defined in src/assets/Asset.ts:33
Parameters
- Optional folderPath: undefined | string
Returns void

serialize

serialize(): SerializedObjectType

Inherited from SerializableObject.serialize
- Defined in src/core/SerializableObject.ts:41
Returns SerializedObjectType

setPins

setPins(pins: ReferenceArray<BasePin>): void

- Defined in src/behavior/ObjectDefinition.ts:67
Parameters
- pins: ReferenceArray<BasePin>
Returns void

setProperty

setProperty(name: string, value: any): void

Overrides SerializableObject.setProperty
- Defined in src/behavior/ObjectDefinition.ts:56
Parameters
- name: string
- value: any
Returns void

setState

setState<T>(props: ObjectProps<T>): void

Inherited from SerializableObject.setState
- Defined in src/core/SerializableObject.ts:54
Type parameters
- T
Parameters
- props: ObjectProps<T>
Returns void

upgrade

upgrade(json: SerializedObject, previousVersion: number): SerializedObject

Inherited from SerializableObject.upgrade
- Defined in src/core/SerializableObject.ts:50
Parameters
- json: SerializedObject
- previousVersion: number
Returns SerializedObject