[Basic Type](../groups/Basic Type.Basic Type.md) / LinearColor

LinearColor Class ​

r, g, b The effective range of color values is 0.0<=value<=1.0

Table of contents ​

Accessors ​

Methods ​

Construct a new Color using the given values of r, g, and b

Parameters ​

• new LinearColor(r, g, b, a)

Construct a new Color using the given values of r, g, b, and a

Parameters ​

• new LinearColor(v)

Build a new LinearColor using the given Vector object

Parameters ​

• new LinearColor(c)

Build a new LinearColor using the given LinearColor

Parameters ​

Accessors ​

a ​

b ​

g ​

r ​

black ​

blue ​

gray ​

green ​

red ​

white ​

yellow ​

Methods ​

addition ​

• addition(linearColorB, outer?): LinearColor other

Addition of color values

Parameters ​

Returns ​

clone ​

• clone(): LinearColor other

Clone the current linear color

Returns ​

division ​

• division(linearColorB, outer?): LinearColor other

Color value division

Parameters ​

Returns ​

equality ​

• equality(linearColorB, epsilon?): boolean other

Determine if two color values are equal

Parameters ​

Returns ​

fromString ​

• fromString(str): void other

Fill objects with data.

Parameters ​

Returns ​

The difference between this function and another from String function is that this function is a regular function, while the other is a static function.

The calling methods are different.

Usage example: difference of call mode

// This function
let color :LinearColor;
color.fromString("R=0.000000,G=1.000000,B=0.000000,A=-1.000000");
this.button.pressedImagColor = color;

// Static fromString function
const str = "R=0.000000,G=1.000000,B=0.000000,A=-1.000000";
this.button.pressedImagColor = LinearColor.fromString(str);

// This function
let color :LinearColor;
color.fromString("R=0.000000,G=1.000000,B=0.000000,A=-1.000000");
this.button.pressedImagColor = color;

// Static fromString function
const str = "R=0.000000,G=1.000000,B=0.000000,A=-1.000000";
this.button.pressedImagColor = LinearColor.fromString(str);

Parameters ​

inequality ​

• inequality(linearColorB, epsilon?): boolean other

Returns ​

Multiplying color values

Parameters ​

Returns ​

Parameters ​

Returns ​

subtraction ​

• subtraction(linearColorB, outer?): LinearColor other

Subtract color values

Parameters ​

Returns ​

toString ​

• toString(): string other

Output object properties in string form

Returns ​

colorHexToLinearColor ​

• Static colorHexToLinearColor(inColorHex, outer?): LinearColor other

Convert HexColor to LinearColor

Parameters ​

Returns ​

colorHsvToLinearColor ​

• Static colorHsvToLinearColor(h, s, v, outer?): LinearColor other

Convert HsvColor to LinearColor

Parameters ​

Returns ​

colorToLinearColor ​

• Static colorToLinearColor(r, g, b, a?, outer?): LinearColor other

Convert current color

Parameters ​

Returns ​

fromString ​

• Static fromString(jsonStr): LinearColor other

Generate a new object with data

The incoming format is: "R=0.000000, G=1.000000, B=0.000000, A=-1.000000" (green)

Example usage: Create a script called NewScript, place it in the object bar, open the script, modify the original content to the following, save and run the game, and a screen UI button will be generated in the scene.

@Component
 export default class NewScript extends Script {

     protected onStart(): void {
         if(SystemUtil.isClient()){
             UIService.show(NewUIScript);
         }
     }
 }

 class NewUIScript extends UIScript {

     button:StaleButton;

     protected onStart() {
         //Set whether onUpdate can be triggered every frame
         this.canUpdate = false;
         this.layer = UILayerMiddle;

         this.button = StaleButton.newObject(this.rootCanvas);

         this.button.text = "Press to turn green";
         this.button.transitionEnable = true;
         const str = "R=0.000000,G=1.000000,B=0.000000,A=-1.000000";
         this.button.pressedImagColor = LinearColor.fromString(str);
         this.button.visibility = SlateVisibility.Visible;
         this.button.onClicked.add(() => {
             console.log("click");
         })
     }
 }

@Component
 export default class NewScript extends Script {

     protected onStart(): void {
         if(SystemUtil.isClient()){
             UIService.show(NewUIScript);
         }
     }
 }

 class NewUIScript extends UIScript {

     button:StaleButton;

     protected onStart() {
         //Set whether onUpdate can be triggered every frame
         this.canUpdate = false;
         this.layer = UILayerMiddle;

         this.button = StaleButton.newObject(this.rootCanvas);

         this.button.text = "Press to turn green";
         this.button.transitionEnable = true;
         const str = "R=0.000000,G=1.000000,B=0.000000,A=-1.000000";
         this.button.pressedImagColor = LinearColor.fromString(str);
         this.button.visibility = SlateVisibility.Visible;
         this.button.onClicked.add(() => {
             console.log("click");
         })
     }
 }

Parameters ​

Returns ​

makeFromHSV ​

• Static makeFromHSV(h, s, v, outer?): LinearColor other

Convert byte tone saturation brightness to LinearColor

Parameters ​

Returns ​

random ​

• Static random(outer?): LinearColor other

Return a new color with random RGB values and an Alpha of 1.0

Parameters ​

Returns ​