User Tools

Site Tools


api:game_action

GAME_ACTION

Deprecated names:

  • EVENT_ACTION

Abstract class
Extendable
Category: Data

Inherited by:

Cloneable

Properties


DebugComment

Serialized

Unlocalized string for debug purposes (could show in some logs)

  • Type: string
  • Expected: string value

Delay

Serialized

  • Expected: TIME_SYSTEM value
  • Default value: nil

IsHidden

Serialized

  • Type: boolean
  • Expected: boolean value
  • Default value: false

Functions


getHeaderText

Virtual function

string getHeaderText()


getLocalizedName

Virtual function

string getLocalizedName()


execute

Virtual function

void execute(level [, contextualComponent])

Name Type Description
level LEVEL
contextualComponent COMPONENT

canBeExecuted

Virtual function

boolean canBeExecuted()


cancelAction

Virtual function

void cancelAction(level)

Name Type Description
level LEVEL

isHidden

internalIsEqual

Virtual function, Protected function

boolean internalIsEqual(otherDataAction)

Name Type Description
otherDataAction GAME_ACTION
api/game_action.txt · Last modified: 2024/02/06 13:53 by 127.0.0.1

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki