@kismet.ts/items / Exports / Events / PodiumStart

Class: PodiumStart

Events.PodiumStart

Hierarchy

• SequenceEvent

  ↳ PodiumStart

Table of contents

Constructors

• constructor

Properties

• clientSideOnly
• commentOptions
• connections
• enabled
• hasBreakpoint
• id
• inputs
• name
• playerOnly
• raw
• rawData
• sequence
• trigger
• type

Accessors

• ClassData
• baseJSON
• category
• linkId
• position
• rawName

Methods

• breakAllLinks
• equals
• getConnection
• hideUnusedConnections
• isAction
• isCondition
• isEvent
• isSequence
• isSequenceActionNode
• isSequenceItem
• isSequenceNode
• isVariable
• on
• setBreakpoint
• setComment
• setDisabled
• setDisplay
• setPosition
• setProperty
• setSequence
• setTrigger
• setVariable
• showAllConnections
• toJSON
• toString
• fromJSON
• fromRaw

Constructors

constructor

• new PodiumStart(options?)

Parameters

Name	Type
options?	BaseKismetEventOptions

Overrides

SequenceEvent.constructor

Defined in

items/src/events/Classes/PodiumStart.ts:3

Properties

clientSideOnly

• clientSideOnly: boolean

See

https://docs.unrealengine.com/udk/Three/KismetUserGuide.html#Client%20Side%20Kismet

Inherited from

SequenceEvent.clientSideOnly

Defined in

core/dist/src/structures/Event.d.ts:16

---

commentOptions

• commentOptions: KismetComment

Inherited from

SequenceEvent.commentOptions

Defined in

core/dist/src/item/base.d.ts:19

---

connections

• connections: KismetConnections

Inherited from

SequenceEvent.connections

Defined in

core/dist/src/item/base.d.ts:20

---

enabled

• enabled: boolean

Inherited from

SequenceEvent.enabled

Defined in

core/dist/src/structures/Event.d.ts:17

---

hasBreakpoint

• hasBreakpoint: boolean

Inherited from

SequenceEvent.hasBreakpoint

Defined in

core/dist/src/item/node.d.ts:5

---

id

• Readonly id: ProcessId

Inherited from

SequenceEvent.id

Defined in

core/dist/src/item/base.d.ts:22

---

inputs

• Protected inputs: Object

Type declaration

Name	Type
input?	string[]
output?	string[]
variable?	string[]

Inherited from

SequenceEvent.inputs

Defined in

core/dist/src/item/base.d.ts:28

---

name

• name: string

Inherited from

SequenceEvent.name

Defined in

core/dist/src/item/base.d.ts:23

---

playerOnly

• playerOnly: boolean

Inherited from

SequenceEvent.playerOnly

Defined in

core/dist/src/structures/Event.d.ts:12

---

raw

• raw: [string, KismetVariableValue][]

Inherited from

SequenceEvent.raw

Defined in

core/dist/src/item/base.d.ts:24

---

rawData

• rawData: BaseKismetItemRawData

Inherited from

SequenceEvent.rawData

Defined in

core/dist/src/item/base.d.ts:25

---

sequence

• sequence: string

Inherited from

SequenceEvent.sequence

Defined in

core/dist/src/item/base.d.ts:21

---

trigger

• trigger: Object

The trigger options for this event

Type declaration

Name	Type
delay	number
maxCount	number

Inherited from

SequenceEvent.trigger

Defined in

core/dist/src/structures/Event.d.ts:8

---

type

• Readonly type: null | SequenceItemTypeName

Inherited from

SequenceEvent.type

Defined in

core/dist/src/item/_base.d.ts:4

Accessors

ClassData

• get ClassData(): Record<"Class" | "ClassType" | "Package", string>

Returns

Record<"Class" | "ClassType" | "Package", string>

Inherited from

SequenceEvent.ClassData

Defined in

core/dist/src/item/base.d.ts:35

---

baseJSON

• Private get baseJSON(): any

Returns

any

Inherited from

SequenceEvent.baseJSON

Defined in

core/dist/src/item/base.d.ts:32

---

category

• get category(): undefined | string

Returns

undefined | string

Inherited from

SequenceEvent.category

Defined in

core/dist/src/item/base.d.ts:34

---

linkId

• get linkId(): string

Returns

string

Inherited from

SequenceEvent.linkId

Defined in

core/dist/src/item/base.d.ts:36

---

position

• get position(): KismetPosition

Returns

KismetPosition

Inherited from

SequenceEvent.position

Defined in

core/dist/src/item/base.d.ts:37

---

rawName

• get rawName(): string

Returns

string

Inherited from

SequenceEvent.rawName

Defined in

core/dist/src/item/base.d.ts:33

Methods

breakAllLinks

▸ breakAllLinks(): void

Break all object links to other items.

Same as the editor right click > Break all links to Object(s)

Returns

void

Inherited from

SequenceEvent.breakAllLinks

Defined in

core/dist/src/item/base.d.ts:43

---

equals

▸ equals(item): boolean

Check whether another item is of the same type as this item

Parameters

Name	Type
item	SequenceItemType

Returns

boolean

Inherited from

SequenceEvent.equals

Defined in

core/dist/src/item/base.d.ts:60

---

getConnection

▸ getConnection(type, connectionName?): null | BaseKismetConnection | KismetConnection

Parameters

Name	Type
type	KismetConnectionType
connectionName?	string

Returns

null | BaseKismetConnection | KismetConnection

Inherited from

SequenceEvent.getConnection

Defined in

core/dist/src/item/base.d.ts:61

---

hideUnusedConnections

▸ hideUnusedConnections(): void

Hide all connection sockets that have no connections currently.

Same as the editor right click > Hide unused connectors

Returns

void

Inherited from

SequenceEvent.hideUnusedConnections

Defined in

core/dist/src/item/base.d.ts:49

---

isAction

▸ isAction(): this is SequenceAction

Returns

this is SequenceAction

Inherited from

SequenceEvent.isAction

Defined in

core/dist/src/item/_base.d.ts:7

---

isCondition

▸ isCondition(): this is SequenceCondition

Returns

this is SequenceCondition

Inherited from

SequenceEvent.isCondition

Defined in

core/dist/src/item/_base.d.ts:8

---

isEvent

▸ isEvent(): this is SequenceEvent<Object>

Returns

this is SequenceEvent<Object>

Inherited from

SequenceEvent.isEvent

Defined in

core/dist/src/item/_base.d.ts:9

---

isSequence

▸ isSequence(): this is Sequence

Returns

this is Sequence

Inherited from

SequenceEvent.isSequence

Defined in

core/dist/src/item/_base.d.ts:10

---

isSequenceActionNode

▸ isSequenceActionNode(): this is SequenceAction | SequenceCondition

Returns

this is SequenceAction | SequenceCondition

Inherited from

SequenceEvent.isSequenceActionNode

Defined in

core/dist/src/item/_base.d.ts:12

---

isSequenceItem

▸ isSequenceItem(): this is SequenceItemType

Returns

this is SequenceItemType

Inherited from

SequenceEvent.isSequenceItem

Defined in

core/dist/src/item/_base.d.ts:11

---

isSequenceNode

▸ isSequenceNode(): this is SequenceAction | SequenceCondition | SequenceEvent<Object>

Returns

this is SequenceAction | SequenceCondition | SequenceEvent<Object>

Inherited from

SequenceEvent.isSequenceNode

Defined in

core/dist/src/item/_base.d.ts:13

---

isVariable

▸ isVariable(): this is SequenceVariable

Returns

this is SequenceVariable

Inherited from

SequenceEvent.isVariable

Defined in

core/dist/src/item/_base.d.ts:14

---

on

▸ on<T>(name, to): PodiumStart

Type parameters

Name	Type
T	extends SequenceNode<T>

Parameters

Name	Type
name	string
to	Object
to.item	T
to.name?	string

Returns

PodiumStart

Inherited from

SequenceEvent.on

Defined in

core/dist/src/structures/Event.d.ts:19

---

setBreakpoint

▸ setBreakpoint(enabled): PodiumStart

Parameters

Name	Type
enabled	boolean

Returns

PodiumStart

Inherited from

SequenceEvent.setBreakpoint

Defined in

core/dist/src/item/node.d.ts:10

---

setComment

▸ setComment(comment): PodiumStart

Set a comment on this item. This comment will be visible in the editor

Parameters

Name	Type	Description
comment	string | { comment?: string ; outputCommentToScreen?: boolean ; supressAutoComment?: boolean }	The text of the comment or the text in combination with comment options

Returns

PodiumStart

Inherited from

SequenceEvent.setComment

Defined in

core/dist/src/item/base.d.ts:66

---

setDisabled

▸ setDisabled(): PodiumStart

Disable this event

Returns

PodiumStart

Inherited from

SequenceEvent.setDisabled

Defined in

core/dist/src/structures/Event.d.ts:26

---

setDisplay

▸ setDisplay(options): PodiumStart

Set the client / player display options

Parameters

Name	Type
options	Object
options.client?	boolean
options.player?	boolean

Returns

PodiumStart

Inherited from

SequenceEvent.setDisplay

Defined in

core/dist/src/structures/Event.d.ts:31

---

setPosition

▸ setPosition(position, offset?): PodiumStart

Set a new position for this item

Parameters

Name	Type	Description
position	KismetPosition	The new position coordinates
offset?	boolean	Whether to use the new position as an offset to the current position (default: false)

Returns

PodiumStart

Inherited from

SequenceEvent.setPosition

Defined in

core/dist/src/item/base.d.ts:76

---

setProperty

▸ setProperty(...properties): PodiumStart

Set a variable if the variable has no variable connection. Used for properties you can set in the properties screen in the editor.

Parameters

Name	Type	Description
...properties	{ name: string ; value: KismetVariableValue }[]	The properties to set. Will not overwrite currently set properties

Returns

PodiumStart

Inherited from

SequenceEvent.setProperty

Defined in

core/dist/src/item/base.d.ts:82

---

setSequence

▸ setSequence(sequence, addToSequence?): PodiumStart

Change the sequence of this item

Parameters

Name	Type	Description
sequence	string | Sequence	The new sequence of this item: the linkId or the sequence itself
addToSequence?	boolean	If 'sequence' is the new sequence, whether to add the item to the sequence

Returns

PodiumStart

Inherited from

SequenceEvent.setSequence

Defined in

core/dist/src/item/base.d.ts:91

---

setTrigger

▸ setTrigger(options): PodiumStart

Set the trigger options for this event

Parameters

Name	Type
options	Object
options.delay?	number
options.max?	number

Returns

PodiumStart

Inherited from

SequenceEvent.setTrigger

Defined in

core/dist/src/structures/Event.d.ts:39

---

setVariable

▸ setVariable(variableName, value, hidden?): PodiumStart

Parameters

Name	Type
variableName	string
value	string | number | SequenceVariable
hidden?	boolean

Returns

PodiumStart

Inherited from

SequenceEvent.setVariable

Defined in

core/dist/src/item/node.d.ts:11

---

showAllConnections

▸ showAllConnections(): void

Show all connection sockets.

Same as the editor right click > Show all connectors

Returns

void

Inherited from

SequenceEvent.showAllConnections

Defined in

core/dist/src/item/base.d.ts:55

---

toJSON

▸ toJSON(): Record<string, KismetVariableValue>

Returns

Record<string, KismetVariableValue>

Inherited from

SequenceEvent.toJSON

Defined in

core/dist/src/structures/Event.d.ts:43

---

toString

▸ toString(): string

Returns

string

Inherited from

SequenceEvent.toString

Defined in

core/dist/src/structures/Event.d.ts:44

---

fromJSON

▸ Static fromJSON(input): BaseSequenceItem

Converts an object to an item ands sets all other variables on the item. Special object keys:

Parameters

Name	Type
input	Record<string, KismetVariableValue>

Returns

BaseSequenceItem

Inherited from

SequenceEvent.fromJSON

Defined in

core/dist/src/item/base.d.ts:107

---

fromRaw

▸ Static fromRaw(input): BaseSequenceItem

Converts a two dimensional array of properties to an object. Then calls BaseSequenceItem.fromJSON with the object

Parameters

Name	Type
input	[string, KismetVariableValue][]

Returns

BaseSequenceItem

Inherited from

SequenceEvent.fromRaw

Defined in

core/dist/src/item/base.d.ts:99