parseBoardMod

Description

Parses a Boardmod-style (.mod) modification file.

Syntax

array parseBoardMod (string $file[, bool $testing[, bool $undo]])


Parameter $file

Expected type: String
Description: The name of the file to parse


Parameter $testing

Expected type: Boolean
Description: If true, the changes won't be saved. Default is true.


Parameter $undo

Expected type: Boolean
Description: If true, the changes specified will be undone (used when uninstalling things). Default is false. Directly related to the value of the "reverse" parameter in the modification tag.


Return value

Expected type: Array
Description: An array of changes made


Notes

  • Testing tells it the modifications shouldn't actually be saved.
  • Undo specifies that the modifications the file requests should be undone.
  • Returns an array of those changes made.
View all versions of this function
Advertisement: