Class: Core::Models::Campaigns::Map

Inherits:

Object

• Object
• Core::Models::Campaigns::Map

Includes:

Mongoid::Document, Mongoid::Timestamps

Defined in:

lib/core/models/campaigns/map.rb

Overview

A map is a battleground where the players can place tokens and live the adventure.

Author:

• Vincent Courtois <courtois.vincent@outlook.com>

Instance Attribute Summary

• #campaign ⇒ Core::Models::Campaign

  The campaign in which the map can be found.

• #height ⇒ Integer

  The number of lines in the map matric.

• #positions ⇒ Array<Core::Model::Campaigns::TokenPosition>

  The instanciated tokens on this map.

• #width ⇒ Integer

  The number of columns in the map matric.

Instance Attribute Details

#campaign ⇒ Core::Models::Campaign

Returns the campaign in which the map can be found.

Returns:

• (Core::Models::Campaign) —

  the campaign in which the map can be found.

# File 'lib/core/models/campaigns/map.rb', line 23

belongs_to :campaign, class_name: 'Core::Models::Campaign', inverse_of: :maps

#height ⇒ Integer

Returns the number of lines in the map matric.

Returns:

• (Integer) —

  the number of lines in the map matric.

# File 'lib/core/models/campaigns/map.rb', line 16

field :height, type: Integer, default: 1

#positions ⇒ Array<Core::Model::Campaigns::TokenPosition>

Returns the instanciated tokens on this map.

Returns:

• (Array<Core::Model::Campaigns::TokenPosition>) —

  the instanciated tokens on this map.

# File 'lib/core/models/campaigns/map.rb', line 27

embeds_many :positions, class_name: 'Core::Models::Campaigns::TokenPosition', inverse_of: :map

#width ⇒ Integer

Returns the number of columns in the map matric.

Returns:

• (Integer) —

  the number of columns in the map matric.

# File 'lib/core/models/campaigns/map.rb', line 19

field :width, type: Integer, default: 1