Class Swim

Swim AI type, if the entity is in water, it swims.

Hierarchy (view full)

EntityAIClass
- Swim

Index

Constructors

Methods

aiEntityChanged changeSelfPriority disableAI enableAI finishExecution getAI getPriority instantiate removeExecutionTimer setExecutionTimer setParams setPriority

Properties

data entity? isInstance params parent?

Constructors

constructor

new Swim(customPrototype): Swim
Creates swim entity AI type.
Parameters
- customPrototype: EntityAIPrototype & {
  velocity?: number;
  }
  AI type prototype
Returns Swim
Overrides EntityAIClass.constructor
- Defined in EntityAI.d.ts:349

Methods

aiEntityChanged

aiEntityChanged(entity): void
Occurs when entity this instance is assigned to this AI type instance, if you override this method, be sure to assign entity to EntityAIClass.EntityAIPrototype.
Parameters
- entity: number
Returns void
Inherited from EntityAIClass.aiEntityChanged
- Defined in EntityAI.d.ts:54

changeSelfPriority

changeSelfPriority(priority): void
Changes own priority in parent's controller.
Parameters
- priority: number
Returns void
Inherited from EntityAIClass.changeSelfPriority
- Defined in EntityAI.d.ts:64

disableAI

disableAI(name): void
Disables any AI by it's name in the controller.
Parameters
- name: string
  AI name to be disabled
Returns void
Inherited from EntityAIClass.disableAI
- Defined in EntityAI.d.ts:78

enableAI

enableAI(name, priority, extra): void
Enables any AI by it's name in the controller.
Parameters
- name: string
  AI name to be enables
- priority: number
  priority to be set to the enabled AI
- extra: any
  some extra data passed to
Returns void
Inherited from EntityAIClass.enableAI
- Defined in EntityAI.d.ts:72

finishExecution

finishExecution(): void
Finishes AI execution and disables it in parent controller.

Returns void
Inherited from EntityAIClass.finishExecution
- Defined in EntityAI.d.ts:59

getAI

getAI(name): EntityAIClass
Gets any AI object by it's name from the current controller.
Parameters
- name: string
  AI name
Returns EntityAIClass
Inherited from EntityAIClass.getAI
- Defined in EntityAI.d.ts:91

getPriority

getPriority(name): number
Gets any AI priority from the current controller by AI name.
Parameters
- name: string
  AI name
Returns number
Inherited from EntityAIClass.getPriority
- Defined in EntityAI.d.ts:97

instantiate

instantiate(parent, name): EntityAIClass
Method that is called to create AI type instance using current instance as pattern.
Parameters
- parent: any
- name: string
Returns EntityAIClass
Inherited from EntityAIClass.instantiate
- Defined in EntityAI.d.ts:47

removeExecutionTimer

removeExecutionTimer(): void
Resets execution timer so that AI is executed with no time limits.

Returns void
Inherited from EntityAIClass.removeExecutionTimer
- Defined in EntityAI.d.ts:22

setExecutionTimer

setExecutionTimer(timer): void
Sets execution timer time in ticks. AI will be executed specified number of ticks.
Parameters
- timer: number
  execution time in ticks
Returns void
Inherited from EntityAIClass.setExecutionTimer
- Defined in EntityAI.d.ts:17

setParams

setParams(params): void
Parameters
- params: object
Returns void
AI type's default name.
Inherited from EntityAIClass.setParams
- Defined in EntityAI.d.ts:102

setPriority

setPriority(name, priority): void
Sets any AI priority by it's name in the controller.
Parameters
- name: string
  AI name to change priority
- priority: number
  priority to be set to the AI
Returns void
Inherited from EntityAIClass.setPriority
- Defined in EntityAI.d.ts:85

Properties

data

data: object

Object containing the state of the AI type.

`Optional`entity

entity?: number

Numeric unique entity idenifier that uses this AI type instance or null if it is the pattern.

isInstance

isInstance: boolean

If set to true, it is an instance of AI type, else the pattern (pattern should not be modified directly, AI controller calls instantiate to create instances of AI type).

params

params: object

All the parameters of the AI instance.

`Optional`parent

parent?: CustomEntity

Instantiated custom entity that uses this AI type instance or null if it is the pattern.

Class Swim

Hierarchy (view full)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns Swim

Methods

aiEntityChanged

Parameters

Returns void

changeSelfPriority

Parameters

Returns void

disableAI

Parameters

Returns void

enableAI

Parameters

Returns void

finishExecution

Returns void

getAI

Parameters

Returns EntityAIClass

getPriority

Parameters

Returns number

instantiate

Parameters

Returns EntityAIClass

removeExecutionTimer

Returns void

setExecutionTimer

Parameters

Returns void

setParams

Parameters

Returns void

setPriority

Parameters

Returns void

Properties

data

Optionalentity

isInstance

params

Optionalparent

Settings

On This Page

`Optional`entity

`Optional`parent