Class: BattleUI::Cursor

Inherits:

ShaderedSprite

• Object
• LiteRGSS::Disposable
• LiteRGSS::Drawable
• LiteRGSS::Sprite
• LiteRGSS::ShaderedSprite
• Sprite
• ShaderedSprite
• BattleUI::Cursor

Defined in:

docs/5_Battle_01_Scene.rb

Overview

Sprite showing a cursor (being animated)

Instance Attribute Summary

• #origin_x readonly

  Get the origin x.

• #origin_y readonly

  Get the origin y.

• #target_x readonly

  Get the target x.

• #target_y readonly

  Get the target y.

Attributes inherited from LiteRGSS::ShaderedSprite

#blendmode, #shader

Attributes inherited from LiteRGSS::Sprite

#__index__, #angle, #bitmap, #height, #mirror, #opacity, #ox, #oy, #src_rect, #viewport, #visible, #width, #x, #y, #z, #zoom, #zoom_x, #zoom_y

Instance Method Summary

• #initialize(viewport) ⇒ Cursor constructor

  Create a new cursor.

• #register_positions

  Register the positions so the cursor can animate itself.

• #start_animation ⇒ Yuki::Animation::TimedLoopAnimation

  Create and start the cursor animation.

• #stop_animation

  Stops the animation.

• #update

  Update the sprite.

• #visible=(visible)

  Set the visibility.

Methods inherited from Sprite

#load, #mouse_in?, #set_origin_div, #set_rect, #set_rect_div, #set_z, #simple_mouse_in?, #translate_mouse_coords

Methods inherited from LiteRGSS::Sprite

new, #set_origin, #set_position

Methods inherited from LiteRGSS::Disposable

#dispose, #disposed?

Constructor Details

#initialize(viewport) ⇒ Cursor

Create a new cursor

Parameters:

• viewport (Viewport)

# File 'docs/5_Battle_01_Scene.rb', line 1119

def initialize(viewport)
end

Instance Attribute Details

#origin_x (readonly)

Get the origin x

# File 'docs/5_Battle_01_Scene.rb', line 1110

def origin_x
  @origin_x
end

#origin_y (readonly)

Get the origin y

# File 'docs/5_Battle_01_Scene.rb', line 1112

def origin_y
  @origin_y
end

#target_x (readonly)

Get the target x

# File 'docs/5_Battle_01_Scene.rb', line 1114

def target_x
  @target_x
end

#target_y (readonly)

Get the target y

# File 'docs/5_Battle_01_Scene.rb', line 1116

def target_y
  @target_y
end

Instance Method Details

#register_positions

Register the positions so the cursor can animate itself

# File 'docs/5_Battle_01_Scene.rb', line 1122

def register_positions
end

#start_animation ⇒ Yuki::Animation::TimedLoopAnimation

Create and start the cursor animation

Returns:

• (Yuki::Animation::TimedLoopAnimation)

# File 'docs/5_Battle_01_Scene.rb', line 1137

def start_animation
end

#stop_animation

Stops the animation

# File 'docs/5_Battle_01_Scene.rb', line 1133

def stop_animation
end

#update

Update the sprite

# File 'docs/5_Battle_01_Scene.rb', line 1125

def update
end

#visible=(visible)

Set the visibility

Parameters:

• visible (Boolean)

# File 'docs/5_Battle_01_Scene.rb', line 1129

def visible=(visible)
end