View Source DevJoy.Scene.Chapter (DevJoy v1.1.0)

A chapter presents a title and description of the next content part in the game.

Example

defmodule MyApp.SceneName do
  use DevJoy.Scene

  part :chapter do
    chapter 1, "First chapter", "Contains amazing stuff!"
  end
end

Summary

Types

Description

Index

t()

Part struct

Title

Types

@type description() :: String.t()

Description

@type index() :: non_neg_integer()

Index

@type t() :: %DevJoy.Scene.Chapter{
  description: description(),
  index: index(),
  title: title()
}

Part struct

@type title() :: String.t()

Title