LocationImage | articy-js

Image in a location

Type parameters

TemplateType: TemplateProps = TemplateProps

Hierarchy

Zone<TemplateType, LocationImageProps>
- LocationImage

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new LocationImage<TemplateType>(args: ArticyCreatorArguments<LocationImageProps, TemplateType>): LocationImage<TemplateType>

Inherited from Zone.constructor
- Defined in types.ts:47
Type parameters
- TemplateType: TemplateProps = TemplateProps
Parameters
- args: ArticyCreatorArguments<LocationImageProps, TemplateType>
Returns LocationImage<TemplateType>

Properties

Readonly db

Database owner

Readonly id

id: string

Articy ID (ex. 0x000010003B)

Readonly properties

properties: Readonly<LocationImageProps>

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

as<ObjectType>(type: ArticyObjectCreator<ObjectType>): undefined | ObjectType

Inherited from Zone.as
- Defined in types.ts:67
Casts to a subtype

Type parameters
- ObjectType
Parameters
- type: ArticyObjectCreator<ObjectType>
  
  Subtype
Returns undefined | ObjectType

getChildrenOfType

getChildrenOfType<ObjectType>(creator: ArticyObjectCreator<ObjectType>): ObjectType[]

Inherited from Zone.getChildrenOfType
- Defined in types.ts:80
Gets children of a given type

Type parameters
- ObjectType
Parameters
- creator: ArticyObjectCreator<ObjectType>
  
  Child type constructor
Returns ObjectType[]

getParent

getParent<ObjectType>(type: ArticyObjectCreator<ObjectType>): undefined | ObjectType

Inherited from Zone.getParent
- Defined in types.ts:87
Gets the parent of this object

Type parameters
- ObjectType
Parameters
- type: ArticyObjectCreator<ObjectType>
Returns undefined | ObjectType

is

is(type: string): boolean

Inherited from Zone.is
- Defined in types.ts:59
Checks if this object is the given type or derives from it

Parameters
- type: string
  
  Type to check
Returns boolean

Generated using TypeDoc