@kismet.ts/items / Exports / Actions / SetTextureParam
Class: SetTextureParam
Actions.SetTextureParam
Hierarchy
SequenceAction
↳
SetTextureParam
Table of contents
Constructors
Properties
Accessors
Methods
- addOutputConnection
- breakAllLinks
- equals
- getConnection
- hideUnusedConnections
- isAction
- isCondition
- isEvent
- isSequence
- isSequenceActionNode
- isSequenceItem
- isSequenceNode
- isVariable
- setBreakpoint
- setComment
- setPosition
- setProperty
- setSequence
- setTargets
- setVariable
- showAllConnections
- toJSON
- toString
- fromJSON
- fromRaw
Constructors
constructor
• new SetTextureParam(options?
)
Parameters
Name | Type |
---|---|
options? | BaseKismetActionOptions |
Overrides
SequenceAction.constructor
Defined in
items/src/actions/Classes/SetTextureParam.ts:3
Properties
commentOptions
• commentOptions: KismetComment
Inherited from
SequenceAction.commentOptions
Defined in
core/dist/src/item/base.d.ts:19
connections
• connections: KismetConnections
Inherited from
SequenceAction.connections
Defined in
core/dist/src/item/base.d.ts:20
hasBreakpoint
• hasBreakpoint: boolean
Inherited from
SequenceAction.hasBreakpoint
Defined in
core/dist/src/item/node.d.ts:5
id
• Readonly
id: ProcessId
Inherited from
SequenceAction.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
SequenceAction.inputs
Defined in
core/dist/src/item/base.d.ts:28
name
• name: string
Inherited from
SequenceAction.name
Defined in
core/dist/src/item/base.d.ts:23
raw
• raw: [string
, KismetVariableValue
][]
Inherited from
SequenceAction.raw
Defined in
core/dist/src/item/base.d.ts:24
rawData
• rawData: BaseKismetItemRawData
Inherited from
SequenceAction.rawData
Defined in
core/dist/src/item/base.d.ts:25
sequence
• sequence: string
Inherited from
SequenceAction.sequence
Defined in
core/dist/src/item/base.d.ts:21
type
• Readonly
type: null
| SequenceItemTypeName
Inherited from
SequenceAction.type
Defined in
core/dist/src/item/_base.d.ts:4
Variables
▪ Static
Variables: Object
Type declaration
Name | Type |
---|---|
MatInst | string |
NewTexture | string |
ParamName | string |
Defined in
items/src/actions/Classes/SetTextureParam.ts:15
Accessors
ClassData
• get
ClassData(): Record
<"Class"
| "ClassType"
| "Package"
, string
>
Returns
Record
<"Class"
| "ClassType"
| "Package"
, string
>
Inherited from
SequenceAction.ClassData
Defined in
core/dist/src/item/base.d.ts:35
baseJSON
• Private
get
baseJSON(): any
Returns
any
Inherited from
SequenceAction.baseJSON
Defined in
core/dist/src/item/base.d.ts:32
category
• get
category(): undefined
| string
Returns
undefined
| string
Inherited from
SequenceAction.category
Defined in
core/dist/src/item/base.d.ts:34
linkId
• get
linkId(): string
Returns
string
Inherited from
SequenceAction.linkId
Defined in
core/dist/src/item/base.d.ts:36
position
• get
position(): KismetPosition
Returns
KismetPosition
Inherited from
SequenceAction.position
Defined in
core/dist/src/item/base.d.ts:37
rawName
• get
rawName(): string
Returns
string
Inherited from
SequenceAction.rawName
Defined in
core/dist/src/item/base.d.ts:33
Methods
addOutputConnection
▸ addOutputConnection(from
, to
): SetTextureParam
Adds a new output connection
Parameters
Name | Type | Description |
---|---|---|
from | Object | Data from this node |
from.name | string | - |
to | Object | The node to connect to |
to.item | SequenceNode | - |
to.name | string | - |
Returns
Inherited from
SequenceAction.addOutputConnection
Defined in
core/dist/src/structures/Action.d.ts:13
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
SequenceAction.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
SequenceAction.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
SequenceAction.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
SequenceAction.hideUnusedConnections
Defined in
core/dist/src/item/base.d.ts:49
isAction
▸ isAction(): this is SequenceAction
Returns
this is SequenceAction
Inherited from
SequenceAction.isAction
Defined in
core/dist/src/item/_base.d.ts:7
isCondition
▸ isCondition(): this is SequenceCondition
Returns
this is SequenceCondition
Inherited from
SequenceAction.isCondition
Defined in
core/dist/src/item/_base.d.ts:8
isEvent
▸ isEvent(): this is SequenceEvent<Object>
Returns
this is SequenceEvent<Object>
Inherited from
SequenceAction.isEvent
Defined in
core/dist/src/item/_base.d.ts:9
isSequence
▸ isSequence(): this is Sequence
Returns
this is Sequence
Inherited from
SequenceAction.isSequence
Defined in
core/dist/src/item/_base.d.ts:10
isSequenceActionNode
▸ isSequenceActionNode(): this is SequenceAction | SequenceCondition
Returns
this is SequenceAction | SequenceCondition
Inherited from
SequenceAction.isSequenceActionNode
Defined in
core/dist/src/item/_base.d.ts:12
isSequenceItem
▸ isSequenceItem(): this is SequenceItemType
Returns
this is SequenceItemType
Inherited from
SequenceAction.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
SequenceAction.isSequenceNode
Defined in
core/dist/src/item/_base.d.ts:13
isVariable
▸ isVariable(): this is SequenceVariable
Returns
this is SequenceVariable
Inherited from
SequenceAction.isVariable
Defined in
core/dist/src/item/_base.d.ts:14
setBreakpoint
▸ setBreakpoint(enabled
): SetTextureParam
Parameters
Name | Type |
---|---|
enabled | boolean |
Returns
Inherited from
SequenceAction.setBreakpoint
Defined in
core/dist/src/item/node.d.ts:10
setComment
▸ setComment(comment
): SetTextureParam
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
Inherited from
SequenceAction.setComment
Defined in
core/dist/src/item/base.d.ts:66
setPosition
▸ setPosition(position
, offset?
): SetTextureParam
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
Inherited from
SequenceAction.setPosition
Defined in
core/dist/src/item/base.d.ts:76
setProperty
▸ setProperty(...properties
): SetTextureParam
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
Inherited from
SequenceAction.setProperty
Defined in
core/dist/src/item/base.d.ts:82
setSequence
▸ setSequence(sequence
, addToSequence?
): SetTextureParam
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
Inherited from
SequenceAction.setSequence
Defined in
core/dist/src/item/base.d.ts:91
setTargets
▸ setTargets(objects
): SetTextureParam
Set the targets for this node
Parameters
Name | Type | Description |
---|---|---|
objects | string [] | The object references to the targets |
Returns
Inherited from
SequenceAction.setTargets
Defined in
core/dist/src/structures/Action.d.ts:23
setVariable
▸ setVariable(variableName
, value
, hidden?
): SetTextureParam
Parameters
Name | Type |
---|---|
variableName | string |
value | string | number | SequenceVariable |
hidden? | boolean |
Returns
Inherited from
SequenceAction.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
SequenceAction.showAllConnections
Defined in
core/dist/src/item/base.d.ts:55
toJSON
▸ toJSON(): Record
<string
, KismetVariableValue
>
Returns
Record
<string
, KismetVariableValue
>
Inherited from
SequenceAction.toJSON
Defined in
core/dist/src/item/node.d.ts:12
toString
▸ toString(): string
Returns
string
Inherited from
SequenceAction.toString
Defined in
core/dist/src/item/node.d.ts:13
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
SequenceAction.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
SequenceAction.fromRaw
Defined in
core/dist/src/item/base.d.ts:99