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

addBindable

  • Adds a bindable and the default binding for it

    Parameters

    • name: string

      The name of the binding (when translated, the name will be Mod<mod name><name>)

    • binding: IBinding | IBinding[]

      The default binding or bindings of this bindable

    Returns number

addCommand

  • Parameters

    Returns number

addCreature

addDictionary

  • addDictionary(name: string, dictionaryEnum: any): number
  • Parameters

    • name: string
    • dictionaryEnum: any

    Returns number

addDoodad

addHairstyle

addItem

  • Parameters

    Returns number

addMessage

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

    • name: string
    • message: string

    Returns number

addMusic

  • addMusic(name: string): number
  • Parameters

    • name: string

    Returns number

addSkillType

  • Parameters

    Returns number

addSoundEffect

  • addSoundEffect(name: string, variations?: number): number
  • Parameters

    • name: string
    • Optional variations: number

    Returns number

addTerrain

  • Parameters

    Returns number

addTerrainResource

  • Parameters

    Returns void

createButton

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

    • translationId: string
    • imagePath: string
    • Optional keyBind: number

    Returns JQuery

createDialog

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

    Returns JQuery

createOptionsSection

  • createOptionsSection(creationHandler: function): void
  • Parameters

    Returns void

extendLanguage

  • Parameters

    Returns void

getButtons

  • getButtons(): JQuery
  • Returns JQuery

getDialog

  • getDialog(title: string): JQuery
  • Parameters

    • title: string

    Returns JQuery

getIndex

  • getIndex(): number
  • Returns number

getItemByName

  • Parameters

    • name: string

    Returns IItemDescription | undefined

getItemByType

getName

  • getName(): string
  • Returns string

getPath

  • getPath(): string
  • Returns string

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

registerPacket

  • Parameters

    Returns void

removeButton

  • removeButton(button: JQuery): void
  • Parameters

    • button: JQuery

    Returns void

unallocate

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

    Returns void

Generated using TypeDoc