Class: Gamefic::Script::Base

Inherits:

Object

• Object
• Gamefic::Script::Base

Defined in:

lib/gamefic/script/base.rb

Direct Known Subclasses

File, Text

Instance Method Summary

• #==(other) ⇒ Boolean
• #absolute_path ⇒ String

  Get the absolute path of the script’s original file.

• #initialize ⇒ Base constructor

  A new instance of Base.

• #path ⇒ String

  Get the script’s path.

• #read ⇒ String

  Get the script’s text.

Constructor Details

#initialize ⇒ Base

Returns a new instance of Base.

# File 'lib/gamefic/script/base.rb', line 4

def initialize
  raise "#initialize must be defined in subclasses"
end

Instance Method Details

#==(other) ⇒ Boolean

Parameters:

• other (Script::Base)

Returns:

• (Boolean)

# File 'lib/gamefic/script/base.rb', line 28

def==(other)
  path == other.path
end

#absolute_path ⇒ String

Get the absolute path of the script’s original file

Returns:

• (String)

# File 'lib/gamefic/script/base.rb', line 23

def absolute_path
  raise "#absolute_path must be defined in subclasses"
end

#path ⇒ String

Get the script’s path

Returns:

• (String)

# File 'lib/gamefic/script/base.rb', line 17

def path
  raise "#path must be defined in subclasses"
end

#read ⇒ String

Get the script’s text. The text must be source code suitable for evaluation via Plot#stage.

Returns:

• (String)

# File 'lib/gamefic/script/base.rb', line 11

def read
  raise "#read must be defined in subclasses"
end