@kismet.ts/items / Exports / Variables / RandomFloat

Class: RandomFloat

Variables.RandomFloat

Hierarchy

• Float

  ↳ RandomFloat

Table of contents

Constructors

• constructor

Properties

• allowIntegers
• commentOptions
• connections
• id
• inputs
• maxValue
• minValue
• name
• raw
• rawData
• sequence
• type
• value
• variableName

Accessors

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

Methods

• _ValidateFloatNumber
• breakAllLinks
• equals
• getConnection
• hideUnusedConnections
• isAction
• isCondition
• isEvent
• isSequence
• isSequenceActionNode
• isSequenceItem
• isSequenceNode
• isVariable
• setComment
• setMaxValue
• setMinValue
• setName
• setPosition
• setProperty
• setSequence
• setValue
• showAllConnections
• toJSON
• toString
• fromJSON
• fromRaw

Constructors

constructor

• new RandomFloat(options?)

Parameters

Name	Type
options?	BaseKismetVariableOptions & { allowIntegers?: boolean }

Overrides

Float.constructor

Defined in

items/src/variables/Float.ts:44

Properties

allowIntegers

• allowIntegers: boolean

Inherited from

Float.allowIntegers

Defined in

items/src/variables/Float.ts:6

---

commentOptions

• commentOptions: KismetComment

Inherited from

Float.commentOptions

Defined in

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

---

connections

• connections: KismetConnections

Inherited from

Float.connections

Defined in

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

---

id

• Readonly id: ProcessId

Inherited from

Float.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

Float.inputs

Defined in

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

---

maxValue

• maxValue: number = 1.0

Defined in

items/src/variables/Float.ts:42

---

minValue

• minValue: number = 0.0

Defined in

items/src/variables/Float.ts:41

---

name

• name: string

Inherited from

Float.name

Defined in

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

---

raw

• raw: [string, KismetVariableValue][]

Inherited from

Float.raw

Defined in

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

---

rawData

• rawData: BaseKismetItemRawData

Inherited from

Float.rawData

Defined in

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

---

sequence

• sequence: string

Inherited from

Float.sequence

Defined in

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

---

type

• Readonly type: null | SequenceItemTypeName

Inherited from

Float.type

Defined in

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

---

value

• value: number = 0.0

Inherited from

Float.value

Defined in

items/src/variables/Float.ts:5

---

variableName

• variableName: null | string

Inherited from

Float.variableName

Defined in

core/dist/src/structures/Variable.d.ts:4

Accessors

ClassData

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

Returns

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

Inherited from

FloatVariable.ClassData

Defined in

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

---

baseJSON

• Private get baseJSON(): any

Returns

any

Inherited from

FloatVariable.baseJSON

Defined in

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

---

category

• get category(): undefined | string

Returns

undefined | string

Inherited from

FloatVariable.category

Defined in

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

---

linkId

• get linkId(): string

Returns

string

Inherited from

FloatVariable.linkId

Defined in

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

---

position

• get position(): KismetPosition

Returns

KismetPosition

Inherited from

FloatVariable.position

Defined in

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

---

rawName

• get rawName(): string

Returns

string

Inherited from

FloatVariable.rawName

Defined in

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

Methods

_ValidateFloatNumber

▸ Protected _ValidateFloatNumber(value): void

Parameters

Name	Type
value	number

Returns

void

Inherited from

Float._ValidateFloatNumber

Defined in

items/src/variables/Float.ts:18

---

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

Float.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

Float.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

Float.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

Float.hideUnusedConnections

Defined in

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

---

isAction

▸ isAction(): this is SequenceAction

Returns

this is SequenceAction

Inherited from

Float.isAction

Defined in

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

---

isCondition

▸ isCondition(): this is SequenceCondition

Returns

this is SequenceCondition

Inherited from

Float.isCondition

Defined in

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

---

isEvent

▸ isEvent(): this is SequenceEvent<Object>

Returns

this is SequenceEvent<Object>

Inherited from

Float.isEvent

Defined in

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

---

isSequence

▸ isSequence(): this is Sequence

Returns

this is Sequence

Inherited from

Float.isSequence

Defined in

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

---

isSequenceActionNode

▸ isSequenceActionNode(): this is SequenceAction | SequenceCondition

Returns

this is SequenceAction | SequenceCondition

Inherited from

Float.isSequenceActionNode

Defined in

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

---

isSequenceItem

▸ isSequenceItem(): this is SequenceItemType

Returns

this is SequenceItemType

Inherited from

Float.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

Float.isSequenceNode

Defined in

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

---

isVariable

▸ isVariable(): this is SequenceVariable

Returns

this is SequenceVariable

Inherited from

Float.isVariable

Defined in

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

---

setComment

▸ setComment(comment): RandomFloat

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

RandomFloat

Inherited from

Float.setComment

Defined in

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

---

setMaxValue

▸ setMaxValue(max): RandomFloat

Parameters

Name	Type
max	number

Returns

RandomFloat

Defined in

items/src/variables/Float.ts:57

---

setMinValue

▸ setMinValue(min): RandomFloat

Parameters

Name	Type
min	number

Returns

RandomFloat

Defined in

items/src/variables/Float.ts:50

---

setName

▸ setName(name): RandomFloat

Parameters

Name	Type
name	string

Returns

RandomFloat

Inherited from

Float.setName

Defined in

core/dist/src/structures/Variable.d.ts:6

---

setPosition

▸ setPosition(position, offset?): RandomFloat

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

RandomFloat

Inherited from

Float.setPosition

Defined in

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

---

setProperty

▸ setProperty(...properties): RandomFloat

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

RandomFloat

Inherited from

Float.setProperty

Defined in

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

---

setSequence

▸ setSequence(sequence, addToSequence?): RandomFloat

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

RandomFloat

Inherited from

Float.setSequence

Defined in

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

---

setValue

▸ setValue(value): RandomFloat

Parameters

Name	Type
value	number

Returns

RandomFloat

Inherited from

Float.setValue

Defined in

items/src/variables/Float.ts:25

---

showAllConnections

▸ showAllConnections(): void

Show all connection sockets.

Same as the editor right click > Show all connectors

Returns

void

Inherited from

Float.showAllConnections

Defined in

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

---

toJSON

▸ toJSON(): Record<string, KismetVariableValue>

Returns

Record<string, KismetVariableValue>

Inherited from

Float.toJSON

Defined in

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

---

toString

▸ toString(): string

Returns

string

Overrides

Float.toString

Defined in

items/src/variables/Float.ts:65

---

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

Float.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

Float.fromRaw

Defined in

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