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

Add documentation on event variable names to nwnx_events.nss #17

Closed
wants to merge 1 commit into from

Conversation

zunath
Copy link
Collaborator

@zunath zunath commented Jan 18, 2018

No description provided.

@Liareth
Copy link
Member

Liareth commented Jan 18, 2018

It might be better to change the format of this? It's grouped under 'item events etc' in the format that the code is, but not all items events necessarily have the same event data. The General Notes: is a bit redundant too.

Maybe a slight tweak to make it more readable, like this? (just an example)

//    NWNX_ON_ADD_ASSOCIATE_AFTER
//    NWNX_ON_REMOVE_ASSOCIATE_BEFORE
//    NWNX_ON_REMOVE_ASSOCIATE_AFTER
//     
//    Usage:
//      OBJECT_SELF = The owner of the associate
//
//    Event data:
//      Variable Name           Type                Notes
//      ASSOCIATE_OBJECT_ID     object              Convert to object with NWNX_Object_StringToObject
//
//    NWNX_ON_ENTER_STEALTH_BEFORE
//    NWNX_ON_ENTER_STEALTH_AFTER
//    NWNX_ON_EXIT_STEALTH_BEFORE
//    NWNX_ON_EXIT_STEALTH_AFTER
//
//    Usage:
//      OBJECT_SELF = The creature entering or leaving stealth.
//
//

@zunath
Copy link
Collaborator Author

zunath commented Jan 30, 2018

I'll have to get back into this one at a later date. Don't have the time right now. I'll go ahead and close this PR for now

@zunath zunath closed this Jan 30, 2018
@zunath zunath deleted the events-documentation branch February 18, 2018 04:28
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

Successfully merging this pull request may close these issues.

None yet

2 participants