User Tools

Site Tools


api:game_action

GAME_ACTION

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

Virtual function

boolean isHidden()

api/game_action.txt · Last modified: 2023/02/27 11:03 (external edit)