Class Force

A vector used to move objects.

Index

Constructors

Methods

add addForce clear getAngle getLength getMultiplier getNetworkSyncData getX getY setAngle setLength setMultiplier setX setY updateFromNetworkSyncData

Constructors

constructor

new Force(x, y, multiplier): Force
Parameters
- x: number
  The initial x component
- y: number
  The initial y component
- multiplier: number
  The multiplier (0 for a force that disappear on next frame, 1 for a permanent force)
Returns Force
- Defined in GDJS/Runtime/force.ts:23

Methods

add

add(x, y): void
Parameters
- x: number
- y: number
Returns void
- Defined in GDJS/Runtime/force.ts:76

addForce

addForce(force): void
Parameters
- force: Force
Returns void
- Defined in GDJS/Runtime/force.ts:70

clear

clear(): void
Returns void
- Defined in GDJS/Runtime/force.ts:63

getAngle

getAngle(): number
Get the angle of the force

Returns number
- Defined in GDJS/Runtime/force.ts:115

getLength

getLength(): number
Get the length of the force

Returns number
- Defined in GDJS/Runtime/force.ts:127

getMultiplier

getMultiplier(): number
Return 1 (true) if the force is permanent, 0 (false) if it is instant.

Returns number
- Defined in GDJS/Runtime/force.ts:139

getNetworkSyncData

getNetworkSyncData(): ForceNetworkSyncData
Returns ForceNetworkSyncData
- Defined in GDJS/Runtime/force.ts:151

getX

getX(): number
Returns the X component of the force.

Returns number
- Defined in GDJS/Runtime/force.ts:34

getY

getY(): number
Returns the Y component of the force.

Returns number
- Defined in GDJS/Runtime/force.ts:41

setAngle

setAngle(angle): void
Set the angle of the force.
Parameters
- angle: number
  The new angle
Returns void
- Defined in GDJS/Runtime/force.ts:86

setLength

setLength(len): void
Set the length of the force.
Parameters
- len: number
  The length
Returns void
- Defined in GDJS/Runtime/force.ts:101

setMultiplier

setMultiplier(multiplier): void
Set if the force multiplier.
Parameters
- multiplier: number
  The new value
Returns void
- Defined in GDJS/Runtime/force.ts:147

setX

setX(x): void
Set the x component of the force.
Parameters
- x: number
  The new X component
Returns void
- Defined in GDJS/Runtime/force.ts:49

setY

setY(y): void
Set the y component of the force.
Parameters
- y: number
  The new Y component
Returns void
- Defined in GDJS/Runtime/force.ts:58

updateFromNetworkSyncData

updateFromNetworkSyncData(syncData): void
Parameters
- syncData: ForceNetworkSyncData
Returns void
- Defined in GDJS/Runtime/force.ts:161