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

Asset type. Includes images, sounds, etc. stored in Articy.

Type parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

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

Properties

Readonly AssetRef

AssetRef: null | string

Asset reference id. Used to lookup the resolved filename.

Readonly Filename

Filename: null | string

Resolved filename relative to the site root. Can be used in tags, etc.

Readonly db

db: Database

Database owner

Readonly id

id: string

Articy ID (ex. 0x000010003B)

Readonly properties

properties: Readonly<AssetProps>

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