Class: UI::SymText

Inherits:

Text

• Object
• LiteRGSS::Disposable
• LiteRGSS::Drawable
• LiteRGSS::Text
• Text
• UI::SymText

Defined in:

scripts/01450 Systems/00000 General/00100 UI Generics/00500 HelperSprites.rb

Overview

Object that show a text using a method of the data object sent

Direct Known Subclasses

SymMultilineText

Instance Attribute Summary

Attributes inherited from LiteRGSS::Text

#__index__, #align, #bold, #draw_shadow, #fill_color, #height, #italic, #nchar_draw, #opacity, #outline_color, #outline_thickness, #real_width, #size, #text, #viewport, #visible, #width, #x, #y, #z

Instance Method Summary

• #data=(object)

  Set the Object used to show the text.

• #initialize(font_id, viewport, x, y, width, height, method, align = 0, outlinesize = nil, color = nil, sizeid = nil) ⇒ SymText constructor

  Add a text inside the window, the offset x/y will be adjusted.

Methods inherited from Text

#simple_mouse_in?, #translate_mouse_coords

Methods inherited from LiteRGSS::Text

#load_color, #multiline_text=, new, #set_position, #text_width

Methods inherited from LiteRGSS::Disposable

#dispose, #disposed?

Constructor Details

#initialize(font_id, viewport, x, y, width, height, method, align = 0, outlinesize = nil, color = nil, sizeid = nil) ⇒ SymText

Add a text inside the window, the offset x/y will be adjusted

Parameters:

• font_id (Integer) —

  the id of the font to use to draw the text

• viewport (Viewport, nil) —

  the viewport used to show the text

• x (Integer) —

  the x coordinate of the text surface

• y (Integer) —

  the y coordinate of the text surface

• width (Integer) —

  the width of the text surface

• height (Integer) —

  the height of the text surface

• method (Symbol) —

  the symbol of the method to call in the data object

• align (0, 1, 2) (defaults to: 0) —

  the align of the text in its surface (best effort => no resize), 0 = left, 1 = center, 2 = right

• outlinesize (Integer, nil) (defaults to: nil) —

  the size of the text outline

• color (Integer) (defaults to: nil) —

  the id of the color

• sizeid (Intger) (defaults to: nil) —

  the id of the size to use

# File 'scripts/01450 Systems/00000 General/00100 UI Generics/00500 HelperSprites.rb', line 338

def initialize(font_id, viewport, x, y, width, height, method, align = 0, outlinesize = nil, color = nil, sizeid = nil)
  super(font_id, viewport, x, y, width, height, nil.to_s, align, outlinesize, color, sizeid)
  @method = method
end

Instance Method Details

#data=(object)

Set the Object used to show the text

Parameters:

• object (Object, nil)

# File 'scripts/01450 Systems/00000 General/00100 UI Generics/00500 HelperSprites.rb', line 345

def data=(object)
  return unless (self.visible = (object ? true : false))
  self.text = object.public_send(@method).to_s
end