Skip to content

Class: MockFrect ​

Mock of the X-Ray engine Frect rectangle class.

Implements ​

  • Frect

Constructors ​

Constructor ​

ts
new MockFrect(
   x1?: number, 
   y1?: number, 
   x2?: number, 
   y2?: number): MockFrect;

Parameters ​

ParameterTypeDefault value
x1number0
y1number0
x2number0
y2number0

Returns ​

MockFrect

Methods ​

set() ​

ts
set(
   x1: number, 
   y1: number, 
   x2: number, 
   y2: number): MockFrect;

Set rectangle edges.

Parameters ​

ParameterTypeDescription
x1numberLeft edge.
y1numberTop edge.
x2numberRight edge.
y2numberBottom edge.

Returns ​

MockFrect

This rectangle.

Implementation of ​

ts
Frect.set

create() ​

ts
static create(
   x1?: number, 
   y1?: number, 
   x2?: number, 
   y2?: number): MockFrect;

Parameters ​

ParameterTypeDefault value
x1number0
y1number0
x2number0
y2number0

Returns ​

MockFrect


mock() ​

ts
static mock(
   x1?: number, 
   y1?: number, 
   x2?: number, 
   y2?: number): Frect;

Parameters ​

ParameterTypeDefault value
x1number0
y1number0
x2number0
y2number0

Returns ​

Frect

Properties ​

__name ​

ts
__name: string = "Frect";

LuaBind instance constructor name.

Implementation of ​

ts
Frect.__name

lt ​

ts
lt: MockVector2D;

Top-left corner.

Implementation of ​

ts
Frect.lt

rb ​

ts
rb: MockVector2D;

Bottom-right corner.

Implementation of ​

ts
Frect.rb

x1 ​

ts
x1: number;

Left edge.

Implementation of ​

ts
Frect.x1

x2 ​

ts
x2: number;

Right edge.

Implementation of ​

ts
Frect.x2

y1 ​

ts
y1: number;

Top edge.

Implementation of ​

ts
Frect.y1

y2 ​

ts
y2: number;

Bottom edge.

Implementation of ​

ts
Frect.y2