69 lines
2.1 KiB
Markdown
69 lines
2.1 KiB
Markdown
# SRB2Kart Saturn: Custom lua features
|
|
|
|
## mobj.localskin and player.localskin fields
|
|
|
|
Allow reading and assigning localskins.
|
|
|
|
## mobj.rollsum field
|
|
|
|
**Not netsafe**. Returns total sprite rotation value, taking sliptideroll and sloperoll cvars value into account.
|
|
Mainly for use in visual-only addons like secondcolor.
|
|
|
|
## player.sliproll field
|
|
|
|
**Not netsafe**. Returns player's current sliptide roll angle, taking sliptideroll cvar value into account.
|
|
|
|
## hud.setVoteBackground(name)
|
|
|
|
Changes vote background texture prefix (game looks for PREFIX + "W" or "C" (depends on resolution) + FRAME\_NUMBER).
|
|
|
|
## hud.add(fn, "vote") and hud.add(fn, "intermission")
|
|
|
|
Hud hooks for vote screen and intermission screen. They only get drawer (`v`) as argument.
|
|
To check if those hooks are available, check if globals FEATURE\_VOTEHUD and FEATURE\_INTERMISSIONHUD
|
|
exist.
|
|
|
|
## x, y = hud.getOffsets(item)
|
|
|
|
Returns the values of the given HUD item's `xoffset`/`yoffset` cvars.
|
|
Available for any HUD item with offset cvars.
|
|
|
|
## x, y, flags = v.getDrawInfo(item)
|
|
|
|
Returns the X, Y and flags where the given HUD item will be drawn for the current displayplayer.
|
|
Available for `item`, `gametypeinfo` and `minimap`.
|
|
|
|
## patch, colormap = v.getColorHudPatch(item)
|
|
|
|
Returns the patch and colormap to use for the given HUD item. Colorization is based on the user's settings.
|
|
Available for `item` and `itemmul`.
|
|
Extra arguments for some items:
|
|
### item
|
|
* `small`: true for small item box, false for big item box.
|
|
* `dark`: true to darken item box. Depends on `darkitembox`.
|
|
### itemmul
|
|
* `small`: true for small sticker, false for big sticker.
|
|
|
|
## hudcolor = v.getHudColor()
|
|
|
|
Returns the displayplayer's HUD color.
|
|
|
|
## colorize = v.useColorHud()
|
|
|
|
Returns true if colorization is enabled, false otherwise.
|
|
|
|
## mobj.spritexscale, mobj.spriteyscale, mobj.spritexoffset, mobj.spriteyoffset, mobj.rollangle, mobj.sloperoll, mobj.rollmodel fields
|
|
|
|
Same fields as in SRB2 2.2
|
|
|
|
## S\_StopSoundByNum
|
|
|
|
Allows stopping specific sound globally. Because this function starts with S\_, like state, checking
|
|
if it exists is a bit more complicated:
|
|
|
|
```lua
|
|
if rawget(_G, "S_StopSoundByNum") ~= nil then
|
|
... -- Can use it
|
|
end
|
|
```
|