Options
All
  • Public
  • Public/Protected
  • All
Menu

Wrapper for FlowBranch that resolves the path IDs into their resolved Articy Objects.

Type parameters

Hierarchy

  • ResolvedBranch

Index

Constructors

constructor

Properties

Readonly branchedFrom

branchedFrom: string

In the case of additional pages, this tracks what node this branch is actually coming off of.

Readonly index

index: number

Branch index. Used when calling the continue function in iteration.

Readonly path

Full branch path from current flow node to the terminal node.

Methods

destination

  • destination(): DestinationType
  • Returns the terminal node

    Returns DestinationType

destinationAs

  • destinationAs<ObjectType>(type: ArticyObjectCreator<ObjectType>, typeString?: string): undefined | ObjectType
  • Returns the terminal node as the specified type or undefined if it doesn't match. Can combine class type with string type. Will only return non-undefined if it matches both.

    Type parameters

    Parameters

    Returns undefined | ObjectType

destinationIs

pathHas

  • pathHas<ObjectType>(type: ArticyObjectCreator<ObjectType>, typeString: string): undefined | ObjectType
  • Like destinationAs but checks along the path for the first matching node

    Type parameters

    • ObjectType

    Parameters

    Returns undefined | ObjectType

Legend

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

Generated using TypeDoc