Options
All
  • Public
  • Public/Protected
  • All
Menu

Base class for all articy objects

Type parameters

Hierarchy

Index

Constructors

constructor

  • new ArticyObject<PropertiesType, TemplateType>(args: ArticyCreatorArguments<PropertiesType, TemplateType>): ArticyObject<PropertiesType, TemplateType>

Properties

Readonly db

Database owner

Readonly id

id: string

Articy ID (ex. 0x000010003B)

Readonly properties

properties: Readonly<PropertiesType>

Properties loaded from JSON

Optional Readonly template

template: Readonly<TemplateType & Partial<GlobalFeatures>>

Template loaded from JSON

Readonly type

type: string

Type this object was loaded as (ex. DialogueFragment or MyCustomTemplate)

Methods

as

  • Casts to a subtype

    Type parameters

    • ObjectType

    Parameters

    Returns undefined | ObjectType

getChildrenOfType

  • Gets children of a given type

    Type parameters

    • ObjectType

    Parameters

    Returns ObjectType[]

getParent

  • Gets the parent of this object

    Type parameters

    • ObjectType

    Parameters

    Returns undefined | ObjectType

is

  • is(type: string): boolean
  • Checks if this object is the given type or derives from it

    Parameters

    • type: string

      Type to check

    Returns boolean

Legend

  • Constructor
  • Property
  • Method
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Property
  • Method

Generated using TypeDoc