mirror of https://github.com/marrub--/zscript-doc
update for 4.2.1
parent
eed355d85c
commit
23d09b9779
|
@ -1,7 +1,7 @@
|
||||||
# Classes
|
# Classes
|
||||||
|
|
||||||
Here is a full tree of all classes in ZScript as of GZDoom 4.2.0. There are
|
Here is a full tree of all classes in ZScript as of GZDoom 4.2.1. There
|
||||||
1471 classes total.
|
are 1471 classes total.
|
||||||
|
|
||||||
```
|
```
|
||||||
Object
|
Object
|
||||||
|
|
|
@ -1,8 +1,8 @@
|
||||||
# Structures
|
# Structures
|
||||||
|
|
||||||
Here is a full list of all structures in ZScript as of GZDoom 4.2.0. There are
|
Here is a full list of all structures in ZScript as of GZDoom 4.2.1.
|
||||||
76 structures total. Note that some of these are merely
|
There are 76 structures total. Note that some of these
|
||||||
implementation details and should not be used in code.
|
are merely implementation details and should not be used in code.
|
||||||
|
|
||||||
```
|
```
|
||||||
Struct
|
Struct
|
||||||
|
|
|
@ -26,6 +26,7 @@
|
||||||
* [Version 4.1.2](#version-412)
|
* [Version 4.1.2](#version-412)
|
||||||
* [Version 4.1.3](#version-413)
|
* [Version 4.1.3](#version-413)
|
||||||
* [Version 4.2.0](#version-420)
|
* [Version 4.2.0](#version-420)
|
||||||
|
* [Version 4.2.1](#version-421)
|
||||||
|
|
||||||
<!-- vim-markdown-toc -->
|
<!-- vim-markdown-toc -->
|
||||||
|
|
||||||
|
@ -852,4 +853,13 @@ No changes.
|
||||||
- Added `sound_id` parameter to `PlayerInfo::SetSubtitleNumber`.
|
- Added `sound_id` parameter to `PlayerInfo::SetSubtitleNumber`.
|
||||||
- Added a warning for unknown `DropItem`s.
|
- Added a warning for unknown `DropItem`s.
|
||||||
|
|
||||||
|
## Version 4.2.1
|
||||||
|
|
||||||
|
- Added `BaseStatusBar::DrawChat`.
|
||||||
|
- Added `BaseStatusBar::FlushNotify`.
|
||||||
|
- Added `BaseStatusBar::ProcessMidPrint`.
|
||||||
|
- Added `BaseStatusBar::ProcessNotify`.
|
||||||
|
- Added `EPrintLevel`.
|
||||||
|
- Added the ability to specify deprecation messages.
|
||||||
|
|
||||||
<!-- EOF -->
|
<!-- EOF -->
|
||||||
|
|
|
@ -41,19 +41,19 @@ protected meta int m_CoolMetaInt;
|
||||||
|
|
||||||
# Member Declaration Flags
|
# Member Declaration Flags
|
||||||
|
|
||||||
| Flag | Description |
|
| Flag | Description |
|
||||||
| ---- | ----------- |
|
| ---- | ----------- |
|
||||||
| `deprecated ( "ver" )` | If accessed, a script warning will occur on load if the archive version is greater than `ver`. |
|
| `deprecated ( "ver" $[ , "reason" ]$ )` | If accessed, a script warning will occur on load if the archive version is greater than `ver`, with the reason `reason` specified in the message. |
|
||||||
| `internal` | Member is only writable from the base resource archive (`gzdoom.pk3`.) *Version 3.4.0 and newer.* |
|
| `internal` | Member is only writable from the base resource archive (`gzdoom.pk3`.) *Version 3.4.0 and newer.* |
|
||||||
| `latent` | Does nothing. Purpose unknown. |
|
| `latent` | Does nothing. Purpose unknown. |
|
||||||
| `meta` | Member is read-only static class data. Only really useful on actors, since these can be set via properties on them. |
|
| `meta` | Member is read-only static class data. Only really useful on actors, since these can be set via properties on them. |
|
||||||
| `native` | Member is from the engine. Only usable internally. |
|
| `native` | Member is from the engine. Only usable internally. |
|
||||||
| `play` | Member has Play scope. |
|
| `play` | Member has Play scope. |
|
||||||
| `private` | Member is not visible to any class but this one. |
|
| `private` | Member is not visible to any class but this one. |
|
||||||
| `protected` | Member is not visible to any class but this one and any descendants of it. |
|
| `protected` | Member is not visible to any class but this one and any descendants of it. |
|
||||||
| `readonly` | Member is not writable. |
|
| `readonly` | Member is not writable. |
|
||||||
| `transient` | Member is not saved into save games. Required for unserializable objects and recommended for UI context objects. |
|
| `transient` | Member is not saved into save games. Required for unserializable objects and recommended for UI context objects. |
|
||||||
| `ui` | Member has UI scope. |
|
| `ui` | Member has UI scope. |
|
||||||
| `version ( "ver" )` | Restricted to ZScript version `ver` or higher. |
|
| `version ( "ver" )` | Restricted to ZScript version `ver` or higher. |
|
||||||
|
|
||||||
<!-- EOF -->
|
<!-- EOF -->
|
||||||
|
|
|
@ -81,24 +81,24 @@ DoSomething(7, 8, 9, 10);
|
||||||
|
|
||||||
# Method Definition Flags
|
# Method Definition Flags
|
||||||
|
|
||||||
| Flag | Description |
|
| Flag | Description |
|
||||||
| ---- | ----------- |
|
| ---- | ----------- |
|
||||||
| `action ( Scope )` | Same as `action`, but has a specified action scope. See "Action Scoping" for more information. |
|
| `action ( Scope )` | Same as `action`, but has a specified action scope. See "Action Scoping" for more information. |
|
||||||
| `action` | Method has implicit `invoker` and `stateinfo` parameters. See below for more info. |
|
| `action` | Method has implicit `invoker` and `stateinfo` parameters. See below for more info. |
|
||||||
| `clearscope` | Method has Data scope. |
|
| `clearscope` | Method has Data scope. |
|
||||||
| `deprecated ( "ver" )` | If accessed, a script warning will occur on load if the archive version is greater than `ver`. |
|
| `deprecated ( "ver" $[ , "reason" ]$ )` | If accessed, a script warning will occur on load if the archive version is greater than `ver`, with the reason `reason` specified in the message. |
|
||||||
| `final` | Virtual method cannot be further overridden from derived classes. |
|
| `final` | Virtual method cannot be further overridden from derived classes. |
|
||||||
| `native` | Method is from the engine. Only usable internally. |
|
| `native` | Method is from the engine. Only usable internally. |
|
||||||
| `override` | Method is overriding a base class' virtual method. |
|
| `override` | Method is overriding a base class' virtual method. |
|
||||||
| `play` | Method has Play scope. |
|
| `play` | Method has Play scope. |
|
||||||
| `private` | Method is not visible to any class but this one. |
|
| `private` | Method is not visible to any class but this one. |
|
||||||
| `protected` | Method is not visible to any class but this one and any descendants of it. |
|
| `protected` | Method is not visible to any class but this one and any descendants of it. |
|
||||||
| `static` | Function is not a method, but a global function without a `self` pointer. |
|
| `static` | Function is not a method, but a global function without a `self` pointer. |
|
||||||
| `ui` | Method has UI scope. |
|
| `ui` | Method has UI scope. |
|
||||||
| `vararg` | Method doesn't type-check arguments after `...`. Only usable internally. |
|
| `vararg` | Method doesn't type-check arguments after `...`. Only usable internally. |
|
||||||
| `version ( "ver" )` | Restricted to ZScript version `ver` or higher. |
|
| `version ( "ver" )` | Restricted to ZScript version `ver` or higher. |
|
||||||
| `virtual` | Method can be overridden in derived classes. |
|
| `virtual` | Method can be overridden in derived classes. |
|
||||||
| `virtualscope` | Method has scope of the type of the object it's being called on. |
|
| `virtualscope` | Method has scope of the type of the object it's being called on. |
|
||||||
|
|
||||||
## Action functions
|
## Action functions
|
||||||
|
|
||||||
|
|
|
@ -15,7 +15,7 @@ VERSION = ARGV.shift
|
||||||
|
|
||||||
siphon = ClassSiphon.new FILES
|
siphon = ClassSiphon.new FILES
|
||||||
|
|
||||||
file = open "glossary-Classes.md", "wb"
|
file = open "glossary/Classes.md", "wb"
|
||||||
file.puts <<_end_
|
file.puts <<_end_
|
||||||
# Classes
|
# Classes
|
||||||
|
|
||||||
|
@ -34,7 +34,7 @@ file.puts <<_end_
|
||||||
<!-- EOF -->
|
<!-- EOF -->
|
||||||
_end_
|
_end_
|
||||||
|
|
||||||
file = open "glossary-Structures.md", "wb"
|
file = open "glossary/Structures.md", "wb"
|
||||||
file.puts <<_end_
|
file.puts <<_end_
|
||||||
# Structures
|
# Structures
|
||||||
|
|
||||||
|
|
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue