diff --git a/2-api.md b/2-api.md index 8679aa6..a85201b 100644 --- a/2-api.md +++ b/2-api.md @@ -149,17 +149,6 @@ TODO # Global Objects - - -* [DEHInfo](api-global-DEHInfo.md) -* [FOptionMenuSettings](api-global-FOptionMenuSettings.md) -* [GameInfoStruct](api-global-GameInfoStruct.md) -* [LevelLocals](api-global-LevelLocals.md) - - - -These types are used by global variables. - * [Client](api-global-data-Client.md) @@ -171,7 +160,7 @@ These types are used by global variables. These variables are accessible in any context and are not bound by any specific -object. +object. Generally these mirror global information within the engine itself. @@ -185,6 +174,17 @@ object. These functions are accessible in any context and are not bound by any specific -object. +object. Generally these are utility functions. + + + +* [DEHInfo](api-global-DEHInfo.md) +* [FOptionMenuSettings](api-global-FOptionMenuSettings.md) +* [GameInfoStruct](api-global-GameInfoStruct.md) +* [LevelLocals](api-global-LevelLocals.md) + + + +These are the types used by global variables. diff --git a/3-entry.md b/3-entry.md index 24343ba..4c7bc46 100644 --- a/3-entry.md +++ b/3-entry.md @@ -1,9 +1,8 @@ -Table of Contents -================= +Entry Points +============ -* [Entry Points](#entry-points) * [ACS](#acs) * [Actors](#actors) * [CVARINFO](#cvarinfo) @@ -18,9 +17,6 @@ Table of Contents -Entry Points -============ - For backwards compatibility reasons and so as to not bloat the ZScript language itself, many interactions with the engine are not defined in ZScript. This section describes all ZScript interactions with the engine, both inside and diff --git a/9-glossary.md b/9-glossary.md index e46da0c..cb78044 100644 --- a/9-glossary.md +++ b/9-glossary.md @@ -1,4 +1,5 @@ -# Glossary +Glossary +======== diff --git a/README.md b/README.md index 93d98cc..a6b16bb 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ -zscript-doc -=========== +ZScriptDoc +========== -This is documentation for the ZScript language. See `zscript-doc-1-language.md` -for license information. +This is documentation for the ZScript language. CC0 public domain. See [LICENSE](LICENSE.txt) for more information. + +* [Language](1-language.md) - for information on the language itself. +* [API](2-api.md) - for information on the interfaces provided by GZDoom. This is itself a map of all of the API files. +* [Entry Points](3-entry.md) - for information on the ways you can tell the engine to add new things. +* [Glossary](9-glossary.md) - for miscallaneous information and concepts you should learn. This is itself a map of all of the glossary files. + +