Class: Arkaan::Ruleset

Inherits:
Object
  • Object
show all
Includes:
Mongoid::Document, Mongoid::Timestamps
Defined in:
lib/arkaan/ruleset.rb

Overview

A set of rules is describing how a specific game system works (eg. Dungeons and Dragons 5th Edition, or Fate)

Author:

Instance Attribute Summary collapse

Instance Attribute Details

#campaigns ⇒ Array<Arkaan::Campaign>

Returns the campaigns using this set of rules.

Returns:



25
 
# File 'lib/arkaan/ruleset.rb', line 25

has_many :campaigns, class_name: 'Arkaan::Campaign', inverse_of: :ruleset

#creator ⇒ Arkaan::Account

Returns the account of the user creating this ruleset.

Returns:



22
 
# File 'lib/arkaan/ruleset.rb', line 22

belongs_to :creator, class_name: 'Arkaan::Account', inverse_of: :rulesets

#description ⇒ String

Returns the complete description of the rule set to quickly have informations on its content.

Returns:

  • (String) —

    the complete description of the rule set to quickly have informations on its content.



15
 
# File 'lib/arkaan/ruleset.rb', line 15

field :description, type: String

#mime_types ⇒ Array<String>

Returns a list of MIME types accepted as character sheets MIME types.

Returns:

  • (Array<String>) —

    a list of MIME types accepted as character sheets MIME types.



18
 
# File 'lib/arkaan/ruleset.rb', line 18

field :mime_types, type: Array, default: []

#name ⇒ String

Returns the name of the ruleset (eq. “Dungeons and Dragons 4th Edition”).

Returns:

  • (String) —

    the name of the ruleset (eq. “Dungeons and Dragons 4th Edition”)



12
 
# File 'lib/arkaan/ruleset.rb', line 12

field :name, type: String