Interface EntityAIPrototype

Object used to register entity AI prototypes.

interface EntityAIPrototype {
    data?: object;
    params?: object;
    attackedBy?(attacker: number): void;
    death?(attacker: number): void;
    execute?(): void;
    executionEnded?(): void;
    executionPaused?(): void;
    executionResumed?(): void;
    executionStarted?(extra?: any): void;
    getDefaultName?(): string;
    getDefaultPriority?(): number;
    hurtBy?(attacker: number, damage: number): void;
    projectileHit?(projectile: number): void;
}

Hierarchy (view full)

Implemented by

Methods

attackedBy? death? execute? executionEnded? executionPaused? executionResumed? executionStarted? getDefaultName? getDefaultPriority? hurtBy? projectileHit?

Properties

data? params?

Methods

OptionalattackedBy

  • attackedBy(attacker): void

  • Called when entity is attacked by player.

    Parameters

    • attacker: number

      player that attacked this entity

    Returns void

Optionaldeath

  • death(attacker): void

  • Called when entity is dead.

    Parameters

    • attacker: number

      entity that damaged this entity, or -1 if damage source is not an entity

    Returns void

Optionalexecute

  • execute(): void

  • Defines main logic of the AI type.

    Returns void

OptionalexecutionEnded

  • executionEnded(): void

  • Called when AI type execution ends.

    Returns void

OptionalexecutionPaused

  • executionPaused(): void

  • Called when AI type execution is paused.

    Returns void

OptionalexecutionResumed

  • executionResumed(): void

  • Called when AI type execution is resumed.

    Returns void

OptionalexecutionStarted

OptionalgetDefaultName

  • getDefaultName(): string

  • Returns string

    AI type's default name.

OptionalgetDefaultPriority

  • getDefaultPriority(): number

  • Returns number

    AI type's default priority.

OptionalhurtBy

  • hurtBy(attacker, damage): void

  • Called when entity gets hurt.

    Parameters

    • attacker: number

      entity that damaged this entity, or -1 if damage source is not an entity

    • damage: number

      amount of damage

    Returns void

OptionalprojectileHit

  • projectileHit(projectile): void

  • Called when a projectile hits the entity.

    Parameters

    • projectile: number

      projectile entity ID

    Returns void

Properties

Optionaldata

data?: object

Object containing the state of the AI type.

Optionalparams

params?: object

Default parameters set.

Settings

Member Visibility

On This Page

Methods
Properties

Copyright © 2024 Nernar. Copyright © 2020 #mineprogramming. Built with ❤ and TypeDoc.