Shumate-1.0 ▶ Shumate ▶ VectorValueSince 1.6

constructor

• new VectorValue(properties?: Partial<{}>): VectorValue

  Parameters

  • Optionalproperties: Partial<{}>

  Returns VectorValue

Static$gtype

Since 1.6array_append

• array_append(element: VectorValue): void

  Appends element to the array value of self. The value of element is copied.

  Parameters

  • element: VectorValue

    a VectorValue to append to the array

  Returns void

  Since

  1.6

Since 1.6dup

• dup(): VectorValue

  Creates a duplicate of self.

  Returns VectorValue

  a new VectorValue which is a duplicate of self

  Since

  1.6

Since 1.6equal

• equal(b: VectorValue): boolean

  Compares two VectorValues for equality.

  Either argument may be NULL, which is treated as equal to a VectorValue of type Shumate.VectorValueType.NULL.

  Parameters

  • b: VectorValue

    a VectorValue

  Returns boolean

  true if a and b are equal, false otherwise

  Since

  1.6

Since 1.6free

• free(): void

  Frees a VectorValue.

  Returns void

  Since

  1.6

Since 1.6get_boolean

• get_boolean(): [boolean, boolean]

  Gets the boolean value of self.

  Returns [boolean, boolean]

  true if self is a boolean value and boolean was set, false otherwise

  Since

  1.6

Since 1.6get_color

• get_color(): [boolean, Gdk.RGBA]

  Gets the color value of self.

  If self is a string value, it will attempt to parse the string as a color.

  Returns [boolean, Gdk.RGBA]

  true if self is a color value and color was set, false otherwise

  Since

  1.6

Since 1.6get_number

• get_number(): [boolean, number]

  Gets the number value of self.

  Returns [boolean, number]

  true if self is a number value and number was set, false otherwise

  Since

  1.6

Since 1.6get_string

• get_string(): [boolean, string]

  Gets the string value of self.

  Returns [boolean, string]

  true if self is a string value and string was set, false otherwise

  Since

  1.6

Since 1.6get_value_type

• get_value_type(): Shumate.VectorValueType

  Gets the type of value stored in self.

  Returns Shumate.VectorValueType

  the type of self

  Since

  1.6

Since 1.6hash

• hash(): number

  Calculates a hash value for self.

  Returns number

  a hash value for self

  Since

  1.6

Since 1.6is_null

• is_null(): boolean

  Checks if self is a null value.

  Returns boolean

  true if self is a null value, false otherwise

  Since

  1.6

Since 1.6set_boolean

• set_boolean(_boolean: boolean): void

  Sets self to a boolean value.

  Parameters

  • _boolean: boolean

    a boolean value

  Returns void

  Since

  1.6

Since 1.6set_color

• set_color(color: Gdk.RGBA): void

  Sets self to a color value.

  Parameters

  • color: Gdk.RGBA

    a Gdk.RGBA

  Returns void

  Since

  1.6

Since 1.6set_number

• set_number(number: number): void

  Sets self to a number value.

  Parameters

  • number: number

    a number value

  Returns void

  Since

  1.6

Since 1.6set_string

• set_string(string: string): void

  Sets self to a string value.

  Parameters

  • string: string

    a string value

  Returns void

  Since

  1.6

Since 1.6start_array

• start_array(): void

  Sets self to an empty array value.

  Returns void

  Since

  1.6

Since 1.6unset

• unset(): void

  Sets self to a null value.

  Returns void

  Since

  1.6

Staticnew

• new(): VectorValue

  Returns VectorValue

Staticnew_boolean

• new_boolean(_boolean: boolean): VectorValue

  Parameters

  • _boolean: boolean

  Returns VectorValue

Staticnew_color

• new_color(color: Gdk.RGBA): VectorValue

  Parameters

  • color: Gdk.RGBA

  Returns VectorValue

Staticnew_from_value

• new_from_value(value: any): VectorValue

  Parameters

  • value: any

  Returns VectorValue

Staticnew_number

• new_number(number: number): VectorValue

  Parameters

  • number: number

  Returns VectorValue

Staticnew_string

• new_string(string: string): VectorValue

  Parameters

  • string: string

  Returns VectorValue