Class: abstract FComponent
The base class for all 2D components in Fibbo.
Extends
FComponent
Extended by
Constructors
new FComponent()
new FComponent(
scene,options?):FComponent
Parameters
• scene: FScene
The 2D scene where the component will be added.
• options?: FComponentOptions
The options for the component.
Returns
Overrides
FComponentCore.constructor
Defined in
Methods
__SET_POSITION__()
__SET_POSITION__(
position):void
Parameters
• position: FVector2
Returns
void
Defined in
__SET_ROTATION__()
__SET_ROTATION__(
rotation):void
Parameters
• rotation: number
Returns
void
Defined in
__SET_SCALE__()
__SET_SCALE__(
scale):void
Parameters
• scale: FVector2
Returns
void
Defined in
__UPDATE_POSITION__()
__UPDATE_POSITION__(
initiator):void
Update the position of the component according to the transform. This method should be called after updating the transform properties.
Parameters
• initiator: boolean = false
By default (false), the component won't be considered as the initiator of the position update. Set this to true to propagate the position update to the rigidBody, collider and sensor.
Returns
void
Defined in
__UPDATE_ROTATION__()
__UPDATE_ROTATION__(
initiator):void
Update the rotation of the component according to the transform. This method should be called after updating the transform properties.
Parameters
• initiator: boolean = false
By default (false), the component won't be considered as the initiator of the rotation update. Set this to true to propagate the rotation update to the rigidBody, collider and sensor.
Returns
void
Defined in
__UPDATE_SCALE__()
__UPDATE_SCALE__(
initiator):void
Update the scale of the component according to the transform. This method should be called after updating the transform properties.
Parameters
• initiator: boolean = false
By default (false), the component won't be considered as the initiator of the scale update. Set this to true to propagate the scale update to the rigidBody, collider and sensor.
Returns
void
Defined in
emitCollisionWith()
emitCollisionWith(
options):void
Emit a collision event with a given class or object.
Parameters
• options
The options for the collision event.
• options.class?: any
The class to emit the collision event with.
• options.component?: FComponent
The component to emit the collision event with.
Returns
void
Examples
const player = new Player()
const enemy = new Enemy()
player.emitCollisionWith({
class: Enemy
})const player = new Player()
const enemy = new Enemy()
player.emitCollisionWith({
object: enemy
})Inherited from
FComponentCore.emitCollisionWith
Defined in
core/dist/index.d.ts:293
emitOnLoaded()
emitOnLoaded():
void
Emit the onLoaded callbacks.
Returns
void
Inherited from
FComponentCore.emitOnLoaded
Defined in
core/dist/index.d.ts:247
frame()
frame(
_delta):void
Update the component. Should be called every frame. The purpose of this method is to render the component, its mesh/sprite, and its properties.
Parameters
• _delta: number
Returns
void
Overrides
FComponentCore.frame
Defined in
initCollider()
initCollider(
options?):void
Parameters
• options?: FColliderOptions
Returns
void
Defined in
initRigidBody()
initRigidBody(
options?):void
Parameters
• options?: FRigidBodyOptions
Returns
void
Defined in
initSensor()
initSensor(
options?):void
Parameters
• options?: FRigidBodyOptions
Returns
void
Defined in
onCollisionWith()
onCollisionWith(
classOrObject,callback): () =>void
Add a callback to be called when a collision occurs.
Parameters
• classOrObject: any
The class or object to add the callback to.
• callback
The callback to add.
Returns
Function
A function to remove the callback.
Returns
void
Examples
const player = new Player()
const enemy = new Enemy()
player.onCollisionWith(Enemy, () => {
console.log('Player collided with an Enemy!')
})const player = new Player()
const enemy = new Enemy()
player.onCollisionWith(enemy, () => {
console.log('Player collided with the enemy!')
})Overrides
FComponentCore.onCollisionWith
Defined in
onFrame()
onFrame(
callback):void
Add a callback to be called every frame.
Parameters
• callback
The callback function.
Returns
void
Inherited from
FComponentCore.onFrame
Defined in
core/dist/index.d.ts:238
onLoaded()
onLoaded(
callback):void
Add a callback to be called when the component is loaded (could be a texture, a 3D model, etc).
Parameters
• callback
The callback function.
Returns
void
Inherited from
FComponentCore.onLoaded
Defined in
core/dist/index.d.ts:243
Properties
__CALLBACKS_ON_COLLISION__
__CALLBACKS_ON_COLLISION__:
object
Callbacks for when a collision occurs with a given class or object. It is a dictionary where the key is the class name or object id and the value is an array of callbacks.
Index Signature
[key: string]: (data) => void[]
Inherited from
FComponentCore.__CALLBACKS_ON_COLLISION__
Defined in
core/dist/index.d.ts:216
__CALLBACKS_ON_FRAME__
__CALLBACKS_ON_FRAME__: () =>
void[]
Callbacks for when a frame is rendered.
Inherited from
FComponentCore.__CALLBACKS_ON_FRAME__
Defined in
core/dist/index.d.ts:207
__CALLBACKS_ON_LOADED__
__CALLBACKS_ON_LOADED__: () =>
void[]
Callbacks for when the component is loaded (could be a texture, a 3D model, etc).
Inherited from
FComponentCore.__CALLBACKS_ON_LOADED__
Defined in
core/dist/index.d.ts:211
__CONTAINER__
__CONTAINER__:
Container<ContainerChild>
PIXI container
Defined in
__ID__
__ID__:
number
Unique identifier for the component. It is generated automatically.
Inherited from
FComponentCore.__ID__
Defined in
core/dist/index.d.ts:203
__IS_2D__
__IS_2D__:
boolean=true
Internal flags
Overrides
FComponentCore.__IS_2D__
Defined in
__IS_3D__
__IS_3D__:
boolean
Internal flags
Inherited from
FComponentCore.__IS_3D__
Defined in
core/dist/index.d.ts:197
collider
collider:
FCollider
RAPIER Collider
Defined in
controller?
optionalcontroller:FController
The controller attached to the component.
Overrides
FComponentCore.controller
Defined in
rigidBody
rigidBody:
FRigidBody
RAPIER RigidBody
Defined in
scene
scene:
FScene
The scene which the component is in.
Overrides
FComponentCore.scene
Defined in
sensor
sensor:
FRigidBody
Sensor (a collider that doesn't collide with other colliders, but still triggers events)
Defined in
transform
transform:
FTransform
Transforms