Class Factory

constructor

• new Factory(world: Physics.Arcade.World): Physics.Arcade.Factory

  Parameters

  • world: Physics.Arcade.World

    The Arcade Physics World instance.

  Returns Physics.Arcade.Factory

scene

sys

world

body

• body(x: number, y: number, width?: number, height?: number): Physics.Arcade.Body

  Creates a new physics Body with the given position and size.

  This Body is not associated with any Game Object, but still exists within the world and can be tested for collision, have velocity, etc.

  Parameters

  • x: number

    The horizontal position of this Body in the physics world.
  • y: number

    The vertical position of this Body in the physics world.
  • Optionalwidth: number

    The width of the Body in pixels. Cannot be negative or zero. Default 64.
  • Optionalheight: number

    The height of the Body in pixels. Cannot be negative or zero. Default 64.

  Returns Physics.Arcade.Body

collider

• collider(
      object1: ArcadeColliderType,
      object2: ArcadeColliderType,
      collideCallback?: ArcadePhysicsCallback,
      processCallback?: ArcadePhysicsCallback,
      callbackContext?: any,
  ): Collider

  Creates a new Arcade Physics Collider object.

  Parameters

  • object1: ArcadeColliderType

    The first object to check for collision.
  • object2: ArcadeColliderType

    The second object to check for collision.
  • OptionalcollideCallback: ArcadePhysicsCallback

    The callback to invoke when the two objects collide.
  • OptionalprocessCallback: ArcadePhysicsCallback

    The callback to invoke when the two objects collide. Must return a boolean.
  • OptionalcallbackContext: any

    The scope in which to call the callbacks.

  Returns Collider

destroy

• destroy(): void

  Destroys this Factory.

  Returns void

existing

• existing<G extends GameObject>(gameObject: G, isStatic?: boolean): G

  Adds an Arcade Physics Body to the given Game Object.

  Type Parameters

  • G extends GameObject

  Parameters

  • gameObject: G

    A Game Object.
  • OptionalisStatic: boolean

    Create a Static body (true) or Dynamic body (false). Default false.

  Returns G

group

• group(
      children?: GameObject[] | GroupCreateConfig | PhysicsGroupConfig,
      config?: GroupCreateConfig | PhysicsGroupConfig,
  ): Physics.Arcade.Group

  Creates a Physics Group object. All Game Objects created by this Group will automatically be dynamic Arcade Physics objects.

  Parameters

  • Optionalchildren: GameObject[] | GroupCreateConfig | PhysicsGroupConfig

    Game Objects to add to this group; or the config argument.
  • Optionalconfig: GroupCreateConfig | PhysicsGroupConfig

    Settings for this group.

  Returns Physics.Arcade.Group

image

• image(
      x: number,
      y: number,
      texture: string | Textures.Texture,
      frame?: string | number,
  ): ImageWithDynamicBody

  Creates a new Arcade Image object with a Dynamic body.

  Parameters

  • x: number

    The horizontal position of this Game Object in the world.
  • y: number

    The vertical position of this Game Object in the world.
  • texture: string | Textures.Texture

    The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.
  • Optionalframe: string | number

    An optional frame from the Texture this Game Object is rendering with.

  Returns ImageWithDynamicBody

overlap

• overlap(
      object1: ArcadeColliderType,
      object2: ArcadeColliderType,
      collideCallback?: ArcadePhysicsCallback,
      processCallback?: ArcadePhysicsCallback,
      callbackContext?: any,
  ): Collider

  Creates a new Arcade Physics Collider Overlap object.

  Parameters

  • object1: ArcadeColliderType

    The first object to check for overlap.
  • object2: ArcadeColliderType

    The second object to check for overlap.
  • OptionalcollideCallback: ArcadePhysicsCallback

    The callback to invoke when the two objects collide.
  • OptionalprocessCallback: ArcadePhysicsCallback

    The callback to invoke when the two objects collide. Must return a boolean.
  • OptionalcallbackContext: any

    The scope in which to call the callbacks.

  Returns Collider

sprite

• sprite(
      x: number,
      y: number,
      key: string,
      frame?: string | number,
  ): SpriteWithDynamicBody

  Creates a new Arcade Sprite object with a Dynamic body.

  Parameters

  • x: number

    The horizontal position of this Game Object in the world.
  • y: number

    The vertical position of this Game Object in the world.
  • key: string

    The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.
  • Optionalframe: string | number

    An optional frame from the Texture this Game Object is rendering with.

  Returns SpriteWithDynamicBody

staticBody

• staticBody(x: number, y: number, width?: number, height?: number): StaticBody

  Creates a new static physics Body with the given position and size.

  This Body is not associated with any Game Object, but still exists within the world and can be tested for collision, etc.

  Parameters

  • x: number

    The horizontal position of this Body in the physics world.
  • y: number

    The vertical position of this Body in the physics world.
  • Optionalwidth: number

    The width of the Body in pixels. Cannot be negative or zero. Default 64.
  • Optionalheight: number

    The height of the Body in pixels. Cannot be negative or zero. Default 64.

  Returns StaticBody

staticGroup

• staticGroup(
      children?: GameObject[] | GroupConfig | GroupCreateConfig,
      config?: GroupConfig | GroupCreateConfig,
  ): StaticGroup

  Creates a Static Physics Group object. All Game Objects created by this Group will automatically be static Arcade Physics objects.

  Parameters

  • Optionalchildren: GameObject[] | GroupConfig | GroupCreateConfig

    Game Objects to add to this group; or the config argument.
  • Optionalconfig: GroupConfig | GroupCreateConfig

    Settings for this group.

  Returns StaticGroup

staticImage

• staticImage(
      x: number,
      y: number,
      texture: string | Textures.Texture,
      frame?: string | number,
  ): ImageWithStaticBody

  Creates a new Arcade Image object with a Static body.

  Parameters

  • x: number

    The horizontal position of this Game Object in the world.
  • y: number

    The vertical position of this Game Object in the world.
  • texture: string | Textures.Texture

    The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.
  • Optionalframe: string | number

    An optional frame from the Texture this Game Object is rendering with.

  Returns ImageWithStaticBody

staticSprite

• staticSprite(
      x: number,
      y: number,
      texture: string | Textures.Texture,
      frame?: string | number,
  ): SpriteWithStaticBody

  Creates a new Arcade Sprite object with a Static body.

  Parameters

  • x: number

    The horizontal position of this Game Object in the world.
  • y: number

    The vertical position of this Game Object in the world.
  • texture: string | Textures.Texture

    The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.
  • Optionalframe: string | number

    An optional frame from the Texture this Game Object is rendering with.

  Returns SpriteWithStaticBody