add SpriteConstants

This commit is contained in:
davidmarr 2024-11-28 13:35:50 +01:00
parent 89c27fc19d
commit 96663d5646
2 changed files with 37 additions and 4 deletions

View file

@ -49,7 +49,7 @@ namespace TEN::Scripting::DisplaySprite
/// Create a DisplaySprite object.
// @function DisplaySprite()
// @tparam Objects.ObjID ID of the sprite sequence object.
// @tparam Objects.ObjID.SpriteConstants ID of the sprite sequence object.
// @tparam int int spriteID ID of the sprite in the sequence.
// @tparam Vec2 pos Display position in percent.
// @tparam float rot Rotation in degrees.
@ -75,7 +75,7 @@ namespace TEN::Scripting::DisplaySprite
/// Get the object ID of the sprite sequence object used by the display sprite.
// @function DisplaySprite:GetObjectID()
// @treturn Objects.ObjID Sprite sequence object ID.
// @treturn Objects.ObjID.SpriteConstants Sprite sequence object ID.
GAME_OBJECT_ID ScriptDisplaySprite::GetObjectID() const
{
return _objectID;
@ -122,8 +122,8 @@ namespace TEN::Scripting::DisplaySprite
}
/// Set the sprite sequence object ID used by the display sprite.
// @function DisplaySprite:SetObjectID(Objects.ObjID)
// @tparam Objects.ObjID New sprite sequence object ID.
// @function DisplaySprite:SetObjectID(Objects.ObjID.SpriteConstants)
// @tparam Objects.ObjID.SpriteConstants New sprite sequence object ID.
void ScriptDisplaySprite::SetObjectID(GAME_OBJECT_ID objectID)
{
_objectID = objectID;

View file

@ -1197,6 +1197,39 @@ Table of constants.
@table PickupConstants
*/
/*** Objects.ObjID sprite constants.
The following ObjID members refer to sprites.
Table of constants:
SKY_GRAPHICS
DEFAULT_SPRITES
MISC_SPRITES
CUSTOM_SPRITES
FIRE_SPRITES
SMOKE_SPRITES
SPARK_SPRITE
DRIP_SPRITE
EXPLOSION_SPRITES
MOTORBOAT_FOAM_SPRITES
RUBBER_BOAT_WAVE_SPRITES
SKIDOO_SNOW_TRAIL_SPRITES
KAYAK_PADDLE_TRAIL_SPRITE
KAYAK_WAKE_SPRTIES
BINOCULAR_GRAPHIC
LASER_SIGHT_GRAPHIC
CAUSTICS_TEXTURES
BAR_BORDER_GRAPHIC
HEALTH_BAR_TEXTURE
AIR_BAR_TEXTURE
DASH_BAR_TEXTURE
SFX_BAR_TEXTURE
SPEEDOMETER
CUSTOM_BAR_GRAPHIC
CUSTOM_AMMO_GRAPHIC
@table SpriteConstants
*/
static const std::unordered_map<std::string, GAME_OBJECT_ID> kObjIDs {
{ "LARA", ID_LARA },
{ "LARA_EXTRA_ANIMS", ID_LARA_EXTRA_ANIMS },