Differences

This shows you the differences between two versions of the page.

--- custom-building-function [2022/04/29 20:44] – minotorious
+++ custom-building-function [2022/04/29 20:48] – minotorious
@@ Line 27: / Line 27: @@
 ''reloadBuildingFunction'' is called upon save game loading. This function usually serves as a back-call to the ''activateBuilding'' function to ensure any necessities are present and initialised after a reload.
-''removeBuildingFunction'' is called when a [[api/building_function|BUILDING_FUNCTION]] is manually unassigned by the player. This function is used to remove components or other elements that should no longer be present once the function is removed from the [[api/building_part|BUILDING_PART]].
+''removeBuildingFunction'' is called when a [[api/building_function|BUILDING_FUNCTION]] is manually unassigned by the player. This function is used to remove components or other elements that should no longer be present once the function is removed from the [[api/building_part|BUILDING_PART]]. **Note:** This is not necesary for non-assignable [[api/building_function|BUILDING_FUNCTION]]s as when a [[api/building_part|BUILDING_PART]] is destroyed everything related to it is also destroyed and their finalisation functions are called automatically.
 For example below we set up a function that upon activation logs its properties and upon reload executes a back-call to its activation function.
 <code lua>
-function BUILDING_FUNCTION_ROOF_TOGGLE:activateBuilding(gameObject)
+function MY_BUILDING_FUNCTION:activateBuilding(gameObject)
     mod:log("Property1: " .. tostring(self.Property1))
     mod:log("Property2: " .. tostring(self.Property2))
@@ Line 37: / Line 37: @@
 end
-function BUILDING_FUNCTION_ROOF_TOGGLE:reloadBuildingFunction(gameObject)
+function MY_BUILDING_FUNCTION:reloadBuildingFunction(gameObject)
     self:activateBuilding(gameObject)
 end