Options
All
  • Public
  • Public/Protected
  • All
Menu

Jumps to a destination node by reference

Type parameters

Hierarchy

Index

Constructors

constructor

  • new Jump<TemplateType>(args: ArticyCreatorArguments<JumpProps, TemplateType>): Jump<TemplateType>

Properties

Readonly InputPins

InputPins: InputPin[]

Input pins leading into this node

Readonly OutputPins

OutputPins: OutputPin[]

Output pins leading out of this node

TargetPin

TargetPin: undefined | InputPin

Readonly db

Database owner

Readonly id

id: string

Articy ID (ex. 0x000010003B)

Readonly properties

properties: Readonly<JumpProps>

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

execute

  • execute(_context: ExecuteContext): void
  • Executes scripts on the node (should do the same as next without the iteration advancement)

    Parameters

    • _context: ExecuteContext

    Returns void

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

needsShadow

  • needsShadow(): boolean

next

numBranches

  • numBranches(): number

visits

  • visits(_context: ExecuteContext): undefined | string | string[]
  • If this returns something other than undefined, then all node Ids returned will be counted as visited at the same time as this node

    Parameters

    • _context: ExecuteContext

      Execution context

    Returns undefined | string | string[]

    Id(s) to visit

Legend

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

Generated using TypeDoc