Class ParticlesCollisionShape

Hierarchy

CollisionShape
- ParticlesCollisionShape

Index

Constructors

constructor

Properties

tag

Accessors

Methods

Constructors

constructor

new ParticlesCollisionShape(props?: ObjectProps<ParticlesCollisionShape>): ParticlesCollisionShape

- Defined in src/collision/ParticlesCollisionShape.ts:20
Parameters
- Optional props: ObjectProps<ParticlesCollisionShape>
Returns ParticlesCollisionShape

Properties

tag

tag: string = "Particles"

Accessors

particles

get particles(): null | Particles

- Defined in src/collision/ParticlesCollisionShape.ts:18
Returns null | Particles

particlesEntity

set particlesEntity(particlesEntity: Entity): void

- Defined in src/collision/ParticlesCollisionShape.ts:17
Parameters
- particlesEntity: Entity
Returns void

version

get version(): number

- Defined in src/collision/ParticlesCollisionShape.ts:13
Returns number

Methods

checkCollisions

checkCollisions(other: CollisionShape, myTransform: Transform, otherTransform: Transform, onCollision: function): void

Overrides CollisionShape.checkCollisions
- Defined in src/collision/ParticlesCollisionShape.ts:31
Parameters
- other: CollisionShape
- myTransform: Transform
- otherTransform: Transform
- onCollision: function
  - - (particleIndex?: undefined | number): void
    - Parameters
      - Optional particleIndex: undefined | number
      Returns void
Returns void

copy

copy(): SerializableObject

Inherited from SerializableObject.copy
- Defined in src/core/SerializableObject.ts:27
Returns SerializableObject

deserialize

deserialize(json: SerializedObjectType): Promise<SerializableObject> | SerializableObject

Inherited from SerializableObject.deserialize
- Defined in src/core/SerializableObject.ts:45
Parameters
- json: SerializedObjectType
Returns Promise<SerializableObject> | SerializableObject

destroy

destroy(): void

Inherited from SerializableObject.destroy
- Defined in src/core/SerializableObject.ts:33
Returns void

getTestPriority

getTestPriority(): CollisionTestPriority

Overrides CollisionShape.getTestPriority
- Defined in src/collision/ParticlesCollisionShape.ts:29
Returns CollisionTestPriority

isA

isA<T>(type: object): boolean

Inherited from SerializableObject.isA
- Defined in src/core/SerializableObject.ts:23
Type parameters
- T
Parameters
- type: object
  - constructor: function
    - new __type(...args: any[]): T
    - Defined in src/core/SerializableObject.ts:23
      Parameters
      - Rest ...args: any[]
      Returns T
Returns boolean

serialize

serialize(): SerializedObjectType

Inherited from SerializableObject.serialize
- Defined in src/core/SerializableObject.ts:41
Returns SerializedObjectType

setProperty

setProperty(name: string, value: any): void

Inherited from SerializableObject.setProperty
- Defined in src/core/SerializableObject.ts:37
Parameters
- name: string
- value: any
Returns void

setState

setState<T>(props: ObjectProps<T>): void

Inherited from SerializableObject.setState
- Defined in src/core/SerializableObject.ts:54
Type parameters
- T
Parameters
- props: ObjectProps<T>
Returns void

upgrade

upgrade(json: SerializedObject, previousVersion: number): SerializedObject

Overrides SerializableObject.upgrade
- Defined in src/collision/ParticlesCollisionShape.ts:43
Parameters
- json: SerializedObject
- previousVersion: number
Returns SerializedObject