Grimrock

wagtunes wrote: ↑Mon May 10, 2021 12:26 amNow I have to study this function so I can understand why and how it works.

function destroySpecialPotion(self) 											 --self is the object that called; in this case it is the alcove object.
	local alcove = self															 --relabeled self to alcove; just preference, self could be used directly.
	potionName = "potion_rage" --"potionunlocking" 								 --user defined potion name; no need to edit the IF block code to change names.
	
	if type(alcove) == "table" and string.match(alcove.name,"alcove") then   	 --tests that calling object is a table with "alcove" somewhere in its .name field.
		for itm in alcove:containedItems() do									 --{The alcove's contained items iterator}
																				 --An iterator returns then next object on its internal list when called.
																				 --The FOR loop repeats until the end of the list, or until told to exit/return. 					
			if itm.name == potionName then 										 --compares name of the current itm (item/object); continues if it matches the potionName.  
											
				--optional effects   
					local effect = spawn("fx",itm.level,itm.x,itm.y,itm.facing)  --spawns fx object at the itm object's location.
						effect:translate(0,1.3,0)								 --raises the fx object's position to approximate height of the alcove shelf.
						effect:setParticleSystem("blob")						 --sets the fx object's particle system to type "blob".
						effect:setLight(0, 0, 1, 1000, 2, .5, true)				 --sets the fx object's light to a shade of blue. (R,G,B,...)
						playSound("goromorg_shield_hit")						 --plays the sound used when the goromorg's shield is attacked.
				--/optional effects
						
				itm:destroy()													 --destroys the itm object; only when it is the named potion.
			end	
		end	
	end	
end

Isaac wrote: ↑Mon May 10, 2021 12:48 am

wagtunes wrote: ↑Mon May 10, 2021 12:26 amNow I have to study this function so I can understand why and how it works.

SpoilerShow

Code: Select all

function destroySpecialPotion(self) 											 --self is the object that called; in this case it is the alcove object.
	local alcove = self															 --relabeled self to alcove; just preference, self could be used directly.
	potionName = "potion_rage" --"potionunlocking" 								 --user defined potion name; no need to edit the IF block code to change names.
	
	if type(alcove) == "table" and string.match(alcove.name,"alcove") then   	 --tests that calling object is a table with "alcove" somewhere in its .name field.
		for itm in alcove:containedItems() do									 --{The alcove's contained items iterator}
																				 --An iterator returns then next object on its internal list when called.
																				 --The FOR loop repeats until the end of the list, or until told to exit/return. 					
			if itm.name == potionName then 										 --compares name of the current itm (item/object); continues if it matches the potionName.  
											
				--optional effects   
					local effect = spawn("fx",itm.level,itm.x,itm.y,itm.facing)  --spawns fx object at the itm object's location.
						effect:translate(0,1.3,0)								 --raises the fx object's position to approximate height of the alcove shelf.
						effect:setParticleSystem("blob")						 --sets the fx object's particle system to type "blob".
						effect:setLight(0, 0, 1, 1000, 2, .5, true)				 --sets the fx object's light to a shade of blue. (R,G,B,...)
						playSound("goromorg_shield_hit")						 --plays the sound used when the goromorg's shield is attacked.
				--/optional effects
						
				itm:destroy()													 --destroys the itm object; only when it is the named potion.
			end	
		end	
	end	
end

Isaac wrote: ↑Mon May 10, 2021 3:22 am Yes.

Here is a revised version that checks the object class type. LoG1 objects only have one class; unlike LoG2 objects... so it makes more sense in LoG1 to check the class type instead of the arbitrary object name. Now it works with altars as well.

SpoilerShow

Code: Select all

function destroySpecialPotion(self) 												 --self is the object that called; in this case it is the alcove object.
	local alcove = self																 --relabled self to alcove; just preference, self could be used directly.
	potionName = "potion_rage" --"potionunlocking" 								 	 --user defined potion name; no need to edit the IF block code.

	if type(alcove) == "table" then   	
		if alcove.class == "Alcove" or alcove.class == "Altar" then				 	 --tests that calling object is of proper object class.
		
			for itm in alcove:containedItems() do									 --{The alcove's contained items iterator}
																					 --An iterator returns then next object on its internal list when called.
																					 --The FOR loop repeats until the end of ther list, or until told to exit/return. 					
				if itm.name == potionName then 										 --compares name of the current itm (item/object); continues if it matches the potionName.  
												
					--optional effects   
						local effect = spawn("fx",itm.level,itm.x,itm.y,itm.facing)  --spawns fx object at the itm object's location.
							effect:translate(0,1.3,0)								 --raises the fx objects position to match the alcove shelf.
							effect:setParticleSystem("blob")						 --sets the fx object's particle system to type "blob".
							effect:setLight(0, 0, 1, 1000, 2, .5, true)				 --sets the fx object's light to a shade of blue. (R,G,B,...)
							playSound("goromorg_shield_hit")						 --plays the sound used when the goromorg's shield is attacked.
					--/optional effects
							
					itm:destroy()													 --destroys the itm object; only when it is the named potion.
				end	
			end
		end		
	end	
end

Isaac wrote: ↑Mon May 10, 2021 3:22 am Here is a revised version that checks the object class type. LoG1 objects only have one class; unlike LoG2 objects... so it makes more sense in LoG1 to check the class type instead of the arbitrary object name. Now it works with altars as well.

Zo Kath Ra wrote: ↑Mon May 10, 2021 12:41 pm

Isaac wrote: ↑Mon May 10, 2021 3:22 am Here is a revised version that checks the object class type. LoG1 objects only have one class; unlike LoG2 objects... so it makes more sense in LoG1 to check the class type instead of the arbitrary object name. Now it works with altars as well.

I'd add a return statement after itm:destroy()

It's not necessary to continue iteration, and I don't think you're supposed to, because you've modified the list of contained items.

wagtunes wrote: ↑Mon May 10, 2021 2:27 pmBut when you don't know what the commands are or what arguments they require, it makes coding a royal PITA.

Isaac wrote: ↑Mon May 10, 2021 2:41 pm

wagtunes wrote: ↑Mon May 10, 2021 2:27 pmBut when you don't know what the commands are or what arguments they require, it makes coding a royal PITA.

LoG2 scripting is better documented, and more powerful. The principle difference is that object class has become modular with components; each one having its own class. An LoG2 object can have multiple components that affect its behavior and features. LoG2 components can even be added, or removed at runtime.

Also they usually have getter/setter functions that allow checking, and changing internal values; things that for LoG1 would require custom object definitions for each variation.