Contents

module Squib
  class Deck

    # Toggle hints globally.
    #
    # Text hints are rectangles around where the text will be laid out. They are intended to be temporary.
    # Setting a hint to nil or to :off will disable hints. @see samples/text.rb
    # @example
    #   hint text: :cyan
    #   hint text: :cyan
    #
    # @param [String] text the color of the text hint. To turn off use :off. @see README.md
    # @return [nil] Returns nothing
    # @api public
    def hint(text: :off)
      conf.text_hint = text
    end

    # Sets various defaults for this deck. Defaults can be overriden by the commands themselves when that command supports it.
    # @example
    #   set font: 'Arial 26'
    #   text 'blah'                     # in Arial 26
    #   text 'blah24', font: 'Arial 24' # in Arial 24
    #   set font: :default              # Back to Squib-wide default
    #
    # @option opts font: the font string to set as default. Can also be set to `:default` to use the Squib-wide default.
    # @return [nil] Returns nothing
    # @api public
    def set(opts = {})
      raise 'DEPRECATED: As of v0.7 img_dir is no longer supported in "set". Use config.yml instead.' if opts.key? :img_dir
      @font = (opts[:font] == :default) ? Squib::DEFAULT_FONT: opts[:font]
    end

  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
squib-0.9.0	lib/squib/api/settings.rb