Class: Game_Character

Inherits:

Object

• Object
• Game_Character

Includes:

GameData::SystemTags

Defined in:

docs/01450_Systems_00003_Map_Engine.rb

Overview

Class that describe and manipulate a Character (Player/Events)

Direct Known Subclasses

Game_Event, Game_Player

Constant Summary

SurfTag =

SystemTags that trigger Surfing

[TPond, TSea, RapidsL, RapidsR, RapidsU, RapidsD]

SurfLTag =

SystemTags that does not trigger leaving water

SurfTag + [BridgeUD, BridgeRL, RapidsL, RapidsR, RapidsU, RapidsD, AcroBikeRL, AcroBikeUD, WaterFall, JumpD, JumpL, JumpR, JumpU, TUnderWater, Whirlpool]

SlideTags =

SystemTags that triggers “sliding” state

[TIce, RapidsL, RapidsR, RapidsU, RapidsD, RocketL, RocketU, RocketD, RocketR, RocketRL, RocketRU, RocketRD, RocketRR]

SHADOW_DISABLED_UPDATE_VALUES =

Values that allows the shadow_disabled update in set_appearance

[false, true, nil]

StairsTag =

Array of SystemTag that define stairs

[StairsL, StairsD, StairsU, StairsR]

PARTICLES_METHODS =

Constant defining all the particle method to call

{TGrass => :particle_push_grass, TTallGrass => :particle_push_tall_grass, TSand => :particle_push_sand, TSnow => :particle_push_snow, TPond => :particle_push_pond, TWetSand => :particle_push_wetsand, Puddle => :particle_push_puddle}

SAND_PARTICLE_NAME =

Constant telling the sand particle name to push (according to the direction)

{2 => :sand_d, 4 => :sand_l, 6 => :sand_r, 8 => :sand_u}

SNOW_PARTICLE_NAME =

Constant telling the snow particle name to push (according to the direction)

{2 => :snow_d, 4 => :snow_l, 6 => :snow_r, 8 => :snow_u}

EMPTY_MOVE_ROUTE =

Move route that is empty and serve as a template for all the generate move route (by Path Finding)

RPG::MoveRoute.new

Constants included from GameData::SystemTags

GameData::SystemTags::AcroBike, GameData::SystemTags::AcroBikeRL, GameData::SystemTags::AcroBikeUD, GameData::SystemTags::BridgeRL, GameData::SystemTags::BridgeUD, GameData::SystemTags::CrackedSoil, GameData::SystemTags::DeepSwamp, GameData::SystemTags::Empty, GameData::SystemTags::HeadButt, GameData::SystemTags::Hole, GameData::SystemTags::JumpD, GameData::SystemTags::JumpL, GameData::SystemTags::JumpR, GameData::SystemTags::JumpU, GameData::SystemTags::MachBike, GameData::SystemTags::Puddle, GameData::SystemTags::RapidsD, GameData::SystemTags::RapidsL, GameData::SystemTags::RapidsR, GameData::SystemTags::RapidsU, GameData::SystemTags::Road, GameData::SystemTags::RocketD, GameData::SystemTags::RocketL, GameData::SystemTags::RocketR, GameData::SystemTags::RocketRD, GameData::SystemTags::RocketRL, GameData::SystemTags::RocketRR, GameData::SystemTags::RocketRU, GameData::SystemTags::RocketU, GameData::SystemTags::SlopesL, GameData::SystemTags::SlopesR, GameData::SystemTags::StairsD, GameData::SystemTags::StairsL, GameData::SystemTags::StairsR, GameData::SystemTags::StairsU, GameData::SystemTags::StopSlide, GameData::SystemTags::SwampBorder, GameData::SystemTags::TCave, GameData::SystemTags::TGrass, GameData::SystemTags::TIce, GameData::SystemTags::TMount, GameData::SystemTags::TPond, GameData::SystemTags::TSand, GameData::SystemTags::TSea, GameData::SystemTags::TSnow, GameData::SystemTags::TTallGrass, GameData::SystemTags::TUnderWater, GameData::SystemTags::TWetSand, GameData::SystemTags::WaterFall, GameData::SystemTags::Whirlpool, GameData::SystemTags::ZTag

Instance Attribute Summary

• #__bridge

  The bridge state.

• #animation_id ⇒ Integer

  ID of the animation to play on the character.

• #blend_type ⇒ Integer readonly

  Blending of the event (0 is the only one that actually works).

• #can_make_footprint ⇒ Boolean

  Tell if the character can make footprint on the ground or not.

• #character_hue ⇒ Intger

  Must be 0.

• #character_name ⇒ String

  Name of the character graphic used to display the event.

• #charset_animation ⇒ Hash^?

  Hash if a charset animation is setup, else nil.

• #direction ⇒ Integer

  Direction where the event is looking (2 = down, 6 = right, 4 = left, 8 = up).

• #direction_fix ⇒ Boolean readonly

  If the direction is fixed.

• #follower ⇒ Game_Character^? readonly

  The follower.

• #id ⇒ Integer readonly

  Id of the event in the map.

• #in_swamp ⇒ Integer, false

  If the character is in swamp tile and the power of the swamp tile.

• #is_pokemon ⇒ Boolean

  If the character is a Pokemon (affect the step anime).

• #move_route readonly

  The current move route.

• #move_route_forcing ⇒ Boolean readonly

  If the character is forced to move using a specific route.

• #move_route_index readonly

  The current move route index.

• #move_speed ⇒ Integer

  Dynamic move_speed value of the Game_Character, return a different value than @move_speed.

• #no_slide ⇒ Boolean

  If the character is unaffected by sliding tags.

• #offset_screen_x ⇒ Integer^?

  Offset x of the character on the screen.

• #offset_screen_y ⇒ Integer^?

  Offset y of the character on the screen.

• #offset_shadow_screen_x ⇒ Integer^?

  Offset x of the character on the screen.

• #offset_shadow_screen_y ⇒ Integer^?

  Offset y of the character on the screen.

• #opacity ⇒ Integer

  Opacity of the event when it’s shown.

• #particles_disabled ⇒ Boolean

  If the particles are disabled for the Character.

• #path ⇒ Array<RPG::MoveCommand>, ...

  The current path.

• #pattern ⇒ Integer readonly

  Current pattern of the character graphic shown.

• #real_x ⇒ Integer readonly

  “real” X position of the event, usually x * 128.

• #real_y ⇒ Integer readonly

  “real” Y position of the event, usually y * 128.

• #reflection_enabled ⇒ Boolean

  If the character has reflection.

• #shadow_disabled ⇒ Boolean

  If the shadow should be shown or not.

• #sliding

  The current sliding state.

• #step_anime ⇒ Boolean

  If the event has a patern animation while staying.

• #surfing writeonly

  The current surfing state.

• #through ⇒ Boolean

  If the character is traversable and it can walk through any tiles.

• #tile_id ⇒ Integer readonly

  ID of the tile shown as the event (0 = no tile).

• #transparent ⇒ Boolean

  If the event is invisible.

• #x ⇒ Integer

  X position of the event in the current map.

• #y ⇒ Integer

  Y position of the event in the current map.

• #z ⇒ Integer

  Z priority of the event.

Instance Method Summary

• #activated? ⇒ Boolean

  Check if the character is activate.

• #animate_from_charset(lines, duration, reverse: false, repeat: false, last_frame_delay: false, reset_at_end: false) ⇒ Boolean

  Set the charset animation.

• #bridge_down_check(z) (also: #bridge_up_check)

  Adjust the Character informations related to the brige when it moves down (or up).

• #bridge_left_check(z) (also: #bridge_right_check)

  Adjust the Character informations related to the brige when it moves left (or right).

• #bush_depth ⇒ Integer

  bush_depth of the sprite of the character.

• #cancel_charset_animation

  Cancel the charset animation.

• #check_event_trigger_touch(*args)

  Define the function check_event_trigger_touch to prevent bugs.

• #contact?(x, y, z) ⇒ Boolean

  Check if it’s possible to have contact interaction with this Game_Character at certain coordinates.

• #define_path(path)

  Define the path from path_finding.

• #detect_swamp

  Detect if the event walks in a swamp or a deep swamp and change the Game_Character states.

• #each_front_tiles(nb_steps) {|x, y, d| ... }

  Iterate through each front tiles including current tile.

• #each_front_tiles_rect(nb_steps, dist) {|x, y, d| ... }

  Iterate through each front tiles including current tile.

• #emotion(type, wait = 34, params = {})

  Show an emotion to an event or the player.

• #event_passable_check?(new_x, new_y, z, game_map) ⇒ Boolean

  Check the passage related to events.

• #find_path(to:, radius: 0, tries: Pathfinding::TRY_COUNT, type: nil)

  Request a path to the target and follow it as soon as it found.

• #fishing_creek_amount ⇒ Integer

  Count the number of impassable tiles around the fishing spot.

• #fly_reset_attributes

  Reset some attributes when using Fly.

• #follower_check?(new_x, new_y, z) ⇒ Boolean

  Check the passage related to events.

• #follower_move

  Move a follower.

• #follower_sliding? ⇒ Boolean

  Check if the follower slides.

• #follower_tail ⇒ Game_Character, self

  Return the tail of the following queue.

• #force_move_route(move_route)

  Force the character to adopt a move route and save the original one.

• #front_name_check(name) ⇒ Boolean (also: #front_name_detect)

  Check a the #front_event has a specific name.

• #front_system_tag ⇒ Integer

  Return the SystemTag in the front of the Game_Character.

• #front_system_tag_db_symbol ⇒ Symbol

  Return the db_symbol of the front system tag.

• #front_terrain_tag ⇒ Integer^?

  Terrain tag in front of the character.

• #front_tile ⇒ Array(Integer, Integer)

  Return tile position in front of the player.

• #front_tile_event ⇒ Game_Event^?

  Return the event that stand in the front of the Player.

• #front_tile_id ⇒ Integer, 0

  Return the id of the #front_tile_event.

• #increase_steps

  Increase step prototype (sets @stop_count to 0).

• #initialize ⇒ Game_Character constructor

  Default initializer.

• #jump(x_plus, y_plus, follow_move = true) ⇒ Boolean

  Make the Game_Character jump.

• #jump_bridge_check(x_plus, y_plus)

  Perform the bridge check for the jump operation.

• #jumping? ⇒ Boolean

  is the character jumping ?.

• #lock

  Make the character look the player during a dialog.

• #lock? ⇒ Boolean

  Is the character locked ? (looking to the player when it’s activated).

• #look_this_event

  Look directly to the current event.

• #look_to(event_id)

  Look directly to a specific event.

• #movable? ⇒ Boolean

  Is the character able to execute a move action.

• #move_away_from_player

  Move the Game_Character away from the player.

• #move_backward

  Move the Game_Character backward.

• #move_down(turn_enabled = true)

  Move Game_Character down.

• #move_follower_to_character

  Warp the follower to the event it follows.

• #move_forward

  Move the Game_Character forward.

• #move_frequency=(value)

  Set the move_frequency (and define the max_stop_count value).

• #move_left(turn_enabled = true)

  Move Game_Character left.

• #move_lower_left

  Move the Game_Character lower left.

• #move_lower_right

  Move the Game_Character lower right.

• #move_random

  Move the Game_Character to a random direction.

• #move_random_within_systemtag(sys_tag_id)

  Move the Game_Character to a random direction within a rectangular zone.

• #move_random_within_zone(lx, rx, ty, dy)

  Move the Game_Character to a random direction within a rectangular zone.

• #move_right(turn_enabled = true)

  Move Game_Character right.

• #move_toward(tx, ty)

  Move the entity toward a specific coordinate.

• #move_toward_player

  Move the Game_Character toward the player.

• #move_type_path

  Movement induced by the Path Finding.

• #move_up(turn_enabled = true)

  Move Game_Character up.

• #move_upper_left

  Move the Game_Character upper left.

• #move_upper_right

  Move the Game_Character upper right.

• #movement_process_end(no_follower_move = false)

  End of the movement process.

• #moveto(x, y)

  Warps the character on the Map to specific coordinates.

• #moving? ⇒ Boolean

  is the character moving ?.

• #next_event_follower ⇒ Game_Event^?

  Rerturn the first follower that is a Game_Event in the queue.

• #original_move_speed ⇒ Integer

  Return the original move speed of the character.

• #particle_push

  Push a particle to the particle stack if possible.

• #particle_push_grass

  Push a grass particle.

• #particle_push_pond

  Push a pond particle.

• #particle_push_puddle

  Push a pond particle.

• #particle_push_sand

  Push a sand particle.

• #particle_push_snow

  Push a snow particle.

• #particle_push_tall_grass

  Push a tall grass particle.

• #particle_push_wetsand

  Push a wet sand particle.

• #passable?(x, y, d, skip_event = false) ⇒ Boolean

  Is the tile in front of the character passable ?.

• #passable_bridge_check?(x, y, d, new_x, new_y, z, game_map, sys_tag) ⇒ Boolean

  Check the bridge related passabilities.

• #passage_surf_check?(sys_tag) ⇒ Boolean

  Check the surf related passabilities.

• #process_slope_y_modifier(y_modifier)

  Process the slope y modifier.

• #reset_follower

  Reset the follower stack of the current entity.

• #reset_follower_move

  Remove the memorized moves of the follower.

• #screen_x ⇒ Integer

  Return the x position of the sprite on the screen.

• #screen_y ⇒ Integer

  Return the y position of the sprite on the screen.

• #screen_z(_height = 0) ⇒ Integer

  Return the z superiority of the sprite of the character.

• #set_appearance(character_name, character_hue = 0)

  Define the new appearance of the character.

• #set_follower(follower)

  Define the follower of the event.

• #set_surfing

  Set the Game_Character in the “surfing” mode (not able to walk on ground but able to walk on water).

• #shadow_screen_x ⇒ Integer

  Return the x position of the shadow of the character on the screen.

• #shadow_screen_y ⇒ Integer

  Return the y position of the shadow of the character on the screen.

• #sliding? ⇒ Boolean

  Check if the Game_Character slides.

• #slope_check_left(write = true)

  Update the slope values when moving to left.

• #slope_check_right(write = true) ⇒ Integer

  Update the slope values when moving to right, and return y slope modifier.

• #stair_move_left ⇒ Boolean

  Try to move the Game_Character on a stair to the left.

• #stair_move_right ⇒ Boolean

  Try to move the Game_Character on a stair to the right.

• #stop_path

  Stop following the path if there is one and clear the agent.

• #straighten

  Adjust the character position.

• #surfing? ⇒ Boolean

  Check if the Game_Character is in the “surfing” mode.

• #system_tag ⇒ Integer

  Return the SystemTag where the Game_Character stands.

• #system_tag_db_symbol ⇒ Symbol

  Return the db_symbol of the system tag.

• #terrain_tag ⇒ Integer^?

  current terrain tag on which the character steps.

• #turn_180

  Turn 180°.

• #turn_away_from_player

  Turn away from the player.

• #turn_down

  Turn down unless direction fix.

• #turn_left

  Turn left unless direction fix.

• #turn_left_90

  Turn 90° to the left of the Game_Character.

• #turn_random

  Turn in a random direction.

• #turn_right

  Turn right unless direction fix.

• #turn_right_90

  Turn 90° to the right of the Game_Character.

• #turn_right_or_left_90

  Turn random right or left 90°.

• #turn_toward_character(character)

  Turn toward another character.

• #turn_toward_player

  Turn toward the player.

• #turn_up

  Turn up unless direction fix.

• #unlock

  Release the character, can perform its natural movements.

• #update

  Update the Game_Character (manages movements and some animations).

• #wait_charset_animation

  Tell the Game_Character to wait for its charset animation to finish.

• #z_bridge_check(sys_tag)

  Check bridge information and adjust the z position of the Game_Character.

Methods included from GameData::SystemTags

gen, system_tag_db_symbol

Constructor Details

#initialize ⇒ Game_Character

Default initializer

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1288

def initialize
end

Instance Attribute Details

#__bridge

The bridge state

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1926

def __bridge
  @__bridge
end

#animation_id ⇒ Integer

Returns ID of the animation to play on the character.

Returns:

• (Integer) —

  ID of the animation to play on the character

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1272

def animation_id
  @animation_id
end

#blend_type ⇒ Integer (readonly)

Returns blending of the event (0 is the only one that actually works).

Returns:

• (Integer) —

  blending of the event (0 is the only one that actually works)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1621

def blend_type
  @blend_type
end

#can_make_footprint ⇒ Boolean

Returns tell if the character can make footprint on the ground or not.

Returns:

• (Boolean) —

  tell if the character can make footprint on the ground or not

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1695

def can_make_footprint
  @can_make_footprint
end

#character_hue ⇒ Intger

Returns must be 0.

Returns:

• (Intger) —

  must be 0

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1617

def character_hue
  @character_hue
end

#character_name ⇒ String

Returns name of the character graphic used to display the event.

Returns:

• (String) —

  name of the character graphic used to display the event

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1615

def character_name
  @character_name
end

#charset_animation ⇒ Hash^?

Returns hash if a charset animation is setup, else nil.

Returns:

• (Hash, nil) —

  hash if a charset animation is setup, else nil

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1631

def charset_animation
  @charset_animation
end

#direction ⇒ Integer

Returns direction where the event is looking (2 = down, 6 = right, 4 = left, 8 = up).

Returns:

• (Integer) —

  direction where the event is looking (2 = down, 6 = right, 4 = left, 8 = up)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1266

def direction
  @direction
end

#direction_fix ⇒ Boolean (readonly)

If the direction is fixed

Returns:

• (Boolean)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1283

def direction_fix
  @direction_fix
end

#follower ⇒ Game_Character^? (readonly)

Returns the follower.

Returns:

• (Game_Character, nil) —

  the follower

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1276

def follower
  @follower
end

#id ⇒ Integer (readonly)

Id of the event in the map

Returns:

• (Integer)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1254

def id
  @id
end

#in_swamp ⇒ Integer, false

Returns if the character is in swamp tile and the power of the swamp tile.

Returns:

• (Integer, false) —

  if the character is in swamp tile and the power of the swamp tile

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1691

def in_swamp
  @in_swamp
end

#is_pokemon ⇒ Boolean

Returns if the character is a Pokemon (affect the step anime).

Returns:

• (Boolean) —

  if the character is a Pokemon (affect the step anime)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1693

def is_pokemon
  @is_pokemon
end

#move_route (readonly)

The current move route

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1922

def move_route
  @move_route
end

#move_route_forcing ⇒ Boolean (readonly)

Returns if the character is forced to move using a specific route.

Returns:

• (Boolean) —

  if the character is forced to move using a specific route

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1268

def move_route_forcing
  @move_route_forcing
end

#move_route_index (readonly)

The current move route index

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1924

def move_route_index
  @move_route_index
end

#move_speed ⇒ Integer

Dynamic move_speed value of the Game_Character, return a different value than @move_speed

Returns:

• (Integer) —

  the dynamic move_speed

Author:

• Nuri Yuri

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1274

def move_speed
  @move_speed
end

#no_slide ⇒ Boolean

Returns if the character is unaffected by sliding tags.

Returns:

• (Boolean) —

  if the character is unaffected by sliding tags

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1278

def no_slide
  @no_slide
end

#offset_screen_x ⇒ Integer^?

Returns offset x of the character on the screen.

Returns:

• (Integer, nil) —

  offset x of the character on the screen

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1637

def offset_screen_x
  @offset_screen_x
end

#offset_screen_y ⇒ Integer^?

Returns offset y of the character on the screen.

Returns:

• (Integer, nil) —

  offset y of the character on the screen

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1633

def offset_screen_y
  @offset_screen_y
end

#offset_shadow_screen_x ⇒ Integer^?

Returns offset x of the character on the screen.

Returns:

• (Integer, nil) —

  offset x of the character on the screen

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1639

def offset_shadow_screen_x
  @offset_shadow_screen_x
end

#offset_shadow_screen_y ⇒ Integer^?

Returns offset y of the character on the screen.

Returns:

• (Integer, nil) —

  offset y of the character on the screen

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1635

def offset_shadow_screen_y
  @offset_shadow_screen_y
end

#opacity ⇒ Integer

Returns opacity of the event when it’s shown.

Returns:

• (Integer) —

  opacity of the event when it’s shown

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1619

def opacity
  @opacity
end

#particles_disabled ⇒ Boolean

Returns if the particles are disabled for the Character.

Returns:

• (Boolean) —

  if the particles are disabled for the Character

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1882

def particles_disabled
  @particles_disabled
end

#path ⇒ Array<RPG::MoveCommand>, ...

The current path

Returns:

• (Array<RPG::MoveCommand>, :pending, nil)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1933

def path
  @path
end

#pattern ⇒ Integer (readonly)

Returns current pattern of the character graphic shown.

Returns:

• (Integer) —

  current pattern of the character graphic shown

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1623

def pattern
  @pattern
end

#real_x ⇒ Integer (readonly)

Returns “real” X position of the event, usually x * 128.

Returns:

• (Integer) —

  “real” X position of the event, usually x * 128

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1262

def real_x
  @real_x
end

#real_y ⇒ Integer (readonly)

Returns “real” Y position of the event, usually y * 128.

Returns:

• (Integer) —

  “real” Y position of the event, usually y * 128

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1264

def real_y
  @real_y
end

#reflection_enabled ⇒ Boolean

If the character has reflection

Returns:

• (Boolean)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1286

def reflection_enabled
  @reflection_enabled
end

#shadow_disabled ⇒ Boolean

Returns if the shadow should be shown or not.

Returns:

• (Boolean) —

  if the shadow should be shown or not

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1629

def shadow_disabled
  @shadow_disabled
end

#sliding

The current sliding state

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1280

def sliding
  @sliding
end

#step_anime ⇒ Boolean

Returns if the event has a patern animation while staying.

Returns:

• (Boolean) —

  if the event has a patern animation while staying

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1627

def step_anime
  @step_anime
end

#surfing=(value) (writeonly)

The current surfing state

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1930

def surfing=(value)
  @surfing = value
end

#through ⇒ Boolean

Returns if the character is traversable and it can walk through any tiles.

Returns:

• (Boolean) —

  if the character is traversable and it can walk through any tiles

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1270

def through
  @through
end

#tile_id ⇒ Integer (readonly)

Returns ID of the tile shown as the event (0 = no tile).

Returns:

• (Integer) —

  ID of the tile shown as the event (0 = no tile)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1613

def tile_id
  @tile_id
end

#transparent ⇒ Boolean

Returns if the event is invisible.

Returns:

• (Boolean) —

  if the event is invisible

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1625

def transparent
  @transparent
end

#x ⇒ Integer

Returns X position of the event in the current map.

Returns:

• (Integer) —

  X position of the event in the current map

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1256

def x
  @x
end

#y ⇒ Integer

Returns Y position of the event in the current map.

Returns:

• (Integer) —

  Y position of the event in the current map

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1258

def y
  @y
end

#z ⇒ Integer

Returns Z priority of the event.

Returns:

• (Integer) —

  Z priority of the event

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1260

def z
  @z
end

Instance Method Details

#activated? ⇒ Boolean

Check if the character is activate. Useful to make difference between event without active page and others.

Returns:

• (Boolean)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1344

def activated?
end

#animate_from_charset(lines, duration, reverse: false, repeat: false, last_frame_delay: false, reset_at_end: false) ⇒ Boolean

Set the charset animation. It can be needed to set the event in direction fixed.

Parameters:

• lines (Array<Integer>) —

  list of the lines to animates (0,1,2,3)

• duration (Integer) —

  duration of the animation in frame (30 frames per secondes)

• reverse (Boolean) (defaults to: false) —

  <default: false> set it to true if the animation is reversed

• repeat (Boolean, Integer) (defaults to: false) —

  true if looping continuously, Integer for the number of loops, false for no loops

• last_frame_delay (Boolean) (defaults to: false) —

  if the delay should also be applied to the last frame of the animation

• reset_at_end (Boolean) (defaults to: false) —

  if the character’s appearance should be set back to the first frame at the end of the anim

Returns:

• (Boolean)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1659

def animate_from_charset(lines, duration, reverse: false, repeat: false, last_frame_delay: false, reset_at_end: false)
end

#bridge_down_check(z) Also known as: bridge_up_check

Adjust the Character informations related to the brige when it moves down (or up)

Parameters:

• z (Integer) —

  the z position

Author:

• Nuri Yuri

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1866

def bridge_down_check(z)
end

#bridge_left_check(z) Also known as: bridge_right_check

Adjust the Character informations related to the brige when it moves left (or right)

Parameters:

• z (Integer) —

  the z position

Author:

• Nuri Yuri

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1872

def bridge_left_check(z)
end

#bush_depth ⇒ Integer

bush_depth of the sprite of the character

Returns:

• (Integer)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1649

def bush_depth
end

#cancel_charset_animation

Cancel the charset animation

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1662

def cancel_charset_animation
end

#check_event_trigger_touch(*args)

Define the function check_event_trigger_touch to prevent bugs

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1340

def check_event_trigger_touch(*args)
end

#contact?(x, y, z) ⇒ Boolean

Check if it’s possible to have contact interaction with this Game_Character at certain coordinates

Parameters:

• x (Integer) —

  x position

• y (Integer) —

  y position

• z (Integer) —

  z position

Returns:

• (Boolean)

Author:

• Nuri Yuri

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1856

def contact?(x, y, z)
end

#define_path(path)

Define the path from path_finding

Parameters:

• path (Array<RPG::MoveCommand>)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1954

def define_path(path)
end

#detect_swamp

Detect if the event walks in a swamp or a deep swamp and change the Game_Character states.

Author:

• Nuri Yuri

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1860

def detect_swamp
end

#each_front_tiles(nb_steps) {|x, y, d| ... }

Iterate through each front tiles including current tile

Parameters:

• nb_steps (Integer) —

  number of step in front of the event to iterate

Yield Parameters:

• x (Integer) —

  x coordinate

• y (Integer) —

  y coordinate

• d (Integer) —

  direction

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1797

def each_front_tiles(nb_steps)
end

#each_front_tiles_rect(nb_steps, dist) {|x, y, d| ... }

Iterate through each front tiles including current tile

Parameters:

• nb_steps (Integer) —

  number of step in front of the event to iterate

• dist (Integer) —

  distance in both side of the detection

Yield Parameters:

• x (Integer) —

  x coordinate

• y (Integer) —

  y coordinate

• d (Integer) —

  direction

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1805

def each_front_tiles_rect(nb_steps, dist)
end

#emotion(type, wait = 34, params = {})

Show an emotion to an event or the player

Parameters:

• type (Symbol) —

  the type of emotion (see wiki)

• wait (Integer) (defaults to: 34) —

  the number of frame the event will wait after this command.

• params (Hash) (defaults to: {}) —

  particle params

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1887

def emotion(type, wait = 34, params = {})
end

#event_passable_check?(new_x, new_y, z, game_map) ⇒ Boolean

Check the passage related to events

Parameters:

• new_x (Integer) —

  new x position

• new_y (Integer) —

  new y position

• z (Integer) —

  current z position

• game_map (Game_Map) —

  map object

Returns:

• (Boolean) —

  if the tile has no event that block the way

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1382

def event_passable_check?(new_x, new_y, z, game_map)
end

#find_path(to:, radius: 0, tries: Pathfinding::TRY_COUNT, type: nil)

Request a path to the target and follow it as soon as it found

Examples:

find path to x=10 y=15 with an error radius of 5 tiles

find_path(to:[10,15], radius:5)

Parameters:

• to (Array<Integer, Integer>, Game_Character) —

  the target, [x, y] or Game_Character object

• radius (Integer) (defaults to: 0) —

  <default : 0> the distance from the target to consider it as reached

• tries (Integer, Symbol) (defaults to: Pathfinding::TRY_COUNT) —

  <default : 5> the number of tries allowed to this request, use :infinity to unlimited try count

• type (Symbol) (defaults to: nil)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1944

def find_path(to:, radius: 0, tries: Pathfinding::TRY_COUNT, type: nil)
end

#fishing_creek_amount ⇒ Integer

Count the number of impassable tiles around the fishing spot

Returns:

• (Integer) —

  The number of impassable tiles

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1747

def fishing_creek_amount
end

#fly_reset_attributes

Reset some attributes when using Fly

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1396

def fly_reset_attributes
end

#follower_check?(new_x, new_y, z) ⇒ Boolean

Check the passage related to events

Parameters:

• new_x (Integer) —

  new x position

• new_y (Integer) —

  new y position

• z (Integer) —

  current z position

Returns:

• (Boolean) —

  if the tile has no event that block the way

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1389

def follower_check?(new_x, new_y, z)
end

#follower_move

Move a follower

Author:

• Nuri Yuri

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1756

def follower_move
end

#follower_sliding? ⇒ Boolean

Check if the follower slides

Returns:

• (Boolean)

Author:

• Nuri Yuri

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1765

def follower_sliding?
end

#follower_tail ⇒ Game_Character, self

Return the tail of the following queue

Returns:

• (Game_Character, self)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1774

def follower_tail
end

#force_move_route(move_route)

Force the character to adopt a move route and save the original one

Parameters:

• move_route (RPG::MoveRoute)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1299

def force_move_route(move_route)
end

#front_name_check(name) ⇒ Boolean Also known as: front_name_detect

Check a the #front_event has a specific name

Returns:

• (Boolean)

Author:

• Nuri Yuri

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1810

def front_name_check(name)
end

#front_system_tag ⇒ Integer

Return the SystemTag in the front of the Game_Character

Returns:

• (Integer) —

  ID of the SystemTag

Author:

• Nuri Yuri

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1821

def front_system_tag
end

#front_system_tag_db_symbol ⇒ Symbol

Return the db_symbol of the front system tag

Returns:

• (Symbol)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1829

def front_system_tag_db_symbol
end

#front_terrain_tag ⇒ Integer^?

Terrain tag in front of the character

Returns:

• (Integer, nil)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1825

def front_terrain_tag
end

#front_tile ⇒ Array(Integer, Integer)

Return tile position in front of the player

Returns:

• (Array(Integer, Integer)) —

  the position x and y

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1786

def front_tile
end

#front_tile_event ⇒ Game_Event^?

Return the event that stand in the front of the Player

Returns:

• (Game_Event, nil)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1790

def front_tile_event
end

#front_tile_id ⇒ Integer, 0

Return the id of the #front_tile_event

Returns:

• (Integer, 0) —

  0 if no front_tile_event

Author:

• Nuri Yuri

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1816

def front_tile_id
end

#increase_steps

Increase step prototype (sets @stop_count to 0)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1476

def increase_steps
end

#jump(x_plus, y_plus, follow_move = true) ⇒ Boolean

Make the Game_Character jump

Parameters:

• x_plus (Integer) —

  the number of tile the Game_Character will jump on x

• y_plus (Integer) —

  the number of tile the Game_Character will jump on y

• follow_move (Boolean) (defaults to: true) —

  if the follower moves when the Game_Character starts jumping

Returns:

• (Boolean) —

  if the character is jumping

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1559

def jump(x_plus, y_plus, follow_move = true)
end

#jump_bridge_check(x_plus, y_plus)

Perform the bridge check for the jump operation

Parameters:

• x_plus (Integer) —

  the number of tile the Game_Character will jump on x

• y_plus (Integer) —

  the number of tile the Game_Character will jump on y

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1564

def jump_bridge_check(x_plus, y_plus)
end

#jumping? ⇒ Boolean

is the character jumping ?

Returns:

• (Boolean)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1702

def jumping?
end

#lock

Make the character look the player during a dialog

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1722

def lock
end

#lock? ⇒ Boolean

Note:

in this state, the character is not able to perform automatic moveroute (rmxp conf)

Is the character locked ? (looking to the player when it’s activated)

Returns:

• (Boolean)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1727

def lock?
end

#look_this_event

Look directly to the current event

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1837

def look_this_event
end

#look_to(event_id)

Look directly to a specific event

Parameters:

• event_id (Integer) —

  id of the event on the Map

Author:

• Nuri Yuri

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1834

def look_to(event_id)
end

#movable? ⇒ Boolean

Is the character able to execute a move action

Returns:

• (Boolean)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1705

def movable?
end

#move_away_from_player

Move the Game_Character away from the player

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1543

def move_away_from_player
end

#move_backward

Move the Game_Character backward

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1552

def move_backward
end

#move_down(turn_enabled = true)

Move Game_Character down

Parameters:

• turn_enabled (Boolean) (defaults to: true) —

  if the Game_Character turns when impossible move

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1484

def move_down(turn_enabled = true)
end

#move_follower_to_character

Warp the follower to the event it follows

Author:

• Nuri Yuri

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1760

def move_follower_to_character
end

#move_forward

Move the Game_Character forward

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1549

def move_forward
end

#move_frequency=(value)

Set the move_frequency (and define the max_stop_count value)

Parameters:

• value (Numeric)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1292

def move_frequency=(value)
end

#move_left(turn_enabled = true)

Move Game_Character left

Parameters:

• turn_enabled (Boolean) (defaults to: true) —

  if the Game_Character turns when impossible move

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1488

def move_left(turn_enabled = true)
end

#move_lower_left

Move the Game_Character lower left

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1514

def move_lower_left
end

#move_lower_right

Move the Game_Character lower right

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1517

def move_lower_right
end

#move_random

Move the Game_Character to a random direction

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1526

def move_random
end

#move_random_within_systemtag(sys_tag_id)

Move the Game_Character to a random direction within a rectangular zone

Parameters:

• sys_tag_id (Integer) —

  the ID of the systemtag the character should only move into

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1537

def move_random_within_systemtag(sys_tag_id)
end

#move_random_within_zone(lx, rx, ty, dy)

Move the Game_Character to a random direction within a rectangular zone

Parameters:

• lx (Integer) —

  the x coordinate of the left border of the zone

• rx (Integer) —

  the x coordinate of the right border of the zone

• ty (Integer) —

  the y coordinate of the top border of the zone

• dy (Integer) —

  the y coordinate of the down border of the zone

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1533

def move_random_within_zone(lx, rx, ty, dy)
end

#move_right(turn_enabled = true)

Move Game_Character right

Parameters:

• turn_enabled (Boolean) (defaults to: true) —

  if the Game_Character turns when impossible move

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1499

def move_right(turn_enabled = true)
end

#move_toward(tx, ty)

Move the entity toward a specific coordinate

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1546

def move_toward(tx, ty)
end

#move_toward_player

Move the Game_Character toward the player

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1540

def move_toward_player
end

#move_type_path

Movement induced by the Path Finding

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1950

def move_type_path
end

#move_up(turn_enabled = true)

Move Game_Character up

Parameters:

• turn_enabled (Boolean) (defaults to: true) —

  if the Game_Character turns when impossible move

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1511

def move_up(turn_enabled = true)
end

#move_upper_left

Move the Game_Character upper left

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1520

def move_upper_left
end

#move_upper_right

Move the Game_Character upper right

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1523

def move_upper_right
end

#movement_process_end(no_follower_move = false)

End of the movement process

Parameters:

• no_follower_move (Boolean) (defaults to: false) —

  if the follower should not move

Author:

• Nuri Yuri

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1571

def movement_process_end(no_follower_move = false)
end

#moveto(x, y)

Warps the character on the Map to specific coordinates. Adjust the z position of the character.

Parameters:

• x (Integer) —

  new x position of the character

• y (Integer) —

  new y position of the character

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1305

def moveto(x, y)
end

#moving? ⇒ Boolean

is the character moving ?

Returns:

• (Boolean)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1698

def moving?
end

#next_event_follower ⇒ Game_Event^?

Rerturn the first follower that is a Game_Event in the queue

Returns:

• (Game_Event, nil)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1778

def next_event_follower
end

#original_move_speed ⇒ Integer

Return the original move speed of the character

Returns:

• (Integer)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1848

def original_move_speed
end

#particle_push

Push a particle to the particle stack if possible

Author:

• Nuri Yuri

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1893

def particle_push
end

#particle_push_grass

Push a grass particle

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1896

def particle_push_grass
end

#particle_push_pond

Push a pond particle

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1915

def particle_push_pond
end

#particle_push_puddle

Push a pond particle

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1918

def particle_push_puddle
end

#particle_push_sand

Push a sand particle

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1904

def particle_push_sand
end

#particle_push_snow

Push a snow particle

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1912

def particle_push_snow
end

#particle_push_tall_grass

Push a tall grass particle

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1899

def particle_push_tall_grass
end

#particle_push_wetsand

Push a wet sand particle

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1907

def particle_push_wetsand
end

#passable?(x, y, d, skip_event = false) ⇒ Boolean

Is the tile in front of the character passable ?

Parameters:

• x (Integer) —

  x position on the Map

• y (Integer) —

  y position on the Map

• d (Integer) —

  direction : 2, 4, 6, 8, 0. 0 = current position

• skip_event (Boolean) (defaults to: false) —

  if the function does not check events

Returns:

• (Boolean) —

  if the front/current tile is passable

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1357

def passable?(x, y, d, skip_event = false)
end

#passable_bridge_check?(x, y, d, new_x, new_y, z, game_map, sys_tag) ⇒ Boolean

Check the bridge related passabilities

Parameters:

• x (Integer) —

  current x position

• y (Integer) —

  current y position

• d (Integer) —

  current direction

• new_x (Integer) —

  new x position

• new_y (Integer) —

  new y position

• z (Integer) —

  current z position

• game_map (Game_Map) —

  map object

• sys_tag (Integer) —

  current system_tag

Returns:

• (Boolean) —

  if the tile is passable according to the bridge rules

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1369

def passable_bridge_check?(x, y, d, new_x, new_y, z, game_map, sys_tag)
end

#passage_surf_check?(sys_tag) ⇒ Boolean

Check the surf related passabilities

Parameters:

• sys_tag (Integer) —

  current system_tag

Returns:

• (Boolean) —

  if the tile is passable according to the surf rules

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1374

def passage_surf_check?(sys_tag)
end

#process_slope_y_modifier(y_modifier)

Process the slope y modifier

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1479

def process_slope_y_modifier(y_modifier)
end

#reset_follower

Reset the follower stack of the current entity

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1781

def reset_follower
end

#reset_follower_move

Remove the memorized moves of the follower

Author:

• Nuri Yuri

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1752

def reset_follower_move
end

#screen_x ⇒ Integer

Return the x position of the sprite on the screen

Returns:

• (Integer)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1320

def screen_x
end

#screen_y ⇒ Integer

Return the y position of the sprite on the screen

Returns:

• (Integer)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1324

def screen_y
end

#screen_z(_height = 0) ⇒ Integer

Return the z superiority of the sprite of the character

Parameters:

• _height (Integer) (defaults to: 0) —

  height of a frame of the character (ignored)

Returns:

• (Integer)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1337

def screen_z(_height = 0)
end

#set_appearance(character_name, character_hue = 0)

Define the new appearance of the character

Parameters:

• character_name (String) —

  name of the character graphic to display

• character_hue (Integer) (defaults to: 0) —

  must be 0

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1645

def set_appearance(character_name, character_hue = 0)
end

#set_follower(follower)

Define the follower of the event

Parameters:

• follower (Game_Character, Game_Event) —

  the follower

Author:

• Nuri Yuri

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1770

def set_follower(follower)
end

#set_surfing

Set the Game_Character in the “surfing” mode (not able to walk on ground but able to walk on water)

Author:

• Nuri Yuri

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1709

def set_surfing
end

#shadow_screen_x ⇒ Integer

Return the x position of the shadow of the character on the screen

Returns:

• (Integer)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1328

def shadow_screen_x
end

#shadow_screen_y ⇒ Integer

Return the y position of the shadow of the character on the screen

Returns:

• (Integer)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1332

def shadow_screen_y
end

#sliding? ⇒ Boolean

Check if the Game_Character slides

Returns:

• (Boolean)

Author:

• Nuri Yuri

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1719

def sliding?
end

#slope_check_left(write = true)

Update the slope values when moving to left

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1495

def slope_check_left(write = true)
end

#slope_check_right(write = true) ⇒ Integer

Update the slope values when moving to right, and return y slope modifier

Returns:

• (Integer)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1507

def slope_check_right(write = true)
end

#stair_move_left ⇒ Boolean

Try to move the Game_Character on a stair to the left

Returns:

• (Boolean) —

  if the player cannot perform a regular movement (success or blocked)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1492

def stair_move_left
end

#stair_move_right ⇒ Boolean

Try to move the Game_Character on a stair to the right

Returns:

• (Boolean) —

  if the player cannot perform a regular movement (success or blocked)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1503

def stair_move_right
end

#stop_path

Stop following the path if there is one and clear the agent

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1947

def stop_path
end

#straighten

Adjust the character position

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1295

def straighten
end

#surfing? ⇒ Boolean

Check if the Game_Character is in the “surfing” mode

Returns:

• (Boolean)

Author:

• Nuri Yuri

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1714

def surfing?
end

#system_tag ⇒ Integer

Return the SystemTag where the Game_Character stands

Returns:

• (Integer) —

  ID of the SystemTag

Author:

• Nuri Yuri

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1739

def system_tag
end

#system_tag_db_symbol ⇒ Symbol

Return the db_symbol of the system tag

Returns:

• (Symbol)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1743

def system_tag_db_symbol
end

#terrain_tag ⇒ Integer^?

current terrain tag on which the character steps

Returns:

• (Integer, nil)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1734

def terrain_tag
end

#turn_180

Turn 180°

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1593

def turn_180
end

#turn_away_from_player

Turn away from the player

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1609

def turn_away_from_player
end

#turn_down

Turn down unless direction fix

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1575

def turn_down
end

#turn_left

Turn left unless direction fix

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1578

def turn_left
end

#turn_left_90

Turn 90° to the left of the Game_Character

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1590

def turn_left_90
end

#turn_random

Turn in a random direction

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1599

def turn_random
end

#turn_right

Turn right unless direction fix

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1581

def turn_right
end

#turn_right_90

Turn 90° to the right of the Game_Character

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1587

def turn_right_90
end

#turn_right_or_left_90

Turn random right or left 90°

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1596

def turn_right_or_left_90
end

#turn_toward_character(character)

Turn toward another character

Parameters:

• character (Game_Character)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1606

def turn_toward_character(character)
end

#turn_toward_player

Turn toward the player

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1602

def turn_toward_player
end

#turn_up

Turn up unless direction fix

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1584

def turn_up
end

#unlock

Release the character, can perform its natural movements

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1730

def unlock
end

#update

Update the Game_Character (manages movements and some animations)

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1393

def update
end

#wait_charset_animation

Tell the Game_Character to wait for its charset animation to finish

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1665

def wait_charset_animation
end

#z_bridge_check(sys_tag)

Check bridge information and adjust the z position of the Game_Character

Parameters:

• sys_tag (Integer) —

  the SystemTag

Author:

• Nuri Yuri

# File 'docs/01450_Systems_00003_Map_Engine.rb', line 1878

def z_bridge_check(sys_tag)
end