Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BaseMod

Hierarchy

Index

Constructors

constructor

  • new BaseMod(index: number): BaseMod
  • Parameters

    • index: number

    Returns BaseMod

Methods

addActionType

addCreature

addDoodad

addHairstyle

addItem

  • Parameters

    Returns number

addKeyBind

  • addKeyBind(name: string, defaultKeyCode: number): number
  • Parameters

    • name: string
    • defaultKeyCode: number

    Returns number

addMessage

  • addMessage(name: string, message: string): number
  • Parameters

    • name: string
    • message: string

    Returns number

addSkillType

  • Parameters

    Returns number

addTerrain

  • Parameters

    Returns number

addTerrainResource

  • Parameters

    Returns void

createButton

  • createButton(buttonName: string, imagePath: string, tooltip: string, keyBind?: number): JQuery
  • Parameters

    • buttonName: string
    • imagePath: string
    • tooltip: string
    • Optional keyBind: number

    Returns JQuery

createDialog

  • createDialog(container: JQuery, dialogInfo: IDialogInfo): JQuery
  • Parameters

    Returns JQuery

createOptionsSection

  • createOptionsSection(sectionName: string): JQuery
  • Parameters

    • sectionName: string

    Returns JQuery

getButtons

  • Returns Array<IButton>

getDialog

  • getDialog(title: string): JQuery
  • Parameters

    • title: string

    Returns JQuery

getIndex

  • getIndex(): number | undefined
  • Returns number | undefined

getItemByName

  • Parameters

    • name: string

    Returns IItemDescription | undefined

getItemByType

getName

  • getName(): string | undefined
  • Returns string | undefined

getPath

  • getPath(): string | undefined
  • Returns string | undefined

itemNameToObjectType

  • itemNameToObjectType(name: string): ItemType | undefined
  • Parameters

    • name: string

    Returns ItemType | undefined

loadFile

  • loadFile(file: string, callback: function): boolean
  • Parameters

    • file: string
    • callback: function
        • (fileText: string, success: boolean): void
        • Parameters

          • fileText: string
          • success: boolean

          Returns void

    Returns boolean

removeButton

  • removeButton(buttonName: string): void
  • Parameters

    • buttonName: string

    Returns void

removeOptionsSection

  • removeOptionsSection(sectionName: string): void
  • Parameters

    • sectionName: string

    Returns void

unallocateEnums

  • unallocateEnums(): void
  • This is called internally after unloading a mod

    Returns void

Generated using TypeDoc