Function Light

A Scene plugin that provides a Phaser.GameObjects.LightsManager for the Light2D pipeline.

Light(
    props: ObjectProps<Light> & RecursivePartial<Light> & {
        color: { b: number; g: number; r: number };
        intensity: number;
        radius: number;
        x: number;
        y: number;
    },
): ReactNode
| Promise<ReactNode>
Parameters
- props: ObjectProps<Light> & RecursivePartial<Light> & {
      color: { b: number; g: number; r: number };
      intensity: number;
      radius: number;
      x: number;
      y: number;
  }
Returns ReactNode | Promise<ReactNode>
- Defined in src/components/GameObjects.ts:360

Index

Properties

displayName? propTypes?

Properties

`Optional`displayName

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'

`Optional`propTypes

propTypes?: any

Ignored by React.

Deprecated

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