Class: Game_CommonEvent

Inherits:

Object

• Object
• Game_CommonEvent

Defined in:

docs/00600_Script_RMXP.rb

Overview

Describe a common event during the game processing

Constant Summary

WILD_BATTLE =

Returns ID of the wild battle start common event.

Returns:

• (Integer) —

  ID of the wild battle start common event

1

APPEARANCE =

Returns ID of the appearence common event.

Returns:

• (Integer) —

  ID of the appearence common event

2

FOLLOWER_SPEECH =

Returns ID of the follower speech common event.

Returns:

• (Integer) —

  ID of the follower speech common event

5

HOLE_FALLING =

Returns ID of the falling from hole common event.

Returns:

• (Integer) —

  ID of the falling from hole common event

8

SURF_ENTER =

Returns ID of the enter surf common event.

Returns:

• (Integer) —

  ID of the enter surf common event

9

SURF_LEAVE =

Returns ID of the leaving surf common event.

Returns:

• (Integer) —

  ID of the leaving surf common event

10

HEADBUTT =

Returns ID of the headbutt common event.

Returns:

• (Integer) —

  ID of the headbutt common event

20

WATERFALL =

Returns ID of the waterfall common event.

Returns:

• (Integer) —

  ID of the waterfall common event

26

WHIRLPOOL =

Returns ID of the whirlpool common event.

Returns:

• (Integer) —

  ID of the whirlpool common event

28

DIVE =

Returns ID of the dive common event.

Returns:

• (Integer) —

  ID of the dive common event

29

Instance Method Summary

• #initialize(common_event_id) ⇒ Game_CommonEvent constructor

  Initialize the Game_CommonEvent.

• #list

  List of commands of the common event.

• #name

  Name of the common event.

• #refresh

  Refresh the common event.

• #switch_id

  id of the switch that triggers the common event.

• #trigger

  trigger condition of the common event.

• #update

  Update the common event, if there’s an internal Interpreter, it’s being updated.

Constructor Details

#initialize(common_event_id) ⇒ Game_CommonEvent

Initialize the Game_CommonEvent

Parameters:

• common_event_id (Integer) —

  id of the common event in the database

# File 'docs/00600_Script_RMXP.rb', line 262

def initialize(common_event_id)
end

Instance Method Details

#list

List of commands of the common event

# File 'docs/00600_Script_RMXP.rb', line 274

def list
end

#name

Name of the common event

# File 'docs/00600_Script_RMXP.rb', line 265

def name
end

#refresh

Refresh the common event. If it triggers automatically, an internal Interpreter is generated

# File 'docs/00600_Script_RMXP.rb', line 277

def refresh
end

#switch_id

id of the switch that triggers the common event

# File 'docs/00600_Script_RMXP.rb', line 271

def switch_id
end

#trigger

trigger condition of the common event

# File 'docs/00600_Script_RMXP.rb', line 268

def trigger
end

#update

Update the common event, if there’s an internal Interpreter, it’s being updated

# File 'docs/00600_Script_RMXP.rb', line 280

def update
end