Phaser Class: Bullet

new Bullet(game, x, y, key, frame)

Warning: Bullet is an experimental object that we don't advise using for now.

A Bullet is like a stripped-down Sprite, useful for when you just need to get something moving around the screen quickly with little of the extra features that a Sprite supports. Bullet is MISSING the following:

animation, all input events, crop support, health/damage, loadTexture

Parameters:

Name	Type	Description
`game`	Phaser.Game	Current game instance.
`x`	number	X position of the new bullet.
`y`	number	Y position of the new bullet.
`key`	string \| Phaser.RenderTexture \| PIXI.Texture	This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.
`frame`	string \| number	If this Sprite is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.

Source:

gameobjects/Bullet.js, line 24

Members

alive

Properties:

Name	Type	Description
`alive`	boolean	This is a handy little var your game can use to determine if a sprite is alive or not, it doesn't effect rendering.

Default Value:

true

Source:

gameobjects/Bullet.js, line 46

anchor

The anchor sets the origin point of the texture. The default is 0,0 this means the textures origin is the top left Setting than anchor to 0.5,0.5 means the textures origin is centered Setting the anchor to 1,1 would mean the textures origin points will be the bottom right

Properties:

Name	Type	Description
`anchor`	Phaser.Point

Source:

gameobjects/Bullet.js, line 142

angle

Indicates the rotation of the Bullet, in degrees, from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation. Values outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement player.angle = 450 is the same as player.angle = 90. If you wish to work in radians instead of degrees use the property Bullet.rotation instead.

Properties:

Name	Type	Description
`angle`	number	Gets or sets the Bullets angle of rotation in degrees.

Source:

gameobjects/Bullet.js, line 594

autoCull

Should this Sprite be automatically culled if out of range of the camera? A culled sprite has its visible property set to 'false'. Note that this check doesn't look at this Sprites children, which may still be in camera range. So you should set autoCull to false if the Sprite will have children likely to still be in camera range.

Properties:

Name	Type	Description
`autoCull`	boolean

Default Value:

false

Source:

gameobjects/Bullet.js, line 169

body

Properties:

Name	Type	Description
`body`	Phaser.Physics.Arcade.Body	Set-up the physics body.

Source:

gameobjects/Bullet.js, line 250

bottomLeft

Properties:

Name	Type	Description
`bottomLeft`	Phaser.Point	Description.

Source:

gameobjects/Bullet.js, line 240

bottomRight

Properties:

Name	Type	Description
`bottomRight`	Phaser.Point	Description.

Source:

gameobjects/Bullet.js, line 235

bounds

Properties:

Name	Type	Description
`bounds`	Phaser.Rectangle	Description.

Source:

gameobjects/Bullet.js, line 245

center

Properties:

Name	Type	Description
`center`	Phaser.Point	Description.

Source:

gameobjects/Bullet.js, line 220

events

Properties:

Name	Type	Description
`events`	Events	The Signals you can subscribe to that are dispatched when certain things happen on this Sprite or its components

Source:

gameobjects/Bullet.js, line 82

exists

Properties:

Name	Type	Description
`exists`	boolean	If exists = false then the Sprite isn't updated by the core game loop or physics subsystem at all.

Default Value:

true

Source:

gameobjects/Bullet.js, line 40

fixedToCamera

A Sprite that is fixed to the camera ignores the position of any ancestors in the display list and uses its x/y coordinates as offsets from the top left of the camera.

Properties:

Name	Type	Description
`fixedToCamera`	boolean	Fixes this Sprite to the Camera.

Default Value:

false

Source:

gameobjects/Bullet.js, line 281

game

Properties:

Name	Type	Description
`game`	Phaser.Game	A reference to the currently running Game.

Source:

gameobjects/Bullet.js, line 34

group

Properties:

Name	Type	Description
`group`	Description	Description.

Default Value:

null

Source:

gameobjects/Bullet.js, line 52

inWorld

Properties:

Name	Type	Description
`inWorld`	Description	World bounds check.

Source:

gameobjects/Bullet.js, line 255

inWorldThreshold

Properties:

Name	Type	Description
`inWorldThreshold`	number	World bounds check.

Default Value:

Source:

gameobjects/Bullet.js, line 261

key

Properties:

Name	Type	Description
`key`	Description	Description.

Source:

gameobjects/Bullet.js, line 87

lifespan

If you would like the Sprite to have a lifespan once 'born' you can set this to a positive value. Handy for particles, bullets, etc. The lifespan is decremented by game.time.elapsed each update, once it reaches zero the kill() function is called.