docs/api.mdwn
changeset 130 de560dec87a5
parent 129 ea30cf6c5bea
child 133 57a18ccaf9ff
equal deleted inserted replaced
129:ea30cf6c5bea 130:de560dec87a5
     4 [[!toc]]
     4 [[!toc]]
     5 
     5 
     6 
     6 
     7 - - -
     7 - - -
     8 
     8 
       
     9 <a name="Lua.for.mcabber"></a>
       
    10 ## Lua for mcabber
       
    11 Module provides embedded lua environment with some accessors to
       
    12 mcabber functionality.
       
    13 
       
    14 <a name="Options"></a>
       
    15 ### Options
       
    16 
       
    17 * lua_init_filename - lua script, that will be loaded at startup
       
    18 * lua_lm_debug      - if lm log handler is enabled, this option controls, whether lm log messages are dropped or passed to mcabber logging facility
       
    19 
     9 <a name="print"></a>
    20 <a name="print"></a>
    10 ## print
    21 ### print
    11 Prints its arguments to log with default priority.  
    22 Prints its arguments to log with default priority.  
    12 **Arguments:** something, ...  
    23 **Arguments:** something, ...  
    13 
    24 
    14 <a name="dopath"></a>
    25 <a name="dopath"></a>
    15 ### dopath
    26 ### dopath
   302 
   313 
   303 - - -
   314 - - -
   304 
   315 
   305 - - -
   316 - - -
   306 
   317 
       
   318 <a name="Utility.Lua.Routines"></a>
       
   319 ## Utility Lua Routines
       
   320 To handle conversion of enums and flag fields to/from human-readable strings.
       
   321 
   307 <a name="argument.enum.field"></a>
   322 <a name="argument.enum.field"></a>
   308 ## argument enum field
   323 ### argument enum field
   309 String that will be converted to number or just plain number, that will be passed as is.
   324 String that will be converted to number or just plain number, that will be passed as is.
   310 Note, that if enum name is not recognized no error will be raised and default vale will be used.
   325 Note, that if enum name is not recognized no error will be raised and default vale will be used.
   311 
   326 
   312 <a name="return.enum.field"></a>
   327 <a name="return.enum.field"></a>
   313 ### return enum field
   328 ### return enum field