📃
VeinIF documentation
  • Introduction
  • Perquisites
  • Features
  • Tutorial
    • Getting Started
    • Tutorial
    • Extending the framework
  • Components
    • Paragraph
    • Choice
  • Optional Components
    • Precondition
    • Consequence
  • Files
    • File Structures
    • Code snippets
  • Modifying Guide
    • Preface
    • HTML Layout
  • API
    • Formatting
      • capitalise
      • greyOut
    • ParagraphFunctions
      • getCurrentParagraphName
  • Change log
    • Change log
Powered by GitBook
On this page

Was this helpful?

  1. Components

Paragraph

Also known as "scenes" in other Interactive Fiction engines/tools, VeinIF's "Paragraph" contains the content that describe the context on which the player will have to make a choice, the choices itself, items and more.

{
  id: 0,
  name: ``,
  content: ``,
  choices: [
    { id: 1, choiceCont: ``, nextName: `` },
  ],
},
{
  id: 0,
  name: ``,
  content: ``,
  item: [
    { itemName: ``, description: ``, itemQty: -1, itemCode: ``, }
  ],
  choices: [
    { id: 1,
      choiceCont: ``,
      nextName: ``,
      precondition:
      {
        item: [
          { 
            itemName: ``, 
            description: ``, 
            itemQty: 1, 
            itemCode: ``, 
          },
        ],
        stat: [{ statName: ``, value: 1,}],
      },
      consequence: {
        item: [
        { itemName: ``, description: ``, itemQty: -1, itemCode: ``, }
        ],
        stat: [
          { statName: ``, value: 1, style: statStyle.show },
          { statName: ``, value: 1, style: statStyle.hide }
        ],
      },
    },
  ],
},

PreviousExtending the frameworkNextChoice

Last updated 2 years ago

Was this helpful?