emile

Appearance

@emile/engine

@emile/engine / math/vec / Vec2

Class: Vec2 ​

Defined in: src/math/vec.ts:3

Extends ​

  • Schema

Constructors ​

new Vec2() ​

new Vec2(): Vec2

Defined in: src/math/vec.ts:12

Creates a new Vec2 instance.

The x and y values will be set to 0.

Returns ​

Vec2

Overrides ​

Schema.constructor

new Vec2() ​

new Vec2(xy): Vec2

Defined in: src/math/vec.ts:19

Creates a new Vec2 instance.

Parameters ​

xy ​

number

The x and y values.

Returns ​

Vec2

Overrides ​

Schema.constructor

new Vec2() ​

new Vec2(x, y): Vec2

Defined in: src/math/vec.ts:27

Creates a new Vec2 instance.

Parameters ​

x ​

number

The x value.

y ​

number

The y value.

Returns ​

Vec2

Overrides ​

Schema.constructor

Properties ​

$callbacks ​

protected $callbacks: object

Defined in: node_modules/.pnpm/@colyseus+schema@2.0.35/node_modules/@colyseus/schema/lib/Schema.d.ts:35

Index Signature ​

[op: number]: Function[]

Inherited from ​

Schema.$callbacks

$changes ​

protected $changes: ChangeTree

Defined in: node_modules/.pnpm/@colyseus+schema@2.0.35/node_modules/@colyseus/schema/lib/Schema.d.ts:34

Inherited from ​

Schema.$changes

x ​

x: number

Defined in: src/math/vec.ts:4

y ​

y: number

Defined in: src/math/vec.ts:5

_context ​

static _context: Context

Defined in: node_modules/.pnpm/@colyseus+schema@2.0.35/node_modules/@colyseus/schema/lib/Schema.d.ts:30

Inherited from ​

Schema._context

_definition ​

static _definition: SchemaDefinition

Defined in: node_modules/.pnpm/@colyseus+schema@2.0.35/node_modules/@colyseus/schema/lib/Schema.d.ts:31

Inherited from ​

Schema._definition

_typeid ​

static _typeid: number

Defined in: node_modules/.pnpm/@colyseus+schema@2.0.35/node_modules/@colyseus/schema/lib/Schema.d.ts:29

Inherited from ​

Schema._typeid

Accessors ​

_definition ​

Get Signature ​

get protected _definition(): SchemaDefinition

Defined in: node_modules/.pnpm/@colyseus+schema@2.0.35/node_modules/@colyseus/schema/lib/Schema.d.ts:44

Returns ​

SchemaDefinition

Inherited from ​

Schema._definition

Methods ​

applyFilters() ​

applyFilters(client, encodeAll?): number[]

Defined in: node_modules/.pnpm/@colyseus+schema@2.0.35/node_modules/@colyseus/schema/lib/Schema.d.ts:62

Parameters ​

client ​

any

encodeAll? ​

boolean

Returns ​

number[]

Inherited from ​

Schema.applyFilters

assign() ​

assign(props): this

Defined in: node_modules/.pnpm/@colyseus+schema@2.0.35/node_modules/@colyseus/schema/lib/Schema.d.ts:41

Parameters ​

props ​

{ x: number; y: number; } | ToJSON<Vec2>

Returns ​

this

Inherited from ​

Schema.assign

clone() ​

clone(): this

Defined in: node_modules/.pnpm/@colyseus+schema@2.0.35/node_modules/@colyseus/schema/lib/Schema.d.ts:63

Returns ​

this

Inherited from ​

Schema.clone

decode() ​

decode(bytes, it?, ref?): DataChange<any, string>[]

Defined in: node_modules/.pnpm/@colyseus+schema@2.0.35/node_modules/@colyseus/schema/lib/Schema.d.ts:59

Parameters ​

bytes ​

number[]

it? ​

Iterator

ref? ​

Ref

Returns ​

DataChange<any, string>[]

Inherited from ​

Schema.decode

deleteByIndex() ​

protected deleteByIndex(index): void

Defined in: node_modules/.pnpm/@colyseus+schema@2.0.35/node_modules/@colyseus/schema/lib/Schema.d.ts:67

Parameters ​

index ​

number

Returns ​

void

Inherited from ​

Schema.deleteByIndex

discardAllChanges() ​

discardAllChanges(): void

Defined in: node_modules/.pnpm/@colyseus+schema@2.0.35/node_modules/@colyseus/schema/lib/Schema.d.ts:65

Returns ​

void

Inherited from ​

Schema.discardAllChanges

encode() ​

encode(encodeAll?, bytes?, useFilters?): number[]

Defined in: node_modules/.pnpm/@colyseus+schema@2.0.35/node_modules/@colyseus/schema/lib/Schema.d.ts:60

Parameters ​

encodeAll? ​

boolean

bytes? ​

number[]

useFilters? ​

boolean

Returns ​

number[]

Inherited from ​

Schema.encode

encodeAll() ​

encodeAll(useFilters?): number[]

Defined in: node_modules/.pnpm/@colyseus+schema@2.0.35/node_modules/@colyseus/schema/lib/Schema.d.ts:61

Parameters ​

useFilters? ​

boolean

Returns ​

number[]

Inherited from ​

Schema.encodeAll

getByIndex() ​

protected getByIndex(index): any

Defined in: node_modules/.pnpm/@colyseus+schema@2.0.35/node_modules/@colyseus/schema/lib/Schema.d.ts:66

Parameters ​

index ​

number

Returns ​

any

Inherited from ​

Schema.getByIndex

listen() ​

listen<K>(prop, callback, immediate?): () => boolean

Defined in: node_modules/.pnpm/@colyseus+schema@2.0.35/node_modules/@colyseus/schema/lib/Schema.d.ts:58

Client-side: listen for changes on property.

Type Parameters ​

K ​

K extends NonFunctionPropNames<Vec2>

Parameters ​

prop ​

K

the property name

callback ​

(value, previousValue) => void

callback to be triggered on property change

immediate? ​

boolean

trigger immediatelly if property has been already set.

Returns ​

Function

Returns ​

boolean

Inherited from ​

Schema.listen

onChange() ​

onChange(callback): () => void

Defined in: node_modules/.pnpm/@colyseus+schema@2.0.35/node_modules/@colyseus/schema/lib/Schema.d.ts:38

Parameters ​

callback ​

() => void

Returns ​

Function

Returns ​

void

Inherited from ​

Schema.onChange

onRemove() ​

onRemove(callback): () => void

Defined in: node_modules/.pnpm/@colyseus+schema@2.0.35/node_modules/@colyseus/schema/lib/Schema.d.ts:39

Parameters ​

callback ​

() => void

Returns ​

Function

Returns ​

void

Inherited from ​

Schema.onRemove

setDirty() ​

setDirty<K>(property, operation?): void

Defined in: node_modules/.pnpm/@colyseus+schema@2.0.35/node_modules/@colyseus/schema/lib/Schema.d.ts:51

(Server-side): Flag a property to be encoded for the next patch.

Type Parameters ​

K ​

K extends NonFunctionPropNames<Vec2>

Parameters ​

property ​

string representing the property name, or number representing the index of the property.

number | K

operation? ​

OPERATION

OPERATION to perform (detected automatically)

Returns ​

void

Inherited from ​

Schema.setDirty

toJSON() ​

toJSON(): ToJSON<Vec2>

Defined in: node_modules/.pnpm/@colyseus+schema@2.0.35/node_modules/@colyseus/schema/lib/Schema.d.ts:64

Returns ​

ToJSON<Vec2>

Inherited from ​

Schema.toJSON

add() ​

static add(v, vec): Vec2

Defined in: src/math/vec.ts:53

Parameters ​

v ​

Vec2

vec ​

Vec2

Returns ​

Vec2

angle() ​

static angle(v): number

Defined in: src/math/vec.ts:93

Parameters ​

v ​

Vec2

Returns ​

number

clamp() ​

static clamp(v, min, max): Vec2

Defined in: src/math/vec.ts:119

Parameters ​

v ​

Vec2

min ​

Vec2

max ​

Vec2

Returns ​

Vec2

copy() ​

static copy(v): Vec2

Defined in: src/math/vec.ts:123

Parameters ​

v ​

Vec2

Returns ​

Vec2

distance() ​

static distance(v, vec): number

Defined in: src/math/vec.ts:103

Parameters ​

v ​

Vec2

vec ​

Vec2

Returns ​

number

div() ​

Call Signature ​

static div(v, scalar): Vec2

Defined in: src/math/vec.ts:65

Parameters ​
v ​

Vec2

scalar ​

number

Returns ​

Vec2

Call Signature ​

static div(v, vec): Vec2

Defined in: src/math/vec.ts:66

Parameters ​
v ​

Vec2

vec ​

Vec2

Returns ​

Vec2

dot() ​

static dot(v, vec): number

Defined in: src/math/vec.ts:76

Parameters ​

v ​

Vec2

vec ​

Vec2

Returns ​

number

equals() ​

static equals(v, vec): boolean

Defined in: src/math/vec.ts:131

Parameters ​

v ​

Vec2

vec ​

Vec2

Returns ​

boolean

fromAngle() ​

static fromAngle(angle): Vec2

Defined in: src/math/vec.ts:44

Parameters ​

angle ​

number

Returns ​

Vec2

is() ​

static is(type): boolean

Defined in: node_modules/.pnpm/@colyseus+schema@2.0.35/node_modules/@colyseus/schema/lib/Schema.d.ts:33

Parameters ​

type ​

DefinitionType

Returns ​

boolean

Inherited from ​

Schema.is

len() ​

static len(v): number

Defined in: src/math/vec.ts:80

Parameters ​

v ​

Vec2

Returns ​

number

lerp() ​

static lerp(a, b, alpha): Vec2

Defined in: src/math/vec.ts:127

Parameters ​

a ​

Vec2

b ​

Vec2

alpha ​

number

Returns ​

Vec2

max() ​

static max(v, vec): Vec2

Defined in: src/math/vec.ts:115

Parameters ​

v ​

Vec2

vec ​

Vec2

Returns ​

Vec2

min() ​

static min(v, vec): Vec2

Defined in: src/math/vec.ts:111

Parameters ​

v ​

Vec2

vec ​

Vec2

Returns ​

Vec2

mul() ​

static mul(v, scalar): Vec2

Defined in: src/math/vec.ts:61

Parameters ​

v ​

Vec2

scalar ​

number

Returns ​

Vec2

normalize() ​

static normalize(v): Vec2

Defined in: src/math/vec.ts:88

Parameters ​

v ​

Vec2

Returns ​

Vec2

onError() ​

static onError(e): void

Defined in: node_modules/.pnpm/@colyseus+schema@2.0.35/node_modules/@colyseus/schema/lib/Schema.d.ts:32

Parameters ​

e ​

any

Returns ​

void

Inherited from ​

Schema.onError

rotate() ​

static rotate(v, angle): Vec2

Defined in: src/math/vec.ts:97

Parameters ​

v ​

Vec2

angle ​

number

Returns ​

Vec2

set() ​

static set(v, x, y): void

Defined in: src/math/vec.ts:48

Parameters ​

v ​

Vec2

x ​

number

y ​

number

Returns ​

void

sqrDistance() ​

static sqrDistance(v, vec): number

Defined in: src/math/vec.ts:107

Parameters ​

v ​

Vec2

vec ​

Vec2

Returns ​

number

sqrLen() ​

static sqrLen(v): number

Defined in: src/math/vec.ts:84

Parameters ​

v ​

Vec2

Returns ​

number

sub() ​

static sub(v, vec): Vec2

Defined in: src/math/vec.ts:57

Parameters ​

v ​

Vec2

vec ​

Vec2

Returns ​

Vec2

toString() ​

static toString(v): string

Defined in: src/math/vec.ts:135

Returns a string representation of a function.

Parameters ​

v ​

Vec2

Returns ​

string