Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Outdated Documentation #378

Open
suunr opened this issue Sep 7, 2015 · 9 comments
Open

Outdated Documentation #378

suunr opened this issue Sep 7, 2015 · 9 comments

Comments

@suunr
Copy link
Contributor

suunr commented Sep 7, 2015

On sf.inp.io in preprocessor directives --@model and --@author is missing.

@Jazzelhawk
Copy link
Member

--@inputs and --@outputs are also missing. But this is because no documentation has been written for them in the libs_sv/wire.lua file.

@suunr
Copy link
Contributor Author

suunr commented Sep 7, 2015

There's also no "Vehicle" type in "Types".

@awilliamson
Copy link
Member

Will look into it. Should be automatic, thanks for bringing it up.

@awilliamson
Copy link
Member

Author isn't 'really' a preprocessor as far as I know. It's just a carry over from when Col32 originally wrote Starfall and essentially copied E2 convention ( yikes ).

Mainly used in the new script stub, and is a useful 'nod' to the author of a script, as that's usually found within the 'header'.

@Jazzelhawk, I'll get to work on writing up the --@inputs and --@outputs pre-procs now.

@suunr
Copy link
Contributor Author

suunr commented Sep 7, 2015

Wirelink/Highspeedlink type is missing too.

@suunr
Copy link
Contributor Author

suunr commented Sep 8, 2015

In Hologram Type methods like :setMaterial and :setColor are missing.

In trace library maybe the masks/enumerations could be listed?
Also maybe a description of the result of the trace.

@awilliamson
Copy link
Member

Holograms ARE entities, they have all the functions as such. The current docgen system makes it a little tricky to label certain tables, and add floating descriptions. Will look into it though.

@suunr
Copy link
Contributor Author

suunr commented Sep 8, 2015

In trace library it says for trace function's parameter "filter" : "Entity/array of entities to filter ". But filter must be always a table otherwise it doesn't work.

@suunr suunr closed this as completed Sep 10, 2015
@awilliamson
Copy link
Member

This is still valid, please keep open.

@awilliamson awilliamson reopened this Sep 10, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants