module MiniGL::Res

This class is responsible for resource management. It keeps references to all loaded resources until a call to clear is made. Resources can be loaded as global, so that their references won’t be removed even when clear is called.

It also provides an easier syntax for loading resources, assuming a particular folder structure. All resources must be inside subdirectories of a ‘data’ directory, so that you will only need to specify the type of resource being loaded and the file name (either as string or as symbol). There are default extensions for each type of resource, so the extension must be specified only if the file is in a format other than the default.

Attributes

font_dir[R]

Gets the current path to font files (under prefix). Default is ‘font’.

img_dir[R]

Gets the current path to image files (under prefix). Default is ‘img’.

prefix[R]

Get the current prefix for searching data files. This is the directory under which ‘img’, ‘sound’, ‘song’, etc. folders are located.

retro_images[RW]

Gets or sets a flag that indicates whether images will be loaded with the ‘retro’ option set (see Gosu::Image for details), when this option is not specified in a ‘Res.img’ or ‘Res.imgs’ call.

separator[RW]

Gets or sets the character that is currently being used in the id parameter of the loading methods as a folder separator. Default is ‘_’. Note that if you want to use symbols to specify paths, this separator should be a valid character in a Ruby symbol. On the other hand, if you want to use only slashes in Strings, you can specify a ‘weird’ character that won’t appear in any file name.

song_dir[R]

Gets the current path to song files (under prefix). Default is ‘song’.

sound_dir[R]

Gets the current path to sound files (under prefix). Default is ‘sound’.

tileset_dir[R]

Gets the current path to tileset files (under prefix). Default is ‘tileset’.

Public Class Methods

clear() click to toggle source

Releases the memory used by all non-global resources.

# File lib/minigl/global.rb, line 787
def clear
  @imgs.clear
  @tilesets.clear
  @sounds.clear
  @songs.clear
  @fonts.clear
end
font(id, size, global = true, ext = '.ttf') click to toggle source

Returns a Gosu::Font object. Fonts are needed to draw text and used by MiniGL elements like buttons, text fields and TextHelper objects.

Parameters:

id

A string or symbol representing the path to the song. It must be specified the same way as in img, but the base directory is prefix/font_dir.

size

The size of the font, in pixels. This will correspond, approximately, to the height of the tallest character when drawn.

global

Set to true if you want to keep the font in memory until the game execution is finished. If false, the font will be released when you call clear.

ext

The extension of the file being loaded. Specify only if it is other than “.ttf”.

# File lib/minigl/global.rb, line 777
def font(id, size, global = true, ext = '.ttf')
  a = global ? @global_fonts : @fonts
  id_size = "#{id}_#{size}"
  return a[id_size] if a[id_size]
  s = @prefix + @font_dir + id.to_s.split(@separator).join('/') + ext
  font = Gosu::Font.new size, name: s
  a[id_size] = font
end
font_dir=(value) click to toggle source

Sets the path to font files (under prefix). Default is ‘font’.

# File lib/minigl/global.rb, line 632
def font_dir=(value)
  value += '/' if value != '' and value[-1] != '/'
  @font_dir = value
end
img(id, global = false, tileable = false, ext = '.png', retro = nil) click to toggle source

Returns a Gosu::Image object.

Parameters:

id

A string or symbol representing the path to the image. If the file is inside prefix/img_dir, only the file name is needed. If it’s inside a subdirectory of prefix/img_dir, the id must be prefixed by each subdirectory name followed by separator. Example: to load ‘data/img/sprite/1.png’, with the default values of prefix, img_dir and separator, provide :sprite_1 or “sprite_1”.

global

Set to true if you want to keep the image in memory until the game execution is finished. If false, the image will be released when you call clear.

tileable

Whether the image should be loaded in tileable mode, which is proper for images that will be used as a tile, i.e., that will be drawn repeated times, side by side, forming a continuous composition.

ext

The extension of the file being loaded. Specify only if it is other than ‘.png’.

retro

Whether the image should be loaded with the ‘retro’ option set (see Gosu::Image for details). If the value is omitted, the Res.retro_images value will be used.

# File lib/minigl/global.rb, line 658
def img(id, global = false, tileable = false, ext = '.png', retro = nil)
  a = global ? @global_imgs : @imgs
  return a[id] if a[id]
  s = @prefix + @img_dir + id.to_s.split(@separator).join('/') + ext
  retro = Res.retro_images if retro.nil?
  img = Gosu::Image.new s, tileable: tileable, retro: retro
  a[id] = img
end
img_dir=(value) click to toggle source

Sets the path to image files (under prefix). Default is ‘img’.

# File lib/minigl/global.rb, line 608
def img_dir=(value)
  value += '/' if value != '' and value[-1] != '/'
  @img_dir = value
end
imgs(id, sprite_cols, sprite_rows, global = false, ext = '.png', retro = nil, tileable = false) click to toggle source

Returns an array of Gosu::Image objects, using the image as a spritesheet. The image with index 0 will be the top left sprite, and the following indices raise first from left to right and then from top to bottom.

Parameters:

id

A string or symbol representing the path to the image. See img for details.

sprite_cols

Number of columns in the spritesheet.

sprite_rows

Number of rows in the spritesheet.

global

Set to true if you want to keep the image in memory until the game execution is finished. If false, the image will be released when you call clear.

ext

The extension of the file being loaded. Specify only if it is other than “.png”.

retro

Whether the image should be loaded with the ‘retro’ option set (see Gosu::Image for details). If the value is omitted, the Res.retro_images value will be used.

# File lib/minigl/global.rb, line 685
def imgs(id, sprite_cols, sprite_rows, global = false, ext = '.png', retro = nil, tileable = false)
  a = global ? @global_imgs : @imgs
  return a[id] if a[id]
  s = @prefix + @img_dir + id.to_s.split(@separator).join('/') + ext
  retro = Res.retro_images if retro.nil?
  imgs = Gosu::Image.load_tiles s, -sprite_cols, -sprite_rows, tileable: tileable, retro: retro
  a[id] = imgs
end
initialize() click to toggle source

This is called by GameWindow.initialize. Don’t call it explicitly.

# File lib/minigl/global.rb, line 577
def initialize
  @imgs = {}
  @global_imgs = {}
  @tilesets = {}
  @global_tilesets = {}
  @sounds = {}
  @global_sounds = {}
  @songs = {}
  @global_songs = {}
  @fonts = {}
  @global_fonts = {}

  @prefix = File.expand_path(File.dirname($0)) + '/data/'
  @img_dir = 'img/'
  @tileset_dir = 'tileset/'
  @sound_dir = 'sound/'
  @song_dir = 'song/'
  @font_dir = 'font/'
  @separator = '_'
  @retro_images = false
end
prefix=(value) click to toggle source

Set a custom prefix for loading resources. By default, the prefix is the directory of the game script. The prefix is the directory under which ‘img’, ‘sound’, ‘song’, etc. folders are located.

# File lib/minigl/global.rb, line 602
def prefix=(value)
  value += '/' if value != '' and value[-1] != '/'
  @prefix = value
end
song(id, global = false, ext = '.ogg') click to toggle source

Returns a Gosu::Song object. This should be used for the background musics of your game.

Parameters:

id

A string or symbol representing the path to the song. It must be specified the same way as in img, but the base directory is prefix/song_dir.

global

Set to true if you want to keep the song in memory until the game execution is finished. If false, the song will be released when you call clear.

ext

The extension of the file being loaded. Specify only if it is other than “.ogg”.

# File lib/minigl/global.rb, line 754
def song(id, global = false, ext = '.ogg')
  a = global ? @global_songs : @songs
  return a[id] if a[id]
  s = @prefix + @song_dir + id.to_s.split(@separator).join('/') + ext
  song = Gosu::Song.new s
  a[id] = song
end
song_dir=(value) click to toggle source

Sets the path to song files (under prefix). Default is ‘song’.

# File lib/minigl/global.rb, line 626
def song_dir=(value)
  value += '/' if value != '' and value[-1] != '/'
  @song_dir = value
end
sound(id, global = false, ext = '.wav') click to toggle source

Returns a Gosu::Sample object. This should be used for simple and short sound effects.

Parameters:

id

A string or symbol representing the path to the sound. It must be specified the same way as in img, but the base directory is prefix/sound_dir.

global

Set to true if you want to keep the sound in memory until the game execution is finished. If false, the sound will be released when you call clear.

ext

The extension of the file being loaded. Specify only if it is other than “.wav”.

# File lib/minigl/global.rb, line 734
def sound(id, global = false, ext = '.wav')
  a = global ? @global_sounds : @sounds
  return a[id] if a[id]
  s = @prefix + @sound_dir + id.to_s.split(@separator).join('/') + ext
  sound = Gosu::Sample.new s
  a[id] = sound
end
sound_dir=(value) click to toggle source

Sets the path to sound files (under prefix). Default is ‘sound’.

# File lib/minigl/global.rb, line 620
def sound_dir=(value)
  value += '/' if value != '' and value[-1] != '/'
  @sound_dir = value
end
tileset(id, tile_width = 32, tile_height = 32, global = false, ext = '.png', retro = nil) click to toggle source

Returns an array of Gosu::Image objects, using the image as a tileset. Works the same as imgs, except you must provide the tile size instead of the number of columns and rows, and that the images will be loaded as tileable.

Parameters:

id

A string or symbol representing the path to the image. It must be specified the same way as in img, but the base directory is prefix/tileset_dir.

tile_width

Width of each tile, in pixels.

tile_height

Height of each tile, in pixels.

global

Set to true if you want to keep the image in memory until the game execution is finished. If false, the image will be released when you call clear.

ext

The extension of the file being loaded. Specify only if it is other than “.png”.

retro

Whether the image should be loaded with the ‘retro’ option set (see Gosu::Image for details). If the value is omitted, the Res.retro_images value will be used.

# File lib/minigl/global.rb, line 713
def tileset(id, tile_width = 32, tile_height = 32, global = false, ext = '.png', retro = nil)
  a = global ? @global_tilesets : @tilesets
  return a[id] if a[id]
  s = @prefix + @tileset_dir + id.to_s.split(@separator).join('/') + ext
  retro = Res.retro_images if retro.nil?
  tileset = Gosu::Image.load_tiles s, tile_width, tile_height, tileable: true, retro: retro
  a[id] = tileset
end
tileset_dir=(value) click to toggle source

Sets the path to tilset files (under prefix). Default is ‘tileset’.

# File lib/minigl/global.rb, line 614
def tileset_dir=(value)
  value += '/' if value != '' and value[-1] != '/'
  @tileset_dir = value
end