Script for placing the right object in the right place

[kingsal]

Hey everyone, I am working on a script and I need a little help on one aspect of it

Essential this acts as an alter that you must place the right item on.

 

I'd like to create a spawnarg "item_name" on the altar that will match up to the corresponding item, but I'm not sure how to do that.

 

The below method works, but it requires me to make a custom script for each altar.

void use_fire_altar(entity ent)
{
    entity curr_item = $player1.getCurInvItemEntity();
    if ($player1.getCurInvItemName() == "item_name")
    {
        $player1.replaceInvItem( curr_item, $null_entity );   // remove remains
		ent.activateTargets( $player1 );
		ent.setFrobable( 0 );
    }
}

Thanks!

 

[VanishedOne]

Is it reading the spawnarg from ent you're unsure about? In that case try something like:

if ($player1.getCurInvItemName() == ent.getKey("item_name") )

[Sotha]

Is it like dropping the item on the altar or using the item from inventory with ENTER key while frob highlighting the altar?

 

If just dropping, you could use stim/response or hidden objective.

 

For stim/response: add a custom stim on the object, and add a response to the location is should be brought. You could look at Lich Queen's Demise map cannon and cannon ball for an example.

 

For hidden objective, see wiki objective editor entry for "item is in location". You could check Coercion blackmail note for an example.

 

For item using while frobbing, I have no clue.

[stumpy]

probably a custom def file for the altar, then you could pass a item name to the script.

[kingsal]

Hey Guys,

 

Adding:

if ($player1.getCurInvItemName() == ent.getKey("item_name") )

To the altar script did the trick. I can now put a item-name spawnarg on the altar that will only take the correct item in the inventory.

The stim response and /or objectives works as well, however I want the player to use the item like a key (selected from the inventory)

 

Thanks for the help!

[Sotha]

Nice!

 

Could I ask you to write a brief summary how the mapper can make "use inventory item on frob highlighted object" behavior?

 

I've always wondered how to do it, and perhaps others as well. I will add the info to the wiki ao that everyone can learn how to do it. It would be very useful to make adventure like "use items to solve puzzles" kind of missions.

 

Thanks for considering my proposal!

[VanishedOne]

According to the wiki, this is how it's supposed to work (I haven't checked the information is accurate and current): http://wiki.thedarkmod.com/index.php?title=Tool,_Key,_custom_used_by_inventory_actions

[kingsal]

VanishedOne- Yeah it looks like you can do the same thing using the default door scripts. It would still require some setup, but I haven't tried it. Essentially a use_on_frob item works exactly like a key to a door.

 

Sotha- No problem. Here is how I got it to work. It might be worth getting someone to try it out other than me, as I might have missed something.

 

 

Custom use-on-frob item set-up.

 

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.

Edited November 20, 2016 by kingsal

[Sotha]

Thanks! Wikified. It is now in the Inventory wiki article!

 

http://wiki.thedarkmod.com/index.php?title=Inventory#How_to_make_inventory_items_to_interact_with_world_objects