Skip to content

Latest commit

 

History

History
106 lines (74 loc) · 3.5 KB

pzpr.md

File metadata and controls

106 lines (74 loc) · 3.5 KB
Raw

pzpr object

Methods

  • pzpr.on(eventtype, listener) Register event listener to pzpr object.
    • eventtype:string Event type. Currently it only accepts 'load'.
    • listener:function Function to be called.
  • pzpr.connectKeyEvents(puzzle) Pass document keydown and keyup event to the given puzzle.

Events

  • 'load' Fire if pzpr object become ready. If this event is registered after pzpr is loaded, the listener will be executed immediately.

Properties

  • lang:string Specific the language of pzpr.js. This value will be used for answer check. Possible value: 'en' or 'ja'. Default value depends on browser or node.js env language.
  • version:string Indicate pzpr.js version.

pzpr.variety object

This object contains each puzzle variety/genre information. In addition, pzpr.variety itself is a function to return puzzle genre's information.

Methods

  • pzpr.genre.exists(pid) or pzpr.variety.exists(pid) Return if puzzle variety is supported.

    • Return value: boolean
    • pid:string Puzzle variety type.
    • It is the same as pzpr.variety(pid).valid.

  • pzpr.genre(pid) or pzpr.variety(pid) Return puzzle genre's information.

    • Return value: GenreInfo

  • GenreInfo

    • info.valid Whether the given pid is valid.
    • info.en Puzzle name in English.
    • info.ja Puzzle name in Japanese.

pzpr.parser object

This object parses URL or file data to parsing information.

Methods

  • pzpr.parser(data[, pid]) or pzpr.parser.parse(data[, pid]) Parse given data then return parsed URLData or FileData.

    • Return value: URLData or FileData
    • data:string Data to be parsed.
    • pid:string Predefined puzzle veriety name.

  • pzpr.parser.parseURL(data) Parse given data as a URL and return parsed URLData.

    • Return value: URLData
    • data:string Data to be parsed.

  • pzpr.parser.parseFile(data[, pid]) Parse given data as file data and return parsed FileData.

    • Return value: FileData or null
    • data:string Data to be parsed.
    • pid:string Predefined puzzle veriety name.

pzpr.parser.URLData class

Properties

  • pid:string Parsed puzzle variety/genre.
  • type:URLType Parsed URL type. See below
  • rows:number The number of rows of the board.
  • cols:number The number of cols of the board.
  • pflag:string Extra flag in given URL.
  • body:string Data in the URL other than type, rows, cols and pflag.
  • isurl:boolean true

pzpr.parser.FileData class

Propertes

  • pid:string Parsed puzzle variety/genre.
  • type:FileType Parsed File data type. See below.
  • rows:number The number of rows of the board.
  • cols:number The number of cols of the board.
  • metadata:pzpr.Metadata Author, source, difficulty and comment properies.
  • history:HistoryData History data in the file data, available if exists.
  • body:string Data in the URL other than type, rows, cols and pflag.
  • isfile:boolean true

pzpr.parser URLType definition

These values are defined under pzpr.parser.

Const values

  • URL_AUTO Undefined URL type.
  • URL_PZPRV3 PUZ-PRE v3 URL type.
  • URL_PZPRAPP PUZ-PRE Applet URL type.
  • URL_KANPEN Kanpen URL type.
  • URL_KANPENP Kanpen with PUZ-PRE data URL type.
  • URL_HEYAAPP Heyawaek Applet URL type.

pzpr.parser FileType definition

These values are defined under pzpr.parser.

Const values

  • FILE_AUTO Undefined file type.
  • FILE_PZPR pzpr.js file type.
  • FILE_PBOX pencilbox (text) file type.
  • FILE_PBOX_XML pencilbox (XML) file type.