marrub
/
zscript-doc
mirror of https://github.com/marrub--/zscript-doc
1
0
Fork 0
Code Releases Activity

fix most capitalization

pull/1/head
an 2019-04-10 09:12:18 -04:00
parent e197714199
commit a31fc00b51
15 changed files with 185 additions and 185 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
api-base-CVar.md
View File

@ -71,11 +71,11 @@ struct CVar
| Name |
| ---- |
| `CVar.CVAR_Bool` |
| `CVar.CVAR_Color` |
| `CVar.CVAR_Float` |
| `CVar.CVAR_Int` |
| `CVar.CVAR_String` |
| `CVar.CVAR_BOOL` |
| `CVar.CVAR_COLOR |
| `CVar.CVAR_FLOAT` |
| `CVar.CVAR_INT` |
| `CVar.CVAR_STRING` |
- `ResetToDefault`

78
api-drawing-Screen.md
View File

@ -59,50 +59,50 @@ struct Screen
| Name | Description |
| ---- | ----------- |
| `DTA_Base` | No position scaling is performed. |
| `DTA_Clean` | Scales all positions by `Clean*Fac`. See the documentation for those variables for more information. |
| `DTA_CleanNoMove` | Scales the destination width and height by `Clean*Fac`. |
| `DTA_CleanNoMove_1` | Scales the destination width and height by `Clean*Fac_1`. |
| `DTA_Fullscreen` | Sets the X and Y positions to `0`. (Yes, really, this is all it does.) |
| `DTA_HUDRules` | Scales all positions by the current status bar's scaling rules. |
| `DTA_HUDRulesC` | Scales all positions by the current status bar's scaling rules and centers the X position. |
| `DTA_BASE` | No position scaling is performed. |
| `DTA_CLEAN` | Scales all positions by `Clean*Fac`. See the documentation for those variables for more information. |
| `DTA_CLEANNOMOVE` | Scales the destination width and height by `Clean*Fac`. |
| `DTA_CLEANNOMOVE_1` | Scales the destination width and height by `Clean*Fac_1`. |
| `DTA_FULLSCREEN` | Sets the X and Y positions to `0`. (Yes, really, this is all it does.) |
| `DTA_HUDRULES` | Scales all positions by the current status bar's scaling rules. |
| `DTA_HUDRULESC` | Scales all positions by the current status bar's scaling rules and centers the X position. |
Here is a list of tags and their respective arguments which may be used:
| Name | Arguments | Description |
| ---- | --------- | ----------- |
| `DTA_320x200` | `bool use` | Sets `CleanMode` to `DTA_Base` and the virtual width/height to `320`/`200` if `use` is `true`. Note that 320x200 does not scale properly to the screen as it must be 320x240 to do so. |
| `DTA_AlphaChannel` | `bool use` | Does nothing unless `DTA_FillColor` is used and the render style is unspecified, in which case it will set the render style to "shaded" if `use` is `true`. |
| `DTA_Alpha` | `double alpha` | Sets the alpha of the drawn texture to `alpha`. |
| `DTA_Bottom320x200` | `bool use` | Same as `DTA_320x200`, but also enables position transformation as if a call to `VirtualToRealCoords` with `vbottom` to `true`. Note that this is the only way to actually set this, but it may be overridden by following arguments to effectively toggle only this flag. |
| `DTA_CenterBottomOffset` | `bool use` | Same as `DTA_CenterBottomOffset`, but the Y offset is aligned to the bottom instead of the center. |
| `DTA_CenterOffset` | `bool use` | Overrides the texture's X and Y offsets, centering them between the texture's height and width if `use` is `true`. |
| `DTA_CleanNoMove1` | `bool use` | Sets `CleanMode` to `DTA_CleanNoMove1` if `use` is `true`. |
| `DTA_CleanNoMove` | `bool use` | Sets `CleanMode` to `DTA_CleanNoMove` if `use` is `true`. |
| `DTA_Clean` | `bool use` | Sets `CleanMode` to `DTA_Clean` if `use` is `true`. |
| `DTA_ClipBottom`, `DTA_ClipTop` | `int length` | Sets the vertical clipping for the texture. |
| `DTA_ClipLeft`, `DTA_ClipRight` | `int length` | Sets the horizontal clipping for the texture. |
| `DTA_ColorOverlay` | `color cr` | Multiplies `cr` with the texture. Alpha determines the intensity of this overlay. Applied before render styles. |
| `DTA_Color` | `color cr` | Multiplies `cr` with the texture. Applied after render styles change the color. |
| `DTA_Desaturate` | `int amount` | Desaturates the texture by `amount` (range 0-255.) |
| `DTA_DestHeightF`, `DTA_DestWidthF` | `double size` | Same as `DTA_DestHeight`/`DTA_DestWidth`, but with decimal arguments. |
| `DTA_DestHeight`, `DTA_DestWidth` | `int size` | Sets the resulting width or height on screen of the texture and sets `CleanMode` to `DTA_Base`. |
| `DTA_FillColor` | `color cr` | Sets the render style to "stencil" if one is not specified and the fill color to `cr`. |
| `DTA_FlipX`, `DTA_FlipY` | `bool use` | Flips the X or Y position if `use` is `true`.
| `DTA_Fullscreen` | `bool use` | Sets `CleanMode` to `DTA_Fullscreen` and the virtual width and height to the display size of the texture. |
| `DTA_HUDRules` | `int type` | Sets `CleanMode` to `DTA_HUDRulesC` if `type` is `BaseStatusBar.HUD_HorizCenter`, or `DTA_HUDRules` if it is `BaseStatusBar.HUD_Normal`. |
| `DTA_KeepRatio` | `bool on` | Enables aspect ratio correction if `on` is `true`. |
| `DTA_LeftOffsetF`, `DTA_TopOffsetF` | `double ofs` | Same as `DTA_LeftOffset`/`DTA_TopOffsetF`, but with decimal arguments. |
| `DTA_LeftOffset`, `DTA_TopOffset` | `int ofs` | Overrides the texture's X or Y offset. |
| `DTA_LegacyRenderStyle` | `int style` | Overrides the render style. Note that there is also a `DTA_RenderStyle` which cannot be used because the engine does not expose `FRenderStyle` yet. |
| `DTA_Masked` | `bool on` | Turns the texture fully opaque (no alpha mask) if `on` is `false`. Default value is on. |
| `DTA_SrcHeight`, `DTA_SrcWidth` | `int size` | Sets the width or height of the source image. Will cut the texture if lower than the original size. If the size is larger than the original, it will cause UV clamping, repeating the pixels at the image borders. |
| `DTA_SrcX`, `DTA_SrcY` | `int pos` | Sets the X or Y on the source image to start the texture at. Texture wrapping will cause a UV clamping effect, repeating the pixels at the image borders. |
| `DTA_TranslationIndex` | `int index` | Remaps colors in the destination texture with translation table `index`. |
| `DTA_VirtualHeightF`, `DTA_VirtualWidthF` | `double size` | Same as `DTA_VirtualHeight`/`DTA_VirtualWidth`, but with decimal arguments. |
| `DTA_VirtualHeight`, `DTA_VirtualWidth` | `int size` | Sets the virtual width or height to `size`. |
| `DTA_WindowLeftF`, `DTA_WindowRightF` | `double size` | Same as `DTA_WindowLeft`/`DTA_WindowRight`, but with decimal arguments. |
| `DTA_WindowLeft`, `DTA_WindowRight` | `int size` | Crops `size` pixels from the left or right. |
| `DTA_320X200` | `bool use` | Sets `CleanMode` to `DTA_BASE` and the virtual width/height to `320`/`200` if `use` is `true`. Note that 320x200 does not scale properly to the screen as it must be 320x240 to do so. |
| `DTA_ALPHACHANNEL` | `bool use` | Does nothing unless `DTA_FILLCOLOR` is used and the render style is unspecified, in which case it will set the render style to "shaded" if `use` is `true`. |
| `DTA_ALPHA` | `double alpha` | Sets the alpha of the drawn texture to `alpha`. |
| `DTA_BOTTOM320X200` | `bool use` | Same as `DTA_320X200`, but also enables position transformation as if a call to `VirtualToRealCoords` with `vbottom` to `true`. Note that this is the only way to actually set this, but it may be overridden by following arguments to effectively toggle only this flag. |
| `DTA_CENTERBOTTOMOFFSET` | `bool use` | Same as `DTA_CENTERBOTTOMOFFSET`, but the Y offset is aligned to the bottom instead of the center. |
| `DTA_CENTEROFFSET` | `bool use` | Overrides the texture's X and Y offsets, centering them between the texture's height and width if `use` is `true`. |
| `DTA_CLEANNOMOVE1` | `bool use` | Sets `CleanMode` to `DTA_CLEANNOMOVE1` if `use` is `true`. |
| `DTA_CLEANNOMOVE` | `bool use` | Sets `CleanMode` to `DTA_CLEANNOMOVE` if `use` is `true`. |
| `DTA_CLEAN` | `bool use` | Sets `CleanMode` to `DTA_CLEAN` if `use` is `true`. |
| `DTA_CLIPBOTTOM`, `DTA_CLIPTOP` | `int length` | Sets the vertical clipping for the texture. |
| `DTA_CLIPLEFT`, `DTA_CLIPRIGHT` | `int length` | Sets the horizontal clipping for the texture. |
| `DTA_COLOROVERLAY` | `color cr` | Multiplies `cr` with the texture. Alpha determines the intensity of this overlay. Applied before render styles. |
| `DTA_COLOR` | `color cr` | Multiplies `cr` with the texture. Applied after render styles change the color. |
| `DTA_DESATURATE` | `int amount` | Desaturates the texture by `amount` (range 0-255.) |
| `DTA_DESTHEIGHTF`, `DTA_DESTWIDTHF` | `double size` | Same as `DTA_DESTHEIGHT`/`DTA_DESTWIDTH`, but with decimal arguments. |
| `DTA_DESTHEIGHT`, `DTA_DESTWIDTH` | `int size` | Sets the resulting width or height on screen of the texture and sets `CleanMode` to `DTA_BASE`. |
| `DTA_FILLCOLOR` | `color cr` | Sets the render style to "stencil" if one is not specified and the fill color to `cr`. |
| `DTA_FLIPX`, `DTA_FLIPY` | `bool use` | Flips the X or Y position if `use` is `true`.
| `DTA_FULLSCREEN` | `bool use` | Sets `CleanMode` to `DTA_FULLSCREEN` and the virtual width and height to the display size of the texture. |
| `DTA_HUDRULES` | `int type` | Sets `CleanMode` to `DTA_HUDRULESC` if `type` is `BaseStatusBar.HUD_HORIZCENTER`, or `DTA_HUDRULES` if it is `BaseStatusBar.HUD_NORMAL`. |
| `DTA_KEEPRATIO` | `bool on` | Enables aspect ratio correction if `on` is `true`. |
| `DTA_LEFTOFFSETF`, `DTA_TOPOFFSETF` | `double ofs` | Same as `DTA_LEFTOFFSET`/`DTA_TOPOFFSETF`, but with decimal arguments. |
| `DTA_LEFTOFFSET`, `DTA_TOPOFFSET` | `int ofs` | Overrides the texture's X or Y offset. |
| `DTA_LEGACYRENDERSTYLE` | `int style` | Overrides the render style. Note that there is also a `DTA_RENDERSTYLE` which cannot be used because the engine does not expose `FRenderStyle` yet. |
| `DTA_MASKED` | `bool on` | Turns the texture fully opaque (no alpha mask) if `on` is `false`. Default value is on. |
| `DTA_SRCHEIGHT`, `DTA_SRCWIDTH` | `int size` | Sets the width or height of the source image. Will cut the texture if lower than the original size. If the size is larger than the original, it will cause UV clamping, repeating the pixels at the image borders. |
| `DTA_SRCX`, `DTA_SRCY` | `int pos` | Sets the X or Y on the source image to start the texture at. Texture wrapping will cause a UV clamping effect, repeating the pixels at the image borders. |
| `DTA_TRANSLATIONINDEX` | `int index` | Remaps colors in the destination texture with translation table `index`. |
| `DTA_VIRTUALHEIGHTF`, `DTA_VIRTUALWIDTHF` | `double size` | Same as `DTA_VIRTUALHEIGHT`/`DTA_VIRTUALWIDTH`, but with decimal arguments. |
| `DTA_VIRTUALHEIGHT`, `DTA_VIRTUALWIDTH` | `int size` | Sets the virtual width or height to `size`. |
| `DTA_WINDOWLEFTF`, `DTA_WINDOWRIGHTF` | `double size` | Same as `DTA_WINDOWLEFT`/`DTA_WINDOWRIGHT`, but with decimal arguments. |
| `DTA_WINDOWLEFT`, `DTA_WINDOWRIGHT` | `int size` | Crops `size` pixels from the left or right. |
- `Clear`

44
api-drawing-TexMan.md
View File

@ -26,34 +26,34 @@ struct TexMan
| Name | Description |
| ---- | ----------- |
| `TexMan.Type_Any` | Any kind of texture. |
| `TexMan.Type_Autopage` | Unused. |
| `TexMan.Type_Build` | Unused. |
| `TexMan.Type_Decal` | A decal pic defined in `DECALDEF`. |
| `TexMan.Type_FirstDefined` | The first composite texture defined by the IWad. |
| `TexMan.Type_Flat` | A flat (ceiling/floor texture,) i.e. `FLOOR0_1`. |
| `TexMan.Type_FontChar` | Unused. |
| `TexMan.Type_MiscPatch` | A loose graphic, i.e. `M_DOOM`. |
| `TexMan.Type_Null` | Reserved for the null graphic. Ignores `name`. |
| `TexMan.Type_Override` | Overridable generalized textures, for instance textures defined in `TX_START` or BUILD ART tiles. |
| `TexMan.Type_SkinGraphic` | Any loose graphic defined in `S_SKIN` i.e. statusbar faces. |
| `TexMan.Type_SkinSprite` | Any sprite defined in `S_SKIN`. |
| `TexMan.Type_Sprite` | A sprite in `S_START`, i.e. `MEDIA0`. |
| `TexMan.Type_WallPatch` | An uncomposited patch, i.e. `DOOR2_1`. |
| `TexMan.Type_Wall` | Any composited wall texture, i.e. `STARTAN2`. |
| `TexMan.TYPE_ANY` | Any kind of texture. |
| `TexMan.TYPE_AUTOPAGE` | Unused. |
| `TexMan.TYPE_BUILD` | Unused. |
| `TexMan.TYPE_DECAL` | A decal pic defined in `DECALDEF`. |
| `TexMan.TYPE_FIRSTDEFINED` | The first composite texture defined by the IWad. |
| `TexMan.TYPE_FLAT` | A flat (ceiling/floor texture,) i.e. `FLOOR0_1`. |
| `TexMan.TYPE_FONTCHAR` | Unused. |
| `TexMan.TYPE_MISCPATCH` | A loose graphic, i.e. `M_DOOM`. |
| `TexMan.TYPE_NULL` | Reserved for the null graphic. Ignores `name`. |
| `TexMan.TYPE_OVERRIDE` | Overridable generalized textures, for instance textures defined in `TX_START` or BUILD ART tiles. |
| `TexMan.TYPE_SKINGRAPHIC` | Any loose graphic defined in `S_SKIN` i.e. statusbar faces. |
| `TexMan.TYPE_SKINSPRITE` | Any sprite defined in `S_SKIN`. |
| `TexMan.TYPE_SPRITE` | A sprite in `S_START`, i.e. `MEDIA0`. |
| `TexMan.TYPE_WALLPATCH` | An uncomposited patch, i.e. `DOOR2_1`. |
| `TexMan.TYPE_WALL` | Any composited wall texture, i.e. `STARTAN2`. |
`flags` may be any of the following combined (with the bitwise OR operator
`|`:)
| Name | Description |
| ---- | ----------- |
| `TexMan.AllowSkins` | Allows `SkinGraphic`s to be returned under normal circumstances. |
| `TexMan.DontCreate` | Will never create a new texture when searching. |
| `TexMan.Localize` | TODO . |
| `TexMan.Overridable` | Allows overriding of this texture by for instance `TEXTURES`. |
| `TexMan.ReturnFirst` | Allows returning the `FirstDefined` "null" texture under normal circumstances. |
| `TexMan.ShortNameOnly` | Will force use of a short name when searching. |
| `TexMan.TryAny` | Returns any other type of texture if one is not found in the specified use type. Default. |
| `TexMan.ALLOWSKINS` | Allows `SkinGraphic`s to be returned under normal circumstances. |
| `TexMan.DONTCREATE` | Will never create a new texture when searching. |
| `TexMan.LOCALIZE` | TODO . |
| `TexMan.OVERRIDABLE` | Allows overriding of this texture by for instance `TEXTURES`. |
| `TexMan.RETURNFIRST` | Allows returning the `FirstDefined` "null" texture under normal circumstances. |
| `TexMan.SHORTNAMEONLY` | Will force use of a short name when searching. |
| `TexMan.TRYANY` | Returns any other type of texture if one is not found in the specified use type. Default. |
- `CheckRealHeight`

42
api-files-Wads.md
View File

@ -30,33 +30,33 @@ In short:
| Name | Description | Resource path | Wad file marker |
| ---- | ----------- | ------------- | --------------- |
| `ns_acslibrary` | ACS libraries. | `/acs/` | `A_START`/`A_END` |
| `ns_bloodmisc` | Unused. | N/A | N/A |
| `ns_bloodraw` | Blood `RAW` format sounds. Found only in `RFF` files. | N/A | N/A |
| `ns_bloodsfx` | Blood `SFX` format sounds. Found only in `RFF` files. | N/A | N/A |
| `ns_colormaps` | Boom color maps. | `/colormaps/` | `C_START`/`C_END` |
| `ns_flats` | Flat textures. | `/flats/` | `FF_START`/`FF_END` |
| `ns_global` | The global namespace, which is the root of any archive. | `/` | None |
| `ns_graphics` | Miscellaneous graphics. | `/graphics/` | None |
| `ns_hidden` | Used for filtered files that did not match this game. | N/A | N/A |
| `ns_hires` | Deprecated high-resolution textures. | `/hires/` | `HI_START`/`HI_END` |
| `ns_music` | Music files. | `/music/` | None |
| `ns_newtextures` | Generic texture files, usable as patches or flats. | `/textures/` | `TX_START`/`TX_END` |
| `ns_patches` | Texture patches. | `/patches/` | None |
| `ns_sounds` | Sound files. | `/sounds/` | None |
| `ns_sprites` | Sprites are all contained in this namespace. | `/sprites/` | `S_START`/`S_END` or `SS_START`/`SS_END` |
| `ns_strifevoices` | Strife voice files. | `/voices/` | `V_START`/`V_END` |
| `ns_voxels` | Volumetric pixel (voxel) models. | `/voxels/` | `VX_START`/`VX_END` |
| `NS_ACSLIBRARY` | ACS libraries. | `/acs/` | `A_START`/`A_END` |
| `NS_BLOODMISC` | Unused. | N/A | N/A |
| `NS_BLOODRAW` | Blood `RAW` format sounds. Found only in `RFF` files. | N/A | N/A |
| `NS_BLOODSFX` | Blood `SFX` format sounds. Found only in `RFF` files. | N/A | N/A |
| `NS_COLORMAPS` | Boom color maps. | `/colormaps/` | `C_START`/`C_END` |
| `NS_FLATS` | Flat textures. | `/flats/` | `FF_START`/`FF_END` |
| `NS_GLOBAL` | The global namespace, which is the root of any archive. | `/` | None |
| `NS_GRAPHICS` | Miscellaneous graphics. | `/graphics/` | None |
| `NS_HIDDEN` | Used for filtered files that did not match this game. | N/A | N/A |
| `NS_HIRES` | Deprecated high-resolution textures. | `/hires/` | `HI_START`/`HI_END` |
| `NS_MUSIC` | Music files. | `/music/` | None |
| `NS_NEWTEXTURES` | Generic texture files, usable as patches or flats. | `/textures/` | `TX_START`/`TX_END` |
| `NS_PATCHES` | Texture patches. | `/patches/` | None |
| `NS_SOUNDS` | Sound files. | `/sounds/` | None |
| `NS_SPRITES` | Sprites are all contained in this namespace. | `/sprites/` | `S_START`/`S_END` or `SS_START`/`SS_END` |
| `NS_STRIFEVOICES` | Strife voice files. | `/voices/` | `V_START`/`V_END` |
| `NS_VOXELS` | Volumetric pixel (voxel) models. | `/voxels/` | `VX_START`/`VX_END` |
Additionally, `ns_specialzipdirectory` denotes the start of the specialized
resource archive folder namespaces, which are normally under `ns_global`.
Additionally, `NS_SPECIALZIPDIRECTORY` denotes the start of the specialized
resource archive folder namespaces, which are normally under `NS_GLOBAL`.
```
struct Wads
{
static int CheckNumForFullName(string name);
static int CheckNumForName(string name, int ns, int wadnum = -1, bool exact = false);
static int FindLump(string name, int startlump = 0, FindLumpNamespace ns = Wads.GlobalNamespace);
static int FindLump(string name, int startlump = 0, FindLumpNamespace ns = Wads.GLOBALNAMESPACE);
static string ReadLump(int lump);
}
```
@ -82,7 +82,7 @@ struct Wads
Returns the handle of the first lump named `name` starting at `startlump`
(zero indicates the first lump) in either the global namespace or any
namespace. `ns` can be either `Wads.GlobalNamespace` or `Wads.AnyNamespace`
namespace. `ns` can be either `Wads.GLOBALNAMESPACE` or `Wads.ANYNAMESPACE`
to specify this. Returns `-1` if there are no lumps with that name left.
This function can be used in a loop to find all lumps with a specified name.

4
api-global-data-Information.md
View File

@ -9,7 +9,7 @@ readonly array<PlayerClass> PlayerClasses;
readonly array<PlayerSkin> PlayerSkins;
readonly array<Team> Teams;
play DEHInfo DEH;
play DehInfo Deh;
readonly GameInfoStruct GameInfo;
readonly FOptionMenuSettings OptionMenuSettings;
readonly textureid SkyFlatNum;
@ -37,7 +37,7 @@ readonly Weapon WP_NOCHANGE;
An array of all teams. Maximum index is `Team.Max`.
- `DEH`
- `Deh`
Static DeHackEd information.

44
api-global-func-Game.md
View File

@ -21,19 +21,19 @@ deprecated("3.8") vector3, int G_PickPlayerStart(int pnum, int flags = 0);
| Name |
| ---- |
| `SKILLP_ACSReturn` |
| `SKILLP_AutoUseHealth` |
| `SKILLP_DisableCheats` |
| `SKILLP_EasyBossBrain` |
| `SKILLP_EasyKey` |
| `SKILLP_FastMonsters` |
| `SKILLP_Infight` |
| `SKILLP_NoPain` |
| `SKILLP_PlayerRespawn` |
| `SKILLP_RespawnLimit` |
| `SKILLP_Respawn` |
| `SKILLP_SlowMonsters` |
| `SKILLP_SpawnFilter` |
| `SKILLP_ACSRETURN` |
| `SKILLP_AUTOUSEHEALTH` |
| `SKILLP_DISABLECHEATS` |
| `SKILLP_EASYBOSSBRAIN` |
| `SKILLP_EASYKEY` |
| `SKILLP_FASTMONSTERS` |
| `SKILLP_INFIGHT` |
| `SKILLP_NOPAIN` |
| `SKILLP_PLAYERRESPAWN` |
| `SKILLP_RESPAWNLIMIT` |
| `SKILLP_RESPAWN` |
| `SKILLP_SLOWMONSTERS` |
| `SKILLP_SPAWNFILTER` |
- `G_SkillPropertyFloat`
@ -41,15 +41,15 @@ deprecated("3.8") vector3, int G_PickPlayerStart(int pnum, int flags = 0);
| Name |
| ---- |
| `SKILLP_Aggressiveness` |
| `SKILLP_AmmoFactor` |
| `SKILLP_ArmorFactor` |
| `SKILLP_DamageFactor` |
| `SKILLP_DropAmmoFactor` |
| `SKILLP_FriendlyHealth` |
| `SKILLP_HealthFactor` |
| `SKILLP_MonsterHealth` |
| `SKILLP_KickBackFactor` |
| `SKILLP_AGGRESSIVENESS` |
| `SKILLP_AMMOFACTOR` |
| `SKILLP_ARMORFACTOR` |
| `SKILLP_DAMAGEFACTOR` |
| `SKILLP_DROPAMMOFACTOR` |
| `SKILLP_FRIENDLYHEALTH` |
| `SKILLP_HEALTHFACTOR` |
| `SKILLP_MONSTERHEALTH` |
| `SKILLP_KICKBACKFACTOR` |
- `G_PickDeathmatchStart`

10
api-global-type-DEHInfo.md → api-global-type-DehInfo.md
View File

@ -1,11 +1,11 @@
# DEHInfo
# DehInfo
Static DeHackEd information.
```
struct DEHInfo
struct DehInfo
{
readonly int BFGCells;
readonly int BfgCells;
readonly int BlueAC;
readonly double ExplosionAlpha;
readonly uint8 ExplosionStyle;
@ -15,9 +15,9 @@ struct DEHInfo
}
```
- `BFGCells`
- `BfgCells`
The amount of ammunition `A_FireBFG` will deplete. Default is 40.
The amount of ammunition `A_FireBfg` will deplete. Default is 40.
- `BlueAC`

6
api-global-type-LevelLocals.md
View File

@ -89,9 +89,9 @@ struct LevelLocals
readonly bool SndSeqTotalCtrl;
readonly double TeamDamage;
double GetUDMFFloat(int type, int index, name key);
int GetUDMFInt(int type, int index, name key);
string GetUDMFString(int type, int index, name key);
double GetUdmfFloat(int type, int index, name key);
int GetUdmfInt(int type, int index, name key);
string GetUdmfString(int type, int index, name key);
play int ExecuteSpecial(int special, Actor activator, Line linedef, bool lineside, int arg1 = 0, int arg2 = 0, int arg3 = 0, int arg4 = 0, int arg5 = 0);

54
api-inter-StatusScreen.md
View File

@ -5,12 +5,12 @@ The base class for intermission status screens. Any status screen used by
Status screens have four stages:
- `StatCount`, where the stats are counted and displayed.
- `ShowNextLoc`, where the next map is shown as "ENTERING (map name)" and in episodic maps, the world map.
- `NoState`, at the very end of this process, where the last frame is drawn and the intermission is exited.
- `LeavingIntermission`, which is used only to signify that all stages are done and the status screen has been exited.
- `STATCOUNT`, where the stats are counted and displayed.
- `SHOWNEXTLOC`, where the next map is shown as "ENTERING (map name)" and in episodic maps, the world map.
- `NOSTATE`, at the very end of this process, where the last frame is drawn and the intermission is exited.
- `LEAVINGINTERMISSION`, which is used only to signify that all stages are done and the status screen has been exited.
These are provided as constants in `StatusScreen`. The starting stage is `StatCount`.
These are provided as constants in `StatusScreen`. The starting stage is `STATCOUNT`.
```
class StatusScreen : Object abstract play
@ -25,7 +25,7 @@ class StatusScreen : Object abstract play
InterBackground BG;
WBPlayerStruct Plrs[MAXPLAYERS];
WBStartStruct WBS;
WBStartStruct Wbs;
int AccelerateStage;
int BCnt;
@ -46,7 +46,7 @@ class StatusScreen : Object abstract play
bool NoAutoStartMap;
bool PlayerReady[MAXPLAYERS];
int Player_Deaths[MAXPLAYERS];
bool SNL_PointerOn;
bool Snl_PointerOn;
int SP_State;
float ShadowAlpha;
int Total_Deaths;
@ -135,14 +135,14 @@ class StatusScreen : Object abstract play
- `BG`
The `InterBackground` object for this intermission, set by `Start` with the
initial `WBS` object.
initial `Wbs` object.
- `Plrs`
The value of `WBS.Plyr` when `Start` was called. Usually not changed, so
essentially equivalent to `WBS.Plyr`.
The value of `Wbs.Plyr` when `Start` was called. Usually not changed, so
essentially equivalent to `Wbs.Plyr`.
- `WBS`
- `Wbs`
The `WBStartStruct` passed to this class via the `Start` function.
@ -205,8 +205,8 @@ class StatusScreen : Object abstract play
- `Me`
The value of `WBS.PNum` when `Start` was called. Usually not changed, so
essentially equivalent to `WBS.PNum`.
The value of `Wbs.PNum` when `Start` was called. Usually not changed, so
essentially equivalent to `Wbs.PNum`.
- `NG_State`
@ -225,13 +225,13 @@ class StatusScreen : Object abstract play
TODO
- `SNL_PointerOn`
- `Snl_PointerOn`
TODO
- `SP_State`
Used in single-player status screens during the `StatCount` stage for
Used in single-player status screens during the `STATCOUNT` stage for
indicating the current round of statistics to count up.
- `ShadowAlpha`
@ -334,7 +334,7 @@ class StatusScreen : Object abstract play
- `End`
Called when the intermission should end. Default behaviour is to set
`CurState` to `LeavingIntermission` and remove bots in death-match.
`CurState` to `LEAVINGINTERMISSION` and remove bots in death-match.
Generally, `Level.WorldDone` should be called directly after this.
- `Start`
@ -354,44 +354,44 @@ class StatusScreen : Object abstract play
- `DrawNoState`
Called by `Drawer` when `CurState` is `NoState` or any other non-state.
Called by `Drawer` when `CurState` is `NOSTATE` or any other non-state.
- `DrawShowNextLoc`
Called by `Drawer` when `CurState` is `ShowNextLoc` and, by default,
`DrawNoState` after setting `SNL_PointerOn` to `true`.
Called by `Drawer` when `CurState` is `SHOWNEXTLOC` and, by default,
`DrawNoState` after setting `Snl_PointerOn` to `true`.
- `DrawStats`
Called by `Drawer` directly after drawing the animated background when
`CurState` is `StatCount`.
`CurState` is `STATCOUNT`.
- `InitNoState`
Called by `UpdateShowNextLoc` to initiate the `NoState` stage.
Called by `UpdateShowNextLoc` to initiate the `NOSTATE` stage.
- `InitShowNextLoc`
Called by `UpdateStats` to initiate the `ShowNextLoc` stage.
Called by `UpdateStats` to initiate the `SHOWNEXTLOC` stage.
- `InitStats`
Called by `Start` to initiate the `StatCount` stage.
Called by `Start` to initiate the `STATCOUNT` stage.
- `UpdateNoState`
Called by `Ticker` when `CurState` is `NoState` or any other non-state.
Called by `Ticker` when `CurState` is `NOSTATE` or any other non-state.
Exits the intermission by calling `End` and `Level.WorldDone` when
appropriate.
- `UpdateShowNextLoc`
Called by `Ticker` when `CurState` is `ShowNextLoc`. Runs `InitNoState` when
appropriate and alternates `SNL_PointerOn`.
Called by `Ticker` when `CurState` is `SHOWNEXTLOC`. Runs `InitNoState` when
appropriate and alternates `Snl_PointerOn`.
- `UpdateStats`
Called by `Ticker` when `CurState` is `StatCount`. Runs `InitShowNextLoc`
Called by `Ticker` when `CurState` is `STATCOUNT`. Runs `InitShowNextLoc`
when appropriate.
- `CheckForAccelerate`

8
api-level-Line.md
View File

@ -38,9 +38,9 @@ struct Line play
clearscope int GetHealth();
void SetHealth(int newhealth);
double GetUDMFFloat(name nm);
int GetUDMFInt(name nm);
string GetUDMFString(name nm);
double GetUdmfFloat(name nm);
int GetUdmfInt(name nm);
string GetUdmfString(name nm);
}
```
@ -171,7 +171,7 @@ struct Line play
TODO
- `GetUDMFFloat`, `GetUDMFInt`, `GetUDMFString`
- `GetUdmfFloat`, `GetUdmfInt`, `GetUdmfString`
Gets a named UDMF property attached to this linedef.

6
api-level-Sector.md
View File

@ -185,9 +185,9 @@ struct Sector play
clearscope int GetHealth(SectorPart part);
void SetHealth(SectorPart part, int newhealth);
double GetUDMFFloat(name nm);
int GetUDMFInt(name nm);
string GetUDMFString(name nm);
double GetUdmfFloat(name nm);
int GetUdmfInt(name nm);
string GetUdmfString(name nm);
}
```

8
api-level-Side.md
View File

@ -55,9 +55,9 @@ struct Side play
void EnableAdditiveColor(int tier, bool enable);
double GetUDMFFloat(name nm);
int GetUDMFInt(name nm);
string GetUDMFString(name nm);
double GetUdmfFloat(name nm);
int GetUdmfInt(name nm);
string GetUdmfString(name nm);
}
```
@ -129,7 +129,7 @@ struct Side play
TODO
- `GetUDMFFloat`, `GetUDMFInt`, `GetUDMFString`
- `GetUdmfFloat`, `GetUdmfInt`, `GetUdmfString`
Gets a named UDMF property attached to this sidedef.

8
api.md
View File

@ -194,10 +194,10 @@ object. Generally these are utility functions.
<!-- inter-toc global-type -->
* [DEHInfo](api-global-DEHInfo.md)
* [FOptionMenuSettings](api-global-FOptionMenuSettings.md)
* [GameInfoStruct](api-global-GameInfoStruct.md)
* [LevelLocals](api-global-LevelLocals.md)
* [DehInfo](api-global-type-DehInfo.md)
* [FOptionMenuSettings](api-global-type-FOptionMenuSettings.md)
* [GameInfoStruct](api-global-type-GameInfoStruct.md)
* [LevelLocals](api-global-type-LevelLocals.md)
<!-- end -->

46
glossary-Versions.md
View File

@ -50,7 +50,7 @@ Here is a list of differences between ZScript versions.
- Added `PlayerPawn::CheckCrouch`.
- Added `PlayerPawn::CheckDegeneration`.
- Added `PlayerPawn::CheckEnvironment`.
- Added `PlayerPawn::CheckFOV`.
- Added `PlayerPawn::CheckFov`.
- Added `PlayerPawn::CheckFrozen`.
- Added `PlayerPawn::CheckJump`.
- Added `PlayerPawn::CheckMoveUpDown`.
@ -89,7 +89,7 @@ Here is a list of differences between ZScript versions.
- Added `+DYNAMICLIGHT.SUBTRACTIVE`.
- Added `+ZDOOMTRANS`.
- Added `Actor::A_SoundVolume`.
- Added `Actor::CameraFOV`.
- Added `Actor::CameraFov`.
- Added `Actor::CheckPortalTransition`.
- Added `Actor::FloatBobStrength`.
- Added `Actor::RenderHidden`.
@ -163,14 +163,14 @@ Here is a list of differences between ZScript versions.
- Added `LevelLocals::PixelStretch`.
- Added `LevelLocals::Vec2Diff`.
- Added `LevelLocals::Vec3Diff`.
- Added `SKILLP_PlayerRespawn`.
- Added `SKILLP_PLAYERRESPAWN`.
- Added `Screen::DrawLine`.
- Added `alpha2` parameter to `Actor::A_SetBlend`.
- Changed `Thinker::Tics2Seconds`' logic.
## Version 3.3.0
- Added `Actor::ACS_ScriptCall`.
- Added `Actor::Acs_ScriptCall`.
- Added `Actor::Distance2DSquared`.
- Added `Actor::Distance3DSquared`.
- Added `Actor::FriendlySeeBlocks`.
@ -182,14 +182,14 @@ Here is a list of differences between ZScript versions.
- Added `BaseStatusBar::DetachAllMessages`.
- Added `BaseStatusBar::DetachMessageID`.
- Added `BaseStatusBar::DetachMessage`.
- Added `BaseStatusBar::EHUDMSGLayer`.
- Added `BaseStatusBar::EHudMsgLayer`.
- Added `CHAN_LOOP`.
- Added `DynamicLight::SpotInnerAngle`.
- Added `DynamicLight::SpotOuterAngle`.
- Added `ETrace*`, `ELineTier`, `ELineTraceFlags`.
- Added `FLineTargetData`.
- Added `HudMessageBase`.
- Added `Inventory::AltHUDIcon`.
- Added `Inventory::AltHudIcon`.
- Added `LevelLocals::ChangeSky`.
- Added `LevelLocals::GetChecksum`.
- Added `LevelLocals::SkySpeed1`.
@ -235,19 +235,19 @@ Here is a list of differences between ZScript versions.
- Added `Line::Activate`.
- Added `Line::RemoteActivate`.
- Added `SPAC`.
- Added `Spac`.
## Version 3.4.0
- Added "`internal`" keyword.
- Added `Actor::OnGiveSecret`.
- Added `DTA_Color`.
- Added `DTA_Desaturate`.
- Added `DTA_FlipY`.
- Added `DTA_SrcHeight`.
- Added `DTA_SrcWidth`.
- Added `DTA_SrcX`.
- Added `DTA_SrcY`.
- Added `DTA_COLOR`.
- Added `DTA_DESATURATE`.
- Added `DTA_FLIPY`.
- Added `DTA_SRCHEIGHT`.
- Added `DTA_SRCWIDTH`.
- Added `DTA_SRCX`.
- Added `DTA_SRCY`.
- Added `LevelLocals::Vec2OffsetZ`.
- Added `LevelLocals::Vec2Offset`.
- Added `LevelLocals::Vec3Offset`.
@ -354,7 +354,7 @@ Here is a list of differences between ZScript versions.
- Added `EChangeLevelFlags`.
- Added `EFinishLevelType`.
- Added `EPlayerGender`.
- Added `FLineTraceData::TRACE_HasHitSky`.
- Added `FLineTraceData::TRACE_HASHITSKY`.
- Added `FRailParams`.
- Added `Font::GetBottomAlignOffset`.
- Added `GameInfoStruct::BerserkPic`.
@ -418,7 +418,7 @@ Here is a list of differences between ZScript versions.
- Added `PlayerPawn::TeleportFreezeTime`.
- Added `PlayerPawn::UndoPlayerMorph`.
- Added `RadiusDamageFlags`.
- Added `SKILLP_KickBackFactor`.
- Added `SKILLP_KICKBACKFACTOR`.
- Added `ScriptUtil`.
- Added `SecActDamage3D`.
- Added `SecActDamageCeiling`.
@ -435,12 +435,12 @@ Here is a list of differences between ZScript versions.
- Added `Sector::SECF_NOATTACK`.
- Added `Sector::SetAdditiveColor`.
- Added `Sector::SetHealth`.
- Added `SectorAction::SECSPAC_Damage3D`.
- Added `SectorAction::SECSPAC_DamageCeiling`.
- Added `SectorAction::SECSPAC_DamageFloor`.
- Added `SectorAction::SECSPAC_Death3D`.
- Added `SectorAction::SECSPAC_DeathCeiling`.
- Added `SectorAction::SECSPAC_DeathFloor`.
- Added `SectorAction::SECSPAC_DAMAGE3D`.
- Added `SectorAction::SECSPAC_DAMAGECEILING`.
- Added `SectorAction::SECSPAC_DAMAGEFLOOR`.
- Added `SectorAction::SECSPAC_DEATH3D`.
- Added `SectorAction::SECSPAC_DEATHCEILING`.
- Added `SectorAction::SECSPAC_DEATHFLOOR`.
- Added `SectorPart`.
- Added `Side::EnableAdditiveColor`.
- Added `Side::GetAdditiveColor`.
@ -451,7 +451,7 @@ Here is a list of differences between ZScript versions.
- Added `State::InStateSequence`.
- Added `StaticEventHandler::WorldLineDamaged`.
- Added `StaticEventHandler::WorldSectorDamaged`.
- Added `TRACE_HasHitSky`.
- Added `TRACE_HASHITSKY`.
- Added `Vertex::Index`.
- Added `Weapon::CheckAddToSlots`.
- Added `Weapon::DoReadyWeaponDisableSwitch`.

2
lang-Types.md
View File

@ -158,7 +158,7 @@ type names. Strings are implicitly cast to names.
Names can be converted to `int` with an explicit cast, and the negative of
`int(name())` may be used to create an integer representation of a string
usable by action specials, most prominently `ACS_NamedExecute`.
usable by action specials, most prominently `Acs_NamedExecute`.
# Colors