Class: Pixelart::Metadata::SpriteEx

Inherits:
Object
  • Object
show all
Defined in:
lib/punks/pixelart/spritesheet.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id:, name:, type:, gender:, size:, more_names: []) ⇒ SpriteEx

Returns a new instance of SpriteEx.



25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/punks/pixelart/spritesheet.rb', line 25

def initialize( id:,
                name:,
                type:,
                gender:,
                size:,
                more_names: [] )
   @id         = id      # zero-based index eg. 0,1,2,3, etc.
   @name       = name
   @type       = type
   @gender     = gender
   @size       = size
   @more_names = more_names
end

Instance Attribute Details

#gender ⇒ Object (readonly)

Extension to Sprite

incl. more (extra/extended) fields
 - gender (u/f/m)
 - size   (u/l/s)



23
24
25
 
# File 'lib/punks/pixelart/spritesheet.rb', line 23

def gender
  @gender
end

#id ⇒ Object (readonly)

Extension to Sprite

incl. more (extra/extended) fields
 - gender (u/f/m)
 - size   (u/l/s)



23
24
25
 
# File 'lib/punks/pixelart/spritesheet.rb', line 23

def id
  @id
end

#more_names ⇒ Object (readonly)

Extension to Sprite

incl. more (extra/extended) fields
 - gender (u/f/m)
 - size   (u/l/s)



23
24
25
 
# File 'lib/punks/pixelart/spritesheet.rb', line 23

def more_names
  @more_names
end

#name ⇒ Object (readonly)

Extension to Sprite

incl. more (extra/extended) fields
 - gender (u/f/m)
 - size   (u/l/s)



23
24
25
 
# File 'lib/punks/pixelart/spritesheet.rb', line 23

def name
  @name
end

#size ⇒ Object (readonly)

Extension to Sprite

incl. more (extra/extended) fields
 - gender (u/f/m)
 - size   (u/l/s)



23
24
25
 
# File 'lib/punks/pixelart/spritesheet.rb', line 23

def size
  @size
end

#type ⇒ Object (readonly)

Extension to Sprite

incl. more (extra/extended) fields
 - gender (u/f/m)
 - size   (u/l/s)



23
24
25
 
# File 'lib/punks/pixelart/spritesheet.rb', line 23

def type
  @type
end

Instance Method Details

#archetype? ⇒ Boolean

todo/check - find better names for type attribute/archetypes?

use (alternate name/alias) base or face  for archetypes? any others?

Returns:

  • (Boolean) 


41
 
# File 'lib/punks/pixelart/spritesheet.rb', line 41

def archetype?()  @type.downcase.index( 'archetype' ); end

#attribute? ⇒ Boolean

Returns:

  • (Boolean) 


42
 
# File 'lib/punks/pixelart/spritesheet.rb', line 42

def attribute?()  !archetype?;  end

#female? ⇒ Boolean

Returns:

  • (Boolean) 


50
 
# File 'lib/punks/pixelart/spritesheet.rb', line 50

def female?()    @gender == 'f'; end

#large? ⇒ Boolean

Returns:

  • (Boolean) 


45
 
# File 'lib/punks/pixelart/spritesheet.rb', line 45

def large?()     @size == 'l'; end

#male? ⇒ Boolean

Returns:

  • (Boolean) 


49
 
# File 'lib/punks/pixelart/spritesheet.rb', line 49

def male?()      @gender == 'm'; end

#small? ⇒ Boolean

Returns:

  • (Boolean) 


44
 
# File 'lib/punks/pixelart/spritesheet.rb', line 44

def small?()     @size == 's'; end

#unisex? ⇒ Boolean

Returns:

  • (Boolean) 


51
 
# File 'lib/punks/pixelart/spritesheet.rb', line 51

def unisex?()    @gender == 'u'; end

#universal? ⇒ Boolean Also known as: unisize?

Returns:

  • (Boolean) 


46
 
# File 'lib/punks/pixelart/spritesheet.rb', line 46

def universal?() @size == 'u'; end