mcopy/app/lib/mscript/Readme.md

lib/mscript

• lib/mscript
  • ~mscript
    • .arg(shrt, lng) ⇒ boolean
    • .arg_pos(shrt, lng) ⇒ boolean
    • .state_clear()
    • .alts_unique()
    • .interpret()
    • .last_loop()
    • .parent_loop()
    • .state_update()
    • .str_to_arr()
    • .light_state()
    • .light_to_arr()
    • .loop_count()
    • .fail()
    • .output()
    • .init()
    • .tests()

lib/mscript~mscript

object mscript

Kind: inner constant of lib/mscript

• ~mscript
  • .arg(shrt, lng) ⇒ boolean
  • .arg_pos(shrt, lng) ⇒ boolean
  • .state_clear()
  • .alts_unique()
  • .interpret()
  • .last_loop()
  • .parent_loop()
  • .state_update()
  • .str_to_arr()
  • .light_state()
  • .light_to_arr()
  • .loop_count()
  • .fail()
  • .output()
  • .init()
  • .tests()

mscript.arg(shrt, lng) ⇒ boolean

Check for the presence of specific arguments in process argv

Kind: static method of mscript
Returns: boolean - Is flag present

Param	Type	Description
shrt	string	Short version of argument or flag
lng	string	Long version of argument or flag

mscript.arg_pos(shrt, lng) ⇒ boolean

Check for the position of specific arguments in process argv

Kind: static method of mscript
Returns: boolean - Position of arg or flag, for locating input

Param	Type	Description
shrt	string	Short version of argument or flag
lng	string	Long version of argument or flag

mscript.state_clear()

Clear the state object

Kind: static method of mscript

mscript.alts_unique()

Kind: static method of mscript

mscript.interpret()

Kind: static method of mscript

mscript.last_loop()

Kind: static method of mscript

mscript.parent_loop()

Kind: static method of mscript

mscript.state_update()

Kind: static method of mscript

mscript.str_to_arr()

Kind: static method of mscript

mscript.light_state()

Kind: static method of mscript

mscript.light_to_arr()

Kind: static method of mscript

mscript.loop_count()

Kind: static method of mscript

mscript.fail()

Kind: static method of mscript

mscript.output()

Kind: static method of mscript

mscript.init()

Kind: static method of mscript

mscript.tests()

Legacy tests. To be deprecated in future releases.

Kind: static method of mscript