Skip to content

Pwootage/oc-apis

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OC Lua API reference files

These files are specifically generated with OpenOS in mind, but they should still be useful for other development.

How to use

No IDE

Open up the file that has what you are interested in, and use it as a reference. Done!

Intelilj

See Lua for IDEA's documentation: https://bitbucket.org/sylvanaar2/lua-for-idea/wiki/Setting_Up_Custom_API's

Note that the screenshots are way out of date but otherwise the instructions seem to work

I don't see the API/Component I want!

Two options here:

Contributing notes

Stick to the same style/format as the rest of the project, please!

When writing a component, docdump can generally do most-to-all of the work for you, especially if the mod properly added doc strings.

License

The MIT License (MIT)

Copyright (c) 2015 Pwootage

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

API definition files for most of OC

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages