Inventory - Revision history

Frost Salamander: /* Definitions */

2024-04-07T11:07:48Z

Definitions

← Older revision		Revision as of 11:07, 7 April 2024
Line 5:		Line 5:
	The spawnargs can be either set in the def file as a default, or in the map file to override settings for specific entities. Naturaly this also means that they can be manipulated by scripts as well.		The spawnargs can be either set in the def file as a default, or in the map file to override settings for specific entities. Naturaly this also means that they can be manipulated by scripts as well.

	'''IMPORTANT!''' ~~Normally~~ items ~~will vanish from the map as soon as the item is successfully~~ put into the ~~inventory~~. If this doesn't work, then the item will stay visible. This is a intentionally so, to make the mapper aware of the problem. Check the console and/or enable the inventory logclass in the darkmod.log file to see what went wrong.		'''IMPORTANT!''' When items are put into inventory they remain in the map in their original location, but are hidden and will therefore 'disappear'. If this doesn't work, then the item will stay visible. This is a intentionally so, to make the mapper aware of the problem. Check the console and/or enable the inventory logclass in the darkmod.log file to see what went wrong.

	There are several terms and types of items that can be used in the inventory:		There are several terms and types of items that can be used in the inventory:

Geep: /* Custom HUDs */

2022-09-07T15:26:06Z

Custom HUDs

← Older revision		Revision as of 15:26, 7 September 2022
Line 199:		Line 199:
	# First off, you need an entityDef with your inventory item. Look at <tt>atdm:playertools_compass</tt> for an example.		# First off, you need an entityDef with your inventory item. Look at <tt>atdm:playertools_compass</tt> for an example.
	# Your inventory item entity needs to have its own script object, so you'll need to name that in your entityDef using the "scriptobject" spawnarg.		# Your inventory item entity needs to have its own script object, so you'll need to name that in your entityDef using the "scriptobject" spawnarg.
	# The scriptobject (which will be defined in a .script file) needs to implement a small set functions which are invoked by the code when the item is initialised, selected or de-selected.		# The scriptobject (which will be defined in a .script file) needs to implement a small set of functions which are invoked by the code when the item is initialised, selected or de-selected.

	=== Set up the entityDef ===		=== Set up the entityDef ===

Geep: Add "Extra - Adding a Custom GUI..." section, tweak "Set up a custom GUI..." section

2022-09-07T15:24:05Z

Add "Extra - Adding a Custom GUI..." section, tweak "Set up a custom GUI..." section

← Older revision		Revision as of 15:24, 7 September 2022
Line 262:		Line 262:

	===Set up a custom GUI if needed===		===Set up a custom GUI if needed===
	As mentioned above, you can define key ''inv_hud'' to point to a custom .gui file. For example, ~~details about~~ the special ~~treatment for the~~ compass GUI is ~~contained~~ in [[GUI Scripting: RenderDef]]. Also, starting in TDM 2.06, there are a richer set of user settings that affect inventory HUD displays. If your custom item provides its own GUI, consider incorporating these (e.g., "gui::HUD_Opacity", "gui::smallTextSize"). For examples, see tdm_hud.gui, tdm_inv.gui, or tdm_loot.gui in tdm_gui01.pk4\guis\.		As mentioned above, you can define key ''inv_hud'' to point to a custom .gui file. For example, the special compass GUI is further considered in conjunction with its implementing architecture in [[GUI Scripting: RenderDef]]. Also, starting in TDM 2.06, there are a richer set of user settings that affect inventory HUD displays. If your custom item provides its own GUI, consider incorporating these (e.g., "gui::HUD_Opacity", "gui::smallTextSize"). For examples, see the "Extra: Adding a Custom GUI" section at this article's end, or contents of files tdm_hud.gui, tdm_inv.gui, or tdm_loot.gui in tdm_gui01.pk4\guis\.

	== Setting up Weapons ==		== Setting up Weapons ==
Line 389:		Line 389:

	''If you want skull-on-altar to satisfy an objective, additional coding and/or location-detection will need to be added.''		''If you want skull-on-altar to satisfy an objective, additional coding and/or location-detection will need to be added.''

			===Extra: Adding a Custom GUI===
			Suppose you wanted to extend this example, to make the skull inventory icon pulse with color? You could do this with a custom GUI, explained in [[GUI Scripting: Inventory Icon Example]]. This also provides a inventory script object, that could serve as a template for use in other projects; it may be of more general use that the compass script object. Plus, more about using global and local GUI::Parameters in this context.

	[[Category:Editing]]		[[Category:Editing]]

Geep: /* How to make inventory items to interact with world objects */ comments about skull drop, objective-satistfaction

2022-08-27T15:58:31Z

How to make inventory items to interact with world objects: comments about skull drop, objective-satistfaction

← Older revision		Revision as of 15:58, 27 August 2022
Line 290:		Line 290:
	* The gamer knows that somewhere in the map, there's a skull that must be placed on an altar.		* The gamer knows that somewhere in the map, there's a skull that must be placed on an altar.
	* When the skull is found, frobbing it puts it into the inventory.		* When the skull is found, frobbing it puts it into the inventory.
	* Later, ~~frobbing~~ the pedestal altar appears to transfer the skull from inventory to atop the altar. (Behind the scene, there are 2 skulls involved: the custom entity dropped from inventory, and a hidden one prepositioned on the altar.)		* Later, either:
			** frob the pedestal altar, which appears to instantly transfer the skull from inventory to atop the altar. (Behind the scene, there are 2 skulls involved: the custom entity dropped from inventory, and a hidden one prepositioned on the altar.)
			** drop the skull into your hands (R key), move it above the altar, and drop it there (R key again). (Altar remains frobbable after this, but frobbing does nothing.)

	This requires a custom set up for an inventory item you would like the player to use_on_frob when highlighting an object in the world. (While the scenario in this example is placing a skull on a pedestal, there are many different uses/scenarios. There are also several ways to do this. Check out http://wiki.thedarkmod.com/index.php?title=Tool,_Key,_custom_used_by_inventory_actions for another method.)		This requires a custom set up for an inventory item you would like the player to use_on_frob when highlighting an object in the world. (While the scenario in this example is placing a skull on a pedestal, there are many different uses/scenarios. There are also several ways to do this. Check out http://wiki.thedarkmod.com/index.php?title=Tool,_Key,_custom_used_by_inventory_actions for another method.)
Line 385:		Line 387:

	3. Place a func_static of the item's model on the altar and set spawnarg "hide 1". Have the altar target the func_static and it will appear, giving the illusion it was placed there.		3. Place a func_static of the item's model on the altar and set spawnarg "hide 1". Have the altar target the func_static and it will appear, giving the illusion it was placed there.

			''If you want skull-on-altar to satisfy an objective, additional coding and/or location-detection will need to be added.''

	[[Category:Editing]]		[[Category:Editing]]

Geep: /* How to make inventory items to interact with world objects */ Revise intro, change skull spawnarg "hidden 0" to "hide 1"

2022-08-27T00:47:53Z

How to make inventory items to interact with world objects: Revise intro, change skull spawnarg "hidden 0" to "hide 1"

← Older revision		Revision as of 00:47, 27 August 2022
Line 287:		Line 287:
	Kingsal has reported how to use inventory items on items frob-highlighted in the game world. The report is here: http://forums.thedarkmod.com/topic/18505-script-for-placing-the-right-object-in-the-right-place/?p=397333		Kingsal has reported how to use inventory items on items frob-highlighted in the game world. The report is here: http://forums.thedarkmod.com/topic/18505-script-for-placing-the-right-object-in-the-right-place/?p=397333

	This is a custom set up for an inventory item you would like the player to use_on_frob when highlighting an object in the world. ~~The~~ scenario in this example is placing a skull on a pedestal, ~~but~~ there are many different uses/ scenarios. There are several ways to do this. Check out http://wiki.thedarkmod.com/index.php?title=Tool,_Key,_custom_used_by_inventory_actions for another method.		Consider this scenario:
			* The gamer knows that somewhere in the map, there's a skull that must be placed on an altar.
			* When the skull is found, frobbing it puts it into the inventory.
			* Later, frobbing the pedestal altar appears to transfer the skull from inventory to atop the altar. (Behind the scene, there are 2 skulls involved: the custom entity dropped from inventory, and a hidden one prepositioned on the altar.)

			This requires a custom set up for an inventory item you would like the player to use_on_frob when highlighting an object in the world. (While the scenario in this example is placing a skull on a pedestal, there are many different uses/scenarios. There are also several ways to do this. Check out http://wiki.thedarkmod.com/index.php?title=Tool,_Key,_custom_used_by_inventory_actions for another method.)

	You will need the def files and script file below.		You will need the def files and script file below.
Line 293:		Line 298:
	This assumes you have basic knowledge of creating .def files and .scripts. If not. PM me (kingsal) for help.		This assumes you have basic knowledge of creating .def files and .scripts. If not. PM me (kingsal) for help.

	Def ~~files.~~ Place this in your def file.		===Def File===
			Place this in your def file.
	~~//++++++++++++++++++++++++Use Inventory Item++++++++++++++++++++++++++++++~~
	~~// The inventory_use_item's "inv_name" spawnarg MUST match the "item_name" spawnarg on the Altar~~.

			//++++++++++++++++++++++++Use Inventory Item++++++++++++++++++++++++++++++
			// The inventory_use_item's "inv_name" spawnarg MUST match the "item_name" spawnarg on the Altar.

	entityDef inventory__use_item //Change the name if you'd like		entityDef inventory__use_item //Change the name if you'd like
	{		{
	"inherit" "atdm:moveable_small_base"		"inherit" "atdm:moveable_small_base"

	//editor junk		//editor junk
	"editor_displayFolder" "interactables/special" // Change to a location you'd like it to show up in DR.		"editor_displayFolder" "interactables/special" // Change to a location you'd like it to show up in DR.
Line 349:		Line 355:
	}		}

	Script. This is the script that goes in your mymap.script. Or fms/scripts which requires adding the script name to your tdm_custom_script file.		===Script===
			This is the script that goes in your mymap.script. Or fms/scripts which requires adding the script name to your tdm_custom_script file.

	/////////// EVENT SCRIPTS //////////////		/////////// EVENT SCRIPTS //////////////
Line 368:		Line 375:
	}		}

	Set-up		===Set-up===

	By default the custom items can be found in DR under yourfms/interactables/special. Unless you changed the path		By default the custom items can be found in DR under yourfms/interactables/special. Unless you changed the path



	1. Add the inventory_use_item and use_item_altar to your map.		1. Add the inventory_use_item and use_item_altar to your map.
Line 378:		Line 384:
	2. Be sure to change the "inv_name" spawnarg on the custom item and the "item_name" spawnarg on the altar. They must match to work.		2. Be sure to change the "inv_name" spawnarg on the custom item and the "item_name" spawnarg on the altar. They must match to work.

	3. Place a func_static of the item's model on the altar and set spawnarg "~~hidden" to "0~~". Have the altar target the func_static and it will appear, giving the illusion it was placed there.		3. Place a func_static of the item's model on the altar and set spawnarg "hide 1". Have the altar target the func_static and it will appear, giving the illusion it was placed there.

	[[Category:Editing]]		[[Category:Editing]]

Geep: Add a section - Set up a custom GUI if needed. Mention new inventory display contorls

2022-08-23T22:19:37Z

Add a section - Set up a custom GUI if needed. Mention new inventory display contorls

← Older revision		Revision as of 22:19, 23 August 2022
Line 260:		Line 260:
	}		}
	The interesting part is how to set the GUI state variables, which is easy: just use the <tt>setGui***</tt> methods on the <tt>userEntity</tt> (usually the player), passing the overlayHandle along to specify which HUD you are addressing.		The interesting part is how to set the GUI state variables, which is easy: just use the <tt>setGui***</tt> methods on the <tt>userEntity</tt> (usually the player), passing the overlayHandle along to specify which HUD you are addressing.

			===Set up a custom GUI if needed===
			As mentioned above, you can define key ''inv_hud'' to point to a custom .gui file. For example, details about the special treatment for the compass GUI is contained in [[GUI Scripting: RenderDef]]. Also, starting in TDM 2.06, there are a richer set of user settings that affect inventory HUD displays. If your custom item provides its own GUI, consider incorporating these (e.g., "gui::HUD_Opacity", "gui::smallTextSize"). For examples, see tdm_hud.gui, tdm_inv.gui, or tdm_loot.gui in tdm_gui01.pk4\guis\.

	== Setting up Weapons ==		== Setting up Weapons ==

Petike: adding missing category

2018-10-20T05:47:26Z

adding missing category

← Older revision		Revision as of 05:47, 20 October 2018
Line 376:		Line 376:

	3. Place a func_static of the item's model on the altar and set spawnarg "hidden" to "0". Have the altar target the func_static and it will appear, giving the illusion it was placed there.		3. Place a func_static of the item's model on the altar and set spawnarg "hidden" to "0". Have the altar target the func_static and it will appear, giving the illusion it was placed there.

			[[Category:Editing]]

Sotha at 18:28, 21 November 2016

2016-11-21T18:28:49Z

← Older revision		Revision as of 18:28, 21 November 2016
Line 281:		Line 281:
	The launched projectile will impact somewhere, and this is the point in space where the so-called ''projectile result'' will be spawned. The projectile entityDef holds the spawnarg <tt>def_result</tt> pointing to the correct result entityDef. The result in turn has to implement the correct script methods which are called by the projectile collision code in the SDK. These script methods on the result's scriptobject will implement the actual behaviour of the arrow (like playing sounds, deploying ropes, etc.).		The launched projectile will impact somewhere, and this is the point in space where the so-called ''projectile result'' will be spawned. The projectile entityDef holds the spawnarg <tt>def_result</tt> pointing to the correct result entityDef. The result in turn has to implement the correct script methods which are called by the projectile collision code in the SDK. These script methods on the result's scriptobject will implement the actual behaviour of the arrow (like playing sounds, deploying ropes, etc.).

	{{~~tutorial~~-~~scripting~~}}		== How to make inventory items to interact with world objects ==
			Kingsal has reported how to use inventory items on items frob-highlighted in the game world. The report is here: http://forums.thedarkmod.com/topic/18505-script-for-placing-the-right-object-in-the-right-place/?p=397333

			This is a custom set up for an inventory item you would like the player to use_on_frob when highlighting an object in the world. The scenario in this example is placing a skull on a pedestal, but there are many different uses/ scenarios. There are several ways to do this. Check out http://wiki.thedarkmod.com/index.php?title=Tool,_Key,_custom_used_by_inventory_actions for another method.

			You will need the def files and script file below.

			This assumes you have basic knowledge of creating .def files and .scripts. If not. PM me (kingsal) for help.

			Def files. Place this in your def file.

			//++++++++++++++++++++++++Use Inventory Item++++++++++++++++++++++++++++++
			// The inventory_use_item's "inv_name" spawnarg MUST match the "item_name" spawnarg on the Altar.

			entityDef inventory__use_item //Change the name if you'd like
			{
			"inherit" "atdm:moveable_small_base"

			//editor junk
			"editor_displayFolder" "interactables/special" // Change to a location you'd like it to show up in DR.
			"editor_usage" "Custom use-on-frob item"
			"editor_color" "0.922 0.039 0.855"

			//Model
			"model" "models/darkmod/graveyard/bones/skull2.ase" // Change to appropriate model. Should have a collision mesh.
			"mass" "10" // If item can be dropped, Set this higher to avoid the player from lobbing it too far.
			"friction" "0.7"
			"solid" "0"

			//Inventory stuff
			"inv_name" "custom item name" //Rename it something fun! MUST match the name on the Altar.
			"inv_icon" "guis\assets\hud\inventory_icons\skull_inv_icon" // GUI icon.
			"inv_droppable" "1" //Allows the player to drop this. Beware they might drop it someplace where it can't be retrieved.
			"inv_category" "Custom Items" //Rename this to the appropiate category.
			"inv_stackable" "1" //This is only needed if their are multiple of these items that you want to stack in the inventory.

			//sound
			"snd_acquire" "tool_pickup"
			"snd_bounce" "tdm_impact_metal_med_lesser"


			}

			//++++++++++++++++++++++++Altar++++++++++++++++++++++++++++++

			entityDef use_item_altar //Change the name if you'd like
			{
			"inherit" "atdm:entity_base"
			"spawnclass" "idStaticEntity"

			//editor junk
			"editor_displayFolder" "interactables/special" // Change to a location you'd like it to show up in DR.
			"editor_usage" "Altar for placing inventory_use_items"
			"editor_color" "0.922 0.039 0.855"

			//Model
			"model" "models/darkmod/furniture/tables/builder_pedestal01.lwo" //Change to appropriate model
			"solid" "1" //Must be solid

			//Interaction
			"frobable" "1"
			"frob_action_script" "use_altar"
			"item_name" "custom item name" //This must match the inv_name spawnarg of the custom item
			}

			Script. This is the script that goes in your mymap.script. Or fms/scripts which requires adding the script name to your tdm_custom_script file.

			/////////// EVENT SCRIPTS //////////////
			//Place this in your fms/maps/ as a mymapname.script.
			void use_altar(entity altar)
			{

			entity curr_item = $player1.getCurInvItemEntity();
			if ($player1.getCurInvItemName() == altar.getKey("item_name"))
			{
			$player1.changeInvItemCount(curr_item.getKey("inv_name"), curr_item.getKey("inv_category"), -1); //Removes item count by one.
			altar.activateTargets( $player1 ); //Activates the altar's targets.
			altar.setFrobable( 0 ); //Sets to none frobable. One time use. REMOVE THIS TO MAKE RE-USABLE.
			altar.startSoundShader ("mage_fireball_impact", SND_CHANNEL_VOICE ); //Play a sound you like!
			sys.wait( 1 );
			}

			}

			Set-up

			By default the custom items can be found in DR under yourfms/interactables/special. Unless you changed the path



			1. Add the inventory_use_item and use_item_altar to your map.

			2. Be sure to change the "inv_name" spawnarg on the custom item and the "item_name" spawnarg on the altar. They must match to work.

			3. Place a func_static of the item's model on the altar and set spawnarg "hidden" to "0". Have the altar target the func_static and it will appear, giving the illusion it was placed there.

Fidcal: /* Scriptsupport */

2010-06-23T10:32:25Z

Scriptsupport

← Older revision		Revision as of 10:32, 23 June 2010
Line 122:		Line 122:
	;'''<tt>tdm_hud_opacity</tt> \| float [0..1]		;'''<tt>tdm_hud_opacity</tt> \| float [0..1]
	:Defines the opacity of the HUD GUIs, also affects the lightgem and the weapon HUD.		:Defines the opacity of the HUD GUIs, also affects the lightgem and the weapon HUD.


			== Key bindings ==

			For inventory key bindings see [[Bindings_and_User_Settings#Inventory_Related]]


	== Scriptsupport ==		== Scriptsupport ==

Fidcal: /* Spawnargs */

2009-12-10T17:40:06Z

Spawnargs

← Older revision		Revision as of 17:40, 10 December 2009
Line 41:		Line 41:
	;'''<tt>inv_droppable</tt>''' \| [0\|1]		;'''<tt>inv_droppable</tt>''' \| [0\|1]
	:If set to 1 the item can be dropped into the map by the player. This will not work for anonymous items (loot, ammo), since their entity will be removed from the map after they had been put into the inventory.		:If set to 1 the item can be dropped into the map by the player. This will not work for anonymous items (loot, ammo), since their entity will be removed from the map after they had been put into the inventory.

			;'''<tt>drop_to_hands</tt>''' \| [0\|1]
			:If set to 1 (default) the item drops to the hands (grabber manipulator) of the player instead of to the ground. Set to 0 and the item drops directly to the floor when dropped.

	;'''<tt>inv_loot_type</tt>''' \| [ 0 \| 1 \| 2 \| 3 ]		;'''<tt>inv_loot_type</tt>''' \| [ 0 \| 1 \| 2 \| 3 ]