Class UniEntity

Hierarchy

UniEntityT<IFlyffEntity>
- UniEntity

Index

Constructors

Properties

_eventListeners runtimeProviders

Methods

GetInternalEntity IsObstructed IsOnScreen On SetInternalEntity Trigger UpdateState get

Constructors

constructor

new UniEntity(internalEntity, runtimeProviders): UniEntity
Parameters
- internalEntity: IFlyffEntity
- runtimeProviders: RuntimeProviders
Returns UniEntity
Inherited from UniEntityT<IFlyffEntity>.constructor

Properties

`Protected` _eventListeners

_eventListeners: {
event: string;
listener: Function;
}[] = []

Type declaration

event: string
listener: Function

`Protected` runtimeProviders

runtimeProviders: RuntimeProviders

Methods

`Protected` GetInternalEntity

GetInternalEntity(): IFlyffEntity
Returns IFlyffEntity
Inherited from UniEntityT.GetInternalEntity

IsObstructed

IsObstructed(): boolean
Returns boolean
Inherited from UniEntityT.IsObstructed

IsOnScreen

IsOnScreen(): boolean
Returns boolean
Inherited from UniEntityT.IsOnScreen

On

On<J>(event, listener): void
Type Parameters
- J extends OptionalMergeKeys<{
      centroid-changed: ((newValue) => void);
      collisionData-changed: ((newValue) => void);
      distanceToCamera-changed: ((newValue) => void);
      entityBase-changed: ((newValue) => void);
      gamePropID-changed: ((newValue) => void);
      objectType-changed: ((newValue) => void);
      rotation-changed: ((newValue) => void);
      screenPos-changed: ((newValue) => void);
      worldBbox-changed: ((newValue) => void);
      worldPos-changed: ((newValue) => void);
  }, StaticChangeEventType>
Parameters
- event: J
- listener: {
      centroid-changed: ((newValue) => void);
      collisionData-changed: ((newValue) => void);
      despawned: (() => void);
      distanceToCamera-changed: ((newValue) => void);
      entityBase-changed: ((newValue) => void);
      gamePropID-changed: ((newValue) => void);
      objectType-changed: ((newValue) => void);
      rotation-changed: ((newValue) => void);
      screenPos-changed: ((newValue) => void);
      worldBbox-changed: ((newValue) => void);
      worldPos-changed: ((newValue) => void);
  }[J]
Returns void
Inherited from UniEntityT.On

`Protected` SetInternalEntity

SetInternalEntity(newInternalEntity): void
Parameters
- newInternalEntity: IFlyffEntity
Returns void
Inherited from UniEntityT.SetInternalEntity

Trigger

Trigger(event, ...args): void
Parameters
- event: string
- Rest ...args: any[]
Returns void
Inherited from UniEntityT.Trigger

UpdateState

UpdateState(updatedInternalEntity): void
Parameters
- updatedInternalEntity: IFlyffEntity
Returns void
Inherited from UniEntityT.UpdateState

get

get<J>(propertyName): IFlyffEntity[J]
Accesss internal properties of the underlying IFlyffEntity object.
Type Parameters
- J extends keyof IFlyffEntity
Parameters
- propertyName: string & {} | J
Returns IFlyffEntity[J]
The value of the property on the internal IFlyffEntity object. Returns undefined if the property does not exist.

Inherited from UniEntityT.get

Generated using TypeDoc