articy-js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Link in a location

Type parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new LocationLink<TemplateType>(args: ArticyCreatorArguments<any, any>): LocationLink<TemplateType>

Properties

Optional Readonly Target

Target: ArticyObject<ArticyObjectProps, TemplateProps>

Target of the link (or undefined)

Readonly db

db: Database

Database owner

Readonly id

id: string

Articy ID (ex. 0x000010003B)

Readonly properties

properties: Readonly<LocationLinkProps>

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

getChildrenOfType

getParent

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