Added support for ToggleCollision, Cosmetic_SkellyZagreusStatue

Author: NikkelM

CHANGELOG.md

@@ -1,11 +1,16 @@
 # Changelog
 
-## v1.0.2
+## v1.0.3
 
 <!--Releasenotes start-->
-- Fixed potential issues with modded and vanilla cosmetics being equipped at the same time if the mod was temporarily disabled and the player returns from a Chaos Trial.
+- Added `ToggleCollision` property.
+- Added vanilla `SetAnimationValue` for `Cosmetic_SkellyZagreusStatue`. 
 <!--Releasenotes end-->
 
+## v1.0.2
+
+- Fixed potential issues with modded and vanilla cosmetics being equipped at the same time if the mod was temporarily disabled and the player returns from a Chaos Trial.
+
 ## v1.0.1
 
 - The default `RevealReactionVoiceLines` have been updated to include more varied voicelines by Melinoë.

README.md

@@ -85,6 +85,7 @@ CosmeticsAPI.RegisterCosmetic({
 	SetAnimationIds = nil,
 	ActivateIds = nil,
 	DeactivateIds = nil,
+	ToggleCollision = nil,
 	ActivateFunctionName = nil,
 	OnRevealFunctionName = nil,
 	PanDuration = 1,

src/Scripts/CosmeticsAPI.lua

@@ -201,6 +201,14 @@ public.RegisterCosmetic = function(cosmeticData)
 	end
 	-- #endregion
 
+	-- #region ToggleCollision
+	if cosmeticData.ToggleCollision ~= nil and type(cosmeticData.ToggleCollision) == "boolean" then
+		newGameCosmetic.ToggleCollision = cosmeticData.ToggleCollision
+	elseif cosmeticData.ToggleCollision ~= nil then
+		mod.WarnIncorrectType("ToggleCollision", "boolean", type(cosmeticData.ToggleCollision), cosmeticData.Id)
+	end
+	-- #endregion
+
 	-- #region CosmeticsGroup
 	-- Validate the cosmetic that the group points to exists
 	if game.WorldUpgradeData[cosmeticData.CosmeticsGroup] == nil then

src/Scripts/Utils.lua

@@ -1,6 +1,6 @@
 -- Add the base cosmetic overrides for vanilla cosmetics here
 -- You can most often get the SetAnimationValue from the Game/Obstacles/Crossroads.sjson file
--- Most obstacles in this file are named "Crossroads<Cosmetic name without "Cosmetic_" prefix>01"
+-- Most obstacles in this file are named "Crossroads<Cosmetic name without 'Cosmetic_' prefix>01"
 -- The SetAnimationValue we need is the "Thing.Graphic" of the obstacle, NOT the obstacle name itself
 -- Some cosmetics may require additional overrides to work correctly with modded cosmetics, you can add them here as well
 -- This is e.g. the case if the vanilla cosmetic defines ActivateIds, which would all get set to the new SetAnimationValue if no separate SetAnimationIds table is provided
@@ -23,9 +23,12 @@ mod.KnownExtraDecorBaseAnimations = {
 	-- #region CosmeticsShop_Taverna
 	Cosmetic_TavernaStarMosaic = {
 		SetAnimationValue = "Tilesets\\Crossroads\\Crossroads_Terrain_Taverna_Mosaic_01",
-	}
+	},
 	-- #endregion
 	-- #region CosmeticsShop_PreRun
+	Cosmetic_SkellyZagreusStatue = {
+		SetAnimationValue = "Tilesets\\Crossroads\\Crossroads_Skelly_ZagreusStatue_01",
+	},
 	-- #endregion
 }
 

src/def.lua

@@ -27,7 +27,7 @@ local public = {}
 ---@field ActivateIds table|nil Which ObjectIds to activate when this cosmetic is equipped. The camera will pan to the first ID in this table if CameraFocusId is not set. Note: There is no validation on this field, so ensure the IDs exist.
 ---@field DeactivateIds table|nil Which ObjectIds to deactivate when this cosmetic is equipped. Note: There is no validation on this field, so ensure the IDs exist.
 -- ---@field ActivateRoomObstacleIds table|nil Which RoomObstacleIds to activate when this cosmetic is equipped. Cannot be set if SetAnimationIds or ActivateIds are set. The camera will pan to the first ID in this table if CameraFocusId is not set. Not used for the API. Note: There is no validation on this field, so ensure the IDs exist.
--- ---@field ToggleCollision boolean|nil If true, toggles collision for the activated/deactivated objects when this cosmetic is equipped. Only used if ActivateRoomObstacleIds is set. Defaults to true. Not used for the API.
+---@field ToggleCollision boolean|nil If true, toggles collision for the activated/deactivated objects when this cosmetic is equipped. Should be the same as for the base cosmetic you're adding an alternative to in most cases. Defaults to nil.
 -- ---@field ToggleShadows boolean|nil If true, toggles shadows for the activated/deactivated objects when this cosmetic is equipped. Only used if ActivateRoomObstacleIds is set. Defaults to true. Not used for the API.
 ---@field ActivateFunctionName string|nil The name of a function to call whenever the cosmetic is equipped. You can use <_PLUGIN.guid .. "." .. "YourModFunctionName"> to reference a function in your mod's namespace. If nil, no function is called.
 ---@field OnRevealFunctionName string|nil The name of a function to call after the cosmetic is revealed, but before the camera pans back to Melinoe. You can use <_PLUGIN.guid .. "." .. "YourModFunctionName"> to reference a function in your mod's namespace. If nil, no function is called.