OutputPin | articy-js

An output pin with an optional script

Hierarchy

BasePin
- OutputPin

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new OutputPin(args: ArticyCreatorArguments<PinProps, TemplateProps>): OutputPin

Inherited from BasePin.constructor
- Defined in types.ts:47
Parameters
- args: ArticyCreatorArguments<PinProps, TemplateProps>
Returns OutputPin

Properties

Readonly db

Database owner

Readonly id

id: string

Articy ID (ex. 0x000010003B)

Readonly properties

properties: Readonly<PinProps>

Properties loaded from JSON

Optional Readonly template

template: Readonly<TemplateProps & 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 BasePin.as
- Defined in types.ts:67
Casts to a subtype

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

connections

connections(): ConnectionProps[]

Inherited from BasePin.connections
- Defined in flowTypes.ts:136
Returns all Incoming or Outgoing connections to/from this pin.

Returns ConnectionProps[]

List of connections

execute

execute(context: ExecuteContext): void

Overrides BasePin.execute
- Defined in flowTypes.ts:187
Parameters
- context: ExecuteContext
Returns void

getChildrenOfType

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

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

Overrides BasePin.needsShadow
- Defined in flowTypes.ts:183
Returns boolean

next

next(context: ExecuteContext, branchIndex: number, _last: null | string, shadowing: boolean): [undefined | BaseFlowNode<FlowObjectProps, TemplateProps>, undefined | ConnectionProps]

Overrides BasePin.next
- Defined in flowTypes.ts:158
Parameters
- context: ExecuteContext
- branchIndex: number
- _last: null | string
- shadowing: boolean
Returns [undefined | BaseFlowNode<FlowObjectProps, TemplateProps>, undefined | ConnectionProps]

numBranches

numBranches(): number

Overrides BasePin.numBranches
- Defined in flowTypes.ts:179
Returns number

visits

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

Inherited from BasePin.visits
- 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