BaseFlowNode | articy-js

Base class for all flow nodes

Type parameters

PropertiesType: FlowObjectProps = FlowObjectProps

Property block interface
TemplateType: TemplateProps = TemplateProps

Template block interface

Hierarchy

ArticyObject<PropertiesType, TemplateType>
- BaseFlowNode
  - BasePinnedObject

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BaseFlowNode<PropertiesType, TemplateType>(args: ArticyCreatorArguments<PropertiesType, TemplateType>): BaseFlowNode<PropertiesType, TemplateType>

Inherited from ArticyObject.constructor
- Defined in types.ts:47
Type parameters
- PropertiesType: FlowObjectProps = FlowObjectProps
- TemplateType: TemplateProps = TemplateProps
Parameters
- args: ArticyCreatorArguments<PropertiesType, TemplateType>
Returns BaseFlowNode<PropertiesType, TemplateType>

Properties

Readonly db

Database owner

Readonly id

id: string

Articy ID (ex. 0x000010003B)

Readonly properties

properties: Readonly<PropertiesType>

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 ArticyObject.as
- Defined in types.ts:67
Casts to a subtype

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

execute

execute(_context: ExecuteContext): void

- Defined in flowTypes.ts:80
Executes scripts on the node (should do the same as next without the iteration advancement)

Parameters
- _context: ExecuteContext
Returns void

getChildrenOfType

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

Inherited from ArticyObject.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 ArticyObject.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 ArticyObject.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

needsShadow

needsShadow(): boolean

- Defined in flowTypes.ts:73
Return true if this node might modify the variable state during a call to next()

Returns boolean

next

next(_context: ExecuteContext, _branchIndex: number, _last: null | string, _shadowing: boolean): [undefined | BaseFlowNode<FlowObjectProps, TemplateProps>, undefined | ConnectionProps]

- Defined in flowTypes.ts:48
Returns the next node along the given branch index

Parameters
- _context: ExecuteContext
- _branchIndex: number
- _last: null | string
- _shadowing: boolean
Returns [undefined | BaseFlowNode<FlowObjectProps, TemplateProps>, undefined | ConnectionProps]

The next node along the branch (or undefined) and any Incoming/Outgoing Connection that was used to get there.

numBranches

numBranches(_context: ExecuteContext, _last: null | string, _shadowing: boolean): number

- Defined in flowTypes.ts:62
Returns the number of valid branches at this node

Parameters
- _context: ExecuteContext
- _last: null | string
- _shadowing: boolean
Returns number

Number of valid branches (so, not branches with failing conditions)

visits

visits(_context: ExecuteContext): undefined | string | string[]

- Defined in flowTypes.ts:89
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

Generated using TypeDoc