API Docs for: 0.3
Show:

Line Class

Extends Entity
Defined in: src\sim\Entities\Helpers\LinePrototype.js:20
Module: LinePrototype
Parent Module: Entities

Line Base

Constructor

Line

(
  • x
  • y
  • parent
  • [options]
  • id
)

Defined in src\sim\Entities\Helpers\LinePrototype.js:20

Parameters:

  • x Number

    coordinate

  • y Number

    coordinate

  • parent World

    world

  • [options] Object optional
  • id String

    to use insted of autogenerate it, used when loading world

Methods

addEntity

(
  • joint
  • options
)

Inherited from Entity but overwritten in src\sim\Entities\Helpers\LinePrototype.js:57

Request to add a children Joint entity.

Parameters:

addJoint

(
  • x
  • y
  • options
  • id
)
Joint

Defined in src\sim\Entities\Helpers\LinePrototype.js:121

Helper to create a new Joint.

Parameters:

Returns:

Joint:

joint

addJoints

(
  • joints
)

Defined in src\sim\Entities\Helpers\LinePrototype.js:102

Request to add a list of children Joint entities.

Parameters:

calcNewId

(
  • id
)

Inherited from Entity: src\sim\Entities\Entity.js:35

Description

Parameters:

Returns:

CallExpression

createGraphics

(
  • container
  • graphics
)
Pixi.Graphics

Inherited from Entity: src\app\Render\Entity.js:36

Create base grahpics.

Parameters:

  • container Pixi.Container
  • graphics Pixi.Graphics

    , optional created otherwise

Returns:

Pixi.Graphics:

graphics

destroy

()

Inherited from Entity but overwritten in src\sim\Entities\Helpers\LinePrototype.js:43

Destroy the line

destroyGraphics

(
  • container
  • graphics
)

Inherited from Entity: src\app\Render\Entity.js:55

Destroy base graphics.

Parameters:

  • container Pixi.Container
  • graphics Pixi.Graphics

getJointByIdx

(
  • idx
)
Joint

Defined in src\sim\Entities\Helpers\LinePrototype.js:158

Get a joint by index in the path.

Parameters:

Returns:

Joint:

joint or null

getJointIdx

(
  • joint
)
Number

Defined in src\sim\Entities\Helpers\LinePrototype.js:148

Get a joint index in the path/wall

Parameters:

Returns:

Number:

index or -1 if not found

getJoints

() Array

Defined in src\sim\Entities\Helpers\LinePrototype.js:138

Gets the childen joints.

Returns:

Array:

joints

getPos

() Vec2

Inherited from Entity: src\app\Render\Entity.js:97

Get entity position.

Returns:

Vec2:

position.

getProjection

(
  • point
  • segment
)
Vec2

Defined in src\sim\Entities\Helpers\LinePrototype.js:188

Get the projection from a point to a given segment.

Parameters:

  • point Vec2
  • segment Number

    index

Returns:

Vec2:

projection from point to segment

getWidth

() Number

Defined in src\sim\Entities\Helpers\LinePrototype.js:169

Get [options.width].

Returns:

Number:

width

removeEntity

(
  • joint
)

Inherited from Entity but overwritten in src\sim\Entities\Helpers\LinePrototype.js:78

Request to remove a children Joint entity.

Parameters:

render

(
  • graphics
)

Inherited from Entity: src\app\Render\Entity.js:87

Animate entity.

Parameters:

  • graphics Pixi.Graphics

reverse

()

Defined in src\sim\Entities\Helpers\LinePrototype.js:179

Reverse the internal joints lists.

setInteractive

(
  • displayObject
)

Inherited from Entity: src\app\Render\Entity.js:71

Set render entity as interactive.

Parameters:

  • displayObject Pixi.DisplayObject

updatePos

(
  • x
  • y
)

Inherited from Entity: src\sim\Entities\Entity.js:57

Description

Parameters:

Returns: