mirror of https://github.com/marrub--/zscript-doc
update for 4.1.0-4.2.0
parent
a31fc00b51
commit
0d8b097846
|
@ -1,7 +1,7 @@
|
||||||
# Classes
|
# Classes
|
||||||
|
|
||||||
Here is a full tree of all classes in ZScript as of GZDoom 4.0.0. There are
|
Here is a full tree of all classes in ZScript as of GZDoom 4.2.0. There are
|
||||||
1460 classes total.
|
1471 classes total.
|
||||||
|
|
||||||
```
|
```
|
||||||
Object
|
Object
|
||||||
|
@ -9,7 +9,6 @@ Object
|
||||||
├ AltHud
|
├ AltHud
|
||||||
├ BaseStatusBar
|
├ BaseStatusBar
|
||||||
│ ├ DoomStatusBar
|
│ ├ DoomStatusBar
|
||||||
│ │ └ HarmonyStatusBar
|
|
||||||
│ ├ HereticStatusBar
|
│ ├ HereticStatusBar
|
||||||
│ ├ HexenStatusBar
|
│ ├ HexenStatusBar
|
||||||
│ ├ SBarInfoWrapper
|
│ ├ SBarInfoWrapper
|
||||||
|
@ -44,6 +43,7 @@ Object
|
||||||
│ │ ├ GameplayMenu
|
│ │ ├ GameplayMenu
|
||||||
│ │ ├ GLTextureGLOptions
|
│ │ ├ GLTextureGLOptions
|
||||||
│ │ ├ JoystickConfigMenu
|
│ │ ├ JoystickConfigMenu
|
||||||
|
│ │ ├ NewPlayerMenu
|
||||||
│ │ ├ os_Menu
|
│ │ ├ os_Menu
|
||||||
│ │ ├ ReverbEdit
|
│ │ ├ ReverbEdit
|
||||||
│ │ ├ ReverbSave
|
│ │ ├ ReverbSave
|
||||||
|
@ -56,6 +56,7 @@ Object
|
||||||
├ MenuItemBase
|
├ MenuItemBase
|
||||||
│ ├ ListMenuItem
|
│ ├ ListMenuItem
|
||||||
│ │ ├ ListMenuItemPlayerDisplay
|
│ │ ├ ListMenuItemPlayerDisplay
|
||||||
|
│ │ │ └ PlayerMenuPlayerDisplay
|
||||||
│ │ ├ ListMenuItemSelectable
|
│ │ ├ ListMenuItemSelectable
|
||||||
│ │ │ ├ ListMenuItemPatchItem
|
│ │ │ ├ ListMenuItemPatchItem
|
||||||
│ │ │ ├ ListMenuItemPlayerNameBox
|
│ │ │ ├ ListMenuItemPlayerNameBox
|
||||||
|
@ -70,6 +71,7 @@ Object
|
||||||
│ ├ OptionMenuFieldBase
|
│ ├ OptionMenuFieldBase
|
||||||
│ │ ├ OptionMenuItemNumberField
|
│ │ ├ OptionMenuItemNumberField
|
||||||
│ │ └ OptionMenuItemTextField
|
│ │ └ OptionMenuItemTextField
|
||||||
|
│ │ ├ OptionMenuItemPlayerNameField
|
||||||
│ │ └ os_SearchField
|
│ │ └ os_SearchField
|
||||||
│ ├ OptionMenuItemColorPicker
|
│ ├ OptionMenuItemColorPicker
|
||||||
│ ├ OptionMenuItemControlBase
|
│ ├ OptionMenuItemControlBase
|
||||||
|
@ -80,6 +82,12 @@ Object
|
||||||
│ │ ├ OptionMenuItemJoyMap
|
│ │ ├ OptionMenuItemJoyMap
|
||||||
│ │ ├ OptionMenuItemOption
|
│ │ ├ OptionMenuItemOption
|
||||||
│ │ │ └ os_AnyOrAllOption
|
│ │ │ └ os_AnyOrAllOption
|
||||||
|
│ │ ├ OptionMenuItemPlayerClassItem
|
||||||
|
│ │ ├ OptionMenuItemPlayerColorItem
|
||||||
|
│ │ ├ OptionMenuItemPlayerGenderItem
|
||||||
|
│ │ ├ OptionMenuItemPlayerSkinItem
|
||||||
|
│ │ ├ OptionMenuItemPlayerSwitchOnPickupItem
|
||||||
|
│ │ ├ OptionMenuItemPlayerTeamItem
|
||||||
│ │ ├ OptionMenuItemReverbOption
|
│ │ ├ OptionMenuItemReverbOption
|
||||||
│ │ └ OptionMenuItemReverbSaveSelect
|
│ │ └ OptionMenuItemReverbSaveSelect
|
||||||
│ ├ OptionMenuItemScreenResolution
|
│ ├ OptionMenuItemScreenResolution
|
||||||
|
@ -92,6 +100,8 @@ Object
|
||||||
│ │ ├ OptionMenuItemLabeledSubmenu
|
│ │ ├ OptionMenuItemLabeledSubmenu
|
||||||
│ │ └ OptionMenuItemReverbSelect
|
│ │ └ OptionMenuItemReverbSelect
|
||||||
│ └ OptionMenuSliderBase
|
│ └ OptionMenuSliderBase
|
||||||
|
│ ├ OptionMenuItemAutoaimSlider
|
||||||
|
│ ├ OptionMenuItemPlayerColorSlider
|
||||||
│ ├ OptionMenuItemSlider
|
│ ├ OptionMenuItemSlider
|
||||||
│ │ └ OptionMenuItemScaleSlider
|
│ │ └ OptionMenuItemScaleSlider
|
||||||
│ ├ OptionMenuItemSliderReverbEditOption
|
│ ├ OptionMenuItemSliderReverbEditOption
|
||||||
|
@ -107,6 +117,7 @@ Object
|
||||||
├ SectorTagIterator
|
├ SectorTagIterator
|
||||||
├ SeqNode
|
├ SeqNode
|
||||||
├ Shape2D
|
├ Shape2D
|
||||||
|
├ Shape2DTransform
|
||||||
├ SpotState
|
├ SpotState
|
||||||
├ StaticEventHandler
|
├ StaticEventHandler
|
||||||
│ └ EventHandler
|
│ └ EventHandler
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# Structures
|
# Structures
|
||||||
|
|
||||||
Here is a full list of all structures in ZScript as of GZDoom 4.0.0. There are
|
Here is a full list of all structures in ZScript as of GZDoom 4.2.0. There are
|
||||||
76 structures total. Note that some of these are merely
|
76 structures total. Note that some of these are merely
|
||||||
implementation details and should not be used in code.
|
implementation details and should not be used in code.
|
||||||
|
|
||||||
|
|
|
@ -18,7 +18,15 @@
|
||||||
* [Version 3.6.0](#version-360)
|
* [Version 3.6.0](#version-360)
|
||||||
* [Version 3.7.0](#version-370)
|
* [Version 3.7.0](#version-370)
|
||||||
* [Version 3.7.2](#version-372)
|
* [Version 3.7.2](#version-372)
|
||||||
|
* [Version 3.8.0 (Legacy)](#version-380-legacy)
|
||||||
|
* [Version 3.8.1 (Legacy)](#version-381-legacy)
|
||||||
|
* [Version 3.8.2 (Legacy)](#version-382-legacy)
|
||||||
* [Version 4.0.0](#version-400)
|
* [Version 4.0.0](#version-400)
|
||||||
|
* [Version 4.1.0](#version-410)
|
||||||
|
* [Version 4.1.1](#version-411)
|
||||||
|
* [Version 4.1.2](#version-412)
|
||||||
|
* [Version 4.1.3](#version-413)
|
||||||
|
* [Version 4.2.0](#version-420)
|
||||||
|
|
||||||
<!-- vim-markdown-toc -->
|
<!-- vim-markdown-toc -->
|
||||||
|
|
||||||
|
@ -339,8 +347,8 @@ Here is a list of differences between ZScript versions.
|
||||||
- Added `Actor::VelIntercept`.
|
- Added `Actor::VelIntercept`.
|
||||||
- Added `Actor::bBounceOnUnrippables`.
|
- Added `Actor::bBounceOnUnrippables`.
|
||||||
- Added `Actor::bDontBounceOnSky`.
|
- Added `Actor::bDontBounceOnSky`.
|
||||||
- Added `Actor::bNOFRICTIONBOUNCE`.
|
- Added `Actor::bNoFrictionBounce`.
|
||||||
- Added `Actor::bNOFRICTION`.
|
- Added `Actor::bNoFriction`.
|
||||||
- Added `AllClasses`.
|
- Added `AllClasses`.
|
||||||
- Added `AltHud`.
|
- Added `AltHud`.
|
||||||
- Added `AmbientSound::MarkAmbientSounds`.
|
- Added `AmbientSound::MarkAmbientSounds`.
|
||||||
|
@ -511,6 +519,18 @@ Here is a list of differences between ZScript versions.
|
||||||
- Made `ScriptUtil::PlayerAmmo` be `static`.
|
- Made `ScriptUtil::PlayerAmmo` be `static`.
|
||||||
- Made `bool` negatable by the `-` prefix operator.
|
- Made `bool` negatable by the `-` prefix operator.
|
||||||
|
|
||||||
|
## Version 3.8.0 (Legacy)
|
||||||
|
|
||||||
|
TODO
|
||||||
|
|
||||||
|
## Version 3.8.1 (Legacy)
|
||||||
|
|
||||||
|
TODO
|
||||||
|
|
||||||
|
## Version 3.8.2 (Legacy)
|
||||||
|
|
||||||
|
TODO
|
||||||
|
|
||||||
## Version 4.0.0
|
## Version 4.0.0
|
||||||
|
|
||||||
- Added `Actor::CanTouchItem`.
|
- Added `Actor::CanTouchItem`.
|
||||||
|
@ -525,7 +545,7 @@ Here is a list of differences between ZScript versions.
|
||||||
- Added `DehInfo::MaxHealth`.
|
- Added `DehInfo::MaxHealth`.
|
||||||
- Added `GameInfoStruct::NormForwardMove`.
|
- Added `GameInfoStruct::NormForwardMove`.
|
||||||
- Added `GameInfoStruct::NormSideMove`.
|
- Added `GameInfoStruct::NormSideMove`.
|
||||||
- Added `Inventory::bUNCLEARABLE`.
|
- Added `Inventory::bUnClearable`.
|
||||||
- Added `LevelCompatibility::AddLineID`.
|
- Added `LevelCompatibility::AddLineID`.
|
||||||
- Added `LevelCompatibility::AddSectorTag`.
|
- Added `LevelCompatibility::AddSectorTag`.
|
||||||
- Added `LevelCompatibility::Apply`.
|
- Added `LevelCompatibility::Apply`.
|
||||||
|
@ -631,10 +651,10 @@ Here is a list of differences between ZScript versions.
|
||||||
- Added `level` parameter to `ScriptUtils::SetMarineWeapon`.
|
- Added `level` parameter to `ScriptUtils::SetMarineWeapon`.
|
||||||
- Added `nomove` parameter to `StatusScreen::DrawNum`.
|
- Added `nomove` parameter to `StatusScreen::DrawNum`.
|
||||||
- Added `nomove` parameter to `StatusScreen::DrawPercent`.
|
- Added `nomove` parameter to `StatusScreen::DrawPercent`.
|
||||||
- Added `os_AnyOrAllOption`.
|
- Added `OS_AnyOrAllOption`.
|
||||||
- Added `os_Menu`.
|
- Added `OS_Menu`.
|
||||||
- Added `os_Query`.
|
- Added `OS_Query`.
|
||||||
- Added `os_SearchField`.
|
- Added `OS_SearchField`.
|
||||||
- Added `source` parameter to `Actor::GetModifiedDamage`.
|
- Added `source` parameter to `Actor::GetModifiedDamage`.
|
||||||
- Added `source` parameter to `Inventory::ModifyDamage`.
|
- Added `source` parameter to `Inventory::ModifyDamage`.
|
||||||
- Deprecated `Actor::FindUniqueTid`.
|
- Deprecated `Actor::FindUniqueTid`.
|
||||||
|
@ -703,4 +723,132 @@ Here is a list of differences between ZScript versions.
|
||||||
- Removed `PlayerPawn::PlayerFlags`.
|
- Removed `PlayerPawn::PlayerFlags`.
|
||||||
- Removed `TextEnterMenu::mSizeMode`.
|
- Removed `TextEnterMenu::mSizeMode`.
|
||||||
|
|
||||||
|
## Version 4.1.0
|
||||||
|
|
||||||
|
- Added `AlternativeSmallFont`.
|
||||||
|
- Added `ConversationMenu::DisplayFont`.
|
||||||
|
- Added `ConversationMenu::DisplayHeight`.
|
||||||
|
- Added `ConversationMenu::DisplayWidth`.
|
||||||
|
- Added `ConversationMenu::FontScale`.
|
||||||
|
- Added `ConversationMenu::RefHeight`.
|
||||||
|
- Added `ConversationMenu::RefWidth`.
|
||||||
|
- Added `ConversationMenu::ReplyLineHeight`.
|
||||||
|
- Added `DTA_MONOSPACE`.
|
||||||
|
- Added `DTA_SPACING`.
|
||||||
|
- Added `DeathmatchStatusScreen::DisplayFont`.
|
||||||
|
- Added `DeathmatchStatusScreen::FontScale`.
|
||||||
|
- Added `DeathmatchStatusScreen::RowHeight`.
|
||||||
|
- Added `Font::CanPrint`.
|
||||||
|
- Added `Font::CanPrint`.
|
||||||
|
- Added `Generic_UI`.
|
||||||
|
- Added `MONO_CELLCENTER`.
|
||||||
|
- Added `MONO_CELLLEFT`.
|
||||||
|
- Added `MONO_CELLRIGHT`.
|
||||||
|
- Added `MONO_OFF`.
|
||||||
|
- Added `Menu::UpdateColorSets`.
|
||||||
|
- Added `Menu::UpdateSkinOptions`.
|
||||||
|
- Added `MessageBoxMenu::ArrowFont`.
|
||||||
|
- Added `MessageBoxMenu::DestHeight`.
|
||||||
|
- Added `MessageBoxMenu::DestWidth`.
|
||||||
|
- Added `MessageBoxMenu::Selector`.
|
||||||
|
- Added `MessageBoxMenu::TextFont`.
|
||||||
|
- Added `NewPlayerMenu`.
|
||||||
|
- Added `OptionMenu::GetIndent`.
|
||||||
|
- Added `OptionMenuItemAutoAimSlider`.
|
||||||
|
- Added `OptionMenuItemPlayerClassItem`.
|
||||||
|
- Added `OptionMenuItemPlayerColorItem`.
|
||||||
|
- Added `OptionMenuItemPlayerColorSlider`.
|
||||||
|
- Added `OptionMenuItemPlayerGenderItem`.
|
||||||
|
- Added `OptionMenuItemPlayerNameField`.
|
||||||
|
- Added `OptionMenuItemPlayerSkinItem`.
|
||||||
|
- Added `OptionMenuItemPlayerSwitchOnPickupItem`.
|
||||||
|
- Added `OptionMenuItemPlayerTeamItem`.
|
||||||
|
- Added `OriginalBigFont`.
|
||||||
|
- Added `OriginalSmallFont`.
|
||||||
|
- Added `PlayerMenuPlayerDisplay`.
|
||||||
|
- Added `String::ByteAt`.
|
||||||
|
- Added `String::CharLower`.
|
||||||
|
- Added `String::CharUpper`.
|
||||||
|
- Added `String::CodePointCount`.
|
||||||
|
- Added `String::GetNextCodePoint`.
|
||||||
|
- Added `String::MakeLower`.
|
||||||
|
- Added `String::MakeUpper`.
|
||||||
|
- Added `withmapname` parameter to `AltHud::DrawCoordinates`.
|
||||||
|
- Changed `HUDFont::Create`'s `monospaced` parameter to `EMonoSpacing` and renamed to `monospacing`.
|
||||||
|
- Deprecated `String::CharAt`.
|
||||||
|
- Deprecated `String::CharCodeAt`.
|
||||||
|
- Deprecated `String::ToLower`.
|
||||||
|
- Deprecated `String::ToUpper`.
|
||||||
|
- Made `PlayerMenu::AlwaysRunChanged` be `public`.
|
||||||
|
- Made `PlayerMenu::AutoAimChanged` be `public`.
|
||||||
|
- Made `PlayerMenu::ClassChanged` be `public`.
|
||||||
|
- Made `PlayerMenu::ColorChanged` be `public`.
|
||||||
|
- Made `PlayerMenu::ColorSetChanged` be `public`.
|
||||||
|
- Made `PlayerMenu::GenderChanged` be `public`.
|
||||||
|
- Made `PlayerMenu::PlayerNameChanged` be `public`.
|
||||||
|
- Made `PlayerMenu::SkinChanged` be `public`.
|
||||||
|
- Made `PlayerMenu::SwitchOnPickupChanged` be `public`.
|
||||||
|
- Made `PlayerMenu::TeamChanged` be `public`.
|
||||||
|
- Removed `Menu::OptionColor`.
|
||||||
|
|
||||||
|
## Version 4.1.1
|
||||||
|
|
||||||
|
- Fixed `ConversationMenu::FormatReplies` using deprecated functions.
|
||||||
|
- Fixed `ConversationMenu::FormatSpeakerMessage` using deprecated functions.
|
||||||
|
- Fixed `PatchInfo::Init` using deprecated functions.
|
||||||
|
- Fixed `PlayerPawn::GetObituary` using deprecated functions.
|
||||||
|
|
||||||
|
## Version 4.1.2
|
||||||
|
|
||||||
|
No changes.
|
||||||
|
|
||||||
|
## Version 4.1.3
|
||||||
|
|
||||||
|
- Added `PlayerInfo::SetSubtitleNumber`
|
||||||
|
|
||||||
|
## Version 4.2.0
|
||||||
|
|
||||||
|
- Added `Actor::A_AttachLightDef`.
|
||||||
|
- Added `Actor::A_AttachLight`.
|
||||||
|
- Added `Actor::A_RemoveLight`.
|
||||||
|
- Added `Actor::A_SoundPitch`.
|
||||||
|
- Added `Actor::RetargetAfterSlam`.
|
||||||
|
- Added `Array::Append`.
|
||||||
|
- Added `ConversationMenu::FontFactor`.
|
||||||
|
- Added `ConversationMenu::SpeechDisplayWidth`.
|
||||||
|
- Added `ConversationMenu::mConfineTextToBackdrop`.
|
||||||
|
- Added `ConversationMenu::mHasBackdrop`.
|
||||||
|
- Added `DoomStatusBar::DrawBarKeys`.
|
||||||
|
- Added `DoomStatusBar::DrawBarWeapons`.
|
||||||
|
- Added `DoomStatusBar::DrawFullScreenKeys`.
|
||||||
|
- Added `DynamicLight::LF_ADDITIVE`.
|
||||||
|
- Added `DynamicLight::LF_ATTENUATE`.
|
||||||
|
- Added `DynamicLight::LF_DONTLIGHTACTORS`.
|
||||||
|
- Added `DynamicLight::LF_DONTLIGHTSELF`.
|
||||||
|
- Added `DynamicLight::LF_NOSHADOWMAP`.
|
||||||
|
- Added `DynamicLight::LF_SPOT`.
|
||||||
|
- Added `DynamicLight::LF_SUBTRACTIVE`.
|
||||||
|
- Added `Font::GetDisplacement`.
|
||||||
|
- Added `Font::GetMaxAscender`.
|
||||||
|
- Added `GameInfoStruct::mStatScreenAuthorFont`.
|
||||||
|
- Added `GameInfoStruct::mStatScreenContentFont`.
|
||||||
|
- Added `LevelLocals::AuthorName`.
|
||||||
|
- Added `LevelLocals::ExitLevel`.
|
||||||
|
- Added `LevelLocals::SecretExitLevel`.
|
||||||
|
- Added `Menu::DontBlur`.
|
||||||
|
- Added `PSprite::bMirror`.
|
||||||
|
- Added `Shape2D::SetTransform`.
|
||||||
|
- Added `Shape2DTransform`.
|
||||||
|
- Added `StaticEventHandler::RenderUnderlay`.
|
||||||
|
- Added `StatusScreen::AuthorTexts`.
|
||||||
|
- Added `StatusScreen::Author`.
|
||||||
|
- Added `StatusScreen::Content`.
|
||||||
|
- Added `StatusScreen::DrawAuthor`.
|
||||||
|
- Added `WBStartStruct::NextAuthor`.
|
||||||
|
- Added `WBStartStruct::ThisAuthor`.
|
||||||
|
- Added `pitch` parameter to `Actor::A_SoundPitch`.
|
||||||
|
- Added `pitch` parameter to `Object::S_Sound`.
|
||||||
|
- Added `sound_id` parameter to `PlayerInfo::SetSubtitleNumber`.
|
||||||
|
- Added a warning for unknown `DropItem`s.
|
||||||
|
|
||||||
<!-- EOF -->
|
<!-- EOF -->
|
||||||
|
|
|
@ -3,6 +3,10 @@
|
||||||
## By Alison Sanderson. Attribution is encouraged, though not required.
|
## By Alison Sanderson. Attribution is encouraged, though not required.
|
||||||
## <https://creativecommons.org/publicdomain/zero/1.0/legalcode>
|
## <https://creativecommons.org/publicdomain/zero/1.0/legalcode>
|
||||||
## TreeGen: Generates the glossary files for classes.
|
## TreeGen: Generates the glossary files for classes.
|
||||||
|
## Example usage:
|
||||||
|
## tools/treegen.rb \
|
||||||
|
## '/mnt/g/Archive/gzdoom-g4.1.0/wadsrc/static/zscript/**/*.zs' \
|
||||||
|
## 4.1.0
|
||||||
|
|
||||||
require "./tools/zsclasstree.rb"
|
require "./tools/zsclasstree.rb"
|
||||||
|
|
||||||
|
@ -11,7 +15,7 @@ VER = ARGV.shift
|
||||||
|
|
||||||
si = ClassSiphon.new DIR
|
si = ClassSiphon.new DIR
|
||||||
|
|
||||||
f = open "glossary-classes.md", "wb"
|
f = open "glossary-Classes.md", "wb"
|
||||||
f.puts <<_end_
|
f.puts <<_end_
|
||||||
# Classes
|
# Classes
|
||||||
|
|
||||||
|
@ -30,7 +34,7 @@ f.puts <<_end_
|
||||||
<!-- EOF -->
|
<!-- EOF -->
|
||||||
_end_
|
_end_
|
||||||
|
|
||||||
f = open "glossary-structures.md", "wb"
|
f = open "glossary-Structures.md", "wb"
|
||||||
f.puts <<_end_
|
f.puts <<_end_
|
||||||
# Structures
|
# Structures
|
||||||
|
|
||||||
|
|
|
@ -3,6 +3,10 @@
|
||||||
## By Alison Sanderson. Attribution is encouraged, though not required.
|
## By Alison Sanderson. Attribution is encouraged, though not required.
|
||||||
## <https://creativecommons.org/publicdomain/zero/1.0/legalcode>
|
## <https://creativecommons.org/publicdomain/zero/1.0/legalcode>
|
||||||
## ZSClassTree: Generates a class tree from ZScript files.
|
## ZSClassTree: Generates a class tree from ZScript files.
|
||||||
|
## Example usage:
|
||||||
|
## tools/zsclasstree.rb \
|
||||||
|
## '/mnt/g/Archive/gzdoom-g4.1.0/wadsrc/static/zscript/**/*.zs' \
|
||||||
|
## > trees/tree_g4.1.0.txt
|
||||||
|
|
||||||
require 'set'
|
require 'set'
|
||||||
|
|
||||||
|
|
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue