Function Sprite

A Sprite Game Object.

A Sprite Game Object is used for the display of both static and animated images in your game. Sprites can have input events and physics bodies. They can also be tweened, tinted, scrolled and animated.

The main difference between a Sprite and an Image Game Object is that you cannot animate Images. As such, Sprites take a fraction longer to process and have a larger API footprint due to the Animation Component. If you do not require animation then you can safely use Images to replace Sprites in all cases.

  • Sprite(
        props: ObjectProps<Sprite> & RecursivePartial<Sprite> & {
            frame?: string | number;
            texture: string | Texture;
        },
    ): ReactNode
    | Promise<ReactNode>

  • Parameters

    • props: ObjectProps<Sprite> & RecursivePartial<Sprite> & {
          frame?: string | number;
          texture: string | Texture;
      }

    Returns ReactNode | Promise<ReactNode>

Properties

displayName? propTypes?

Properties

OptionaldisplayName

displayName?: string

Used in debugging messages. You might want to set it explicitly if you want to display a different name for debugging purposes.

See

Legacy React Docs

Example


const MyComponent: FC = () => {
  return <div>Hello!</div>
}

MyComponent.displayName = 'MyAwesomeComponent'

OptionalpropTypes

propTypes?: any

Ignored by React.

Deprecated

Only kept in types for backwards compatibility. Will be removed in a future major release.

Settings

Member Visibility

On This Page

Properties