In-game Map Entities - Revision history

Datiswous: /* Adding the script */

2025-11-30T18:24:59Z

Adding the script

← Older revision		Revision as of 18:24, 30 November 2025
Line 73:		Line 73:
	}		}

	The names in the script with a <code>$</code> next to them must match the <code>name</code> property of your entities, and the string in <code>setCurInvItem</code> must match the <code>inv_name</code> property of the <code>atdm:map_of entity</code>. $player1 is the player entity.		The names in the script with a <code>$</code> next to them must match the <code>name</code> property of your entities, and the string in <code>setCurInvItem</code> must match the <code>inv_name</code> property of the <code>atdm:map_of entity</code>. <code>$player1</code> is the player entity.

	== Result ==		== Result ==

Datiswous: /* Adding the script */

2025-11-30T18:24:06Z

Adding the script

← Older revision		Revision as of 18:24, 30 November 2025
Line 54:		Line 54:
	== Adding the script ==		== Adding the script ==

	There are 2 types of script files. Map scripts and external scripts. Map scripts are used only in one map, while external scripts can be used in multiple maps. Map scripts always go in one script file which is stored inside the maps folder of your mission.		There are 2 types of script files. Map scripts and external scripts. Map scripts are used only in one map, while external scripts can be used in multiple maps. Map scripts always go in one script file which is stored inside the maps folder of your mission. <br>
	The filename '''must''' always be: ''mapname''.script (the same name as your map file, but with a .script extension) . In this example we use a map script. See also the guide [[A to Z Scripting: Setting up the .script files]].		The filename '''must''' always be: ''mapname''.script (the same name as your map file, but with a .script extension) . In this example we use a map script. See also the guide [[A to Z Scripting: Setting up the .script files]].

Datiswous: /* Adding the script */

2025-11-30T18:22:09Z

Adding the script

← Older revision		Revision as of 18:22, 30 November 2025
Line 54:		Line 54:
	== Adding the script ==		== Adding the script ==

	There are 2 types of script files. Map scripts and external scripts. Map scripts are used only in one map, while external scripts can be used in multiple maps. Map scripts always go in one script file which is stored inside the maps folder of your mission. The filename '''must''' always be: ''mapname''.script (the same name as your map file, but with a .script extension) . In this example we use a map script. See also the guide [[A to Z Scripting: Setting up the .script files]].		There are 2 types of script files. Map scripts and external scripts. Map scripts are used only in one map, while external scripts can be used in multiple maps. Map scripts always go in one script file which is stored inside the maps folder of your mission.
			The filename '''must''' always be: ''mapname''.script (the same name as your map file, but with a .script extension) . In this example we use a map script. See also the guide [[A to Z Scripting: Setting up the .script files]].

	Place the following code inside your ''mapname''.script file:		Place the following code inside your ''mapname''.script file:

Datiswous: /* Adding the script */

2025-11-30T18:21:43Z

Adding the script

← Older revision		Revision as of 18:21, 30 November 2025
Line 54:		Line 54:
	== Adding the script ==		== Adding the script ==

	There are 2 types of script files. Map scripts and external scripts. Map scripts are used only in one map, while external scripts can be used in multiple maps. Map scripts always go in one script file which is stored inside the maps folder of your mission. The filename must always be: ''mapname''.script . In this example we use a map script. See also the guide [[A to Z Scripting: Setting up the .script files]].		There are 2 types of script files. Map scripts and external scripts. Map scripts are used only in one map, while external scripts can be used in multiple maps. Map scripts always go in one script file which is stored inside the maps folder of your mission. The filename '''must''' always be: ''mapname''.script (the same name as your map file, but with a .script extension) . In this example we use a map script. See also the guide [[A to Z Scripting: Setting up the .script files]].

	Place the following code inside your ''mapname''.script file:		Place the following code inside your ''mapname''.script file:

Datiswous: Organised the page a bit and added some clarifications (info suplied by user Skaruts)

2025-11-30T18:18:59Z

Organised the page a bit and added some clarifications (info suplied by user Skaruts)

← Older revision		Revision as of 18:18, 30 November 2025
Line 1:		Line 1:
	''originally written by grayman''		''originally written by grayman''

			== Create atdm:map_of entity ==

	Create an "atdm:map_of" entity as if you intend to place it in the player's inventory at the start of the mission. Then turn off the "inv_map_start" spawnarg.		Create an "atdm:map_of" entity as if you intend to place it in the player's inventory at the start of the mission. Then turn off the "inv_map_start" spawnarg.
Line 9:		Line 11:
	"inv_name" "Sewer Map"		"inv_name" "Sewer Map"
	"gui" "guis/map_of_sewer.gui"		"gui" "guis/map_of_sewer.gui"

			== Create gui file ==

	Create a gui file called "map_of_sewer.gui" with the following contents, and put it into your guis directory:		Create a gui file called "map_of_sewer.gui" with the following contents, and put it into your guis directory:
Line 24:		Line 28:
	}		}
	}		}

			== Create image ==

	Create the image you want displayed (your map) in "map_of_sewer.tga", with an alpha channel. (The alpha channel supports a map with a ragged edge. Unlike the method in [[Startpack_Mappers%27_Guide#Adding_an_In-game_Map_to_your_FM]], here, a custom .mtr or .def file is unneeded for such support.)		Create the image you want displayed (your map) in "map_of_sewer.tga", with an alpha channel. (The alpha channel supports a map with a ragged edge. Unlike the method in [[Startpack_Mappers%27_Guide#Adding_an_In-game_Map_to_your_FM]], here, a custom .mtr or .def file is unneeded for such support.)
Line 30:		Line 36:

	Retrieve a copy of guis/assets/game_maps/map_of_icon.tga from startmap.pk4 and place it into guis/assets/game_maps/.		Retrieve a copy of guis/assets/game_maps/map_of_icon.tga from startmap.pk4 and place it into guis/assets/game_maps/.

			== Create atdm:static_custom_item entity ==

	Create an "atdm:static_custom_item" entity with these spawnargs:		Create an "atdm:static_custom_item" entity with these spawnargs:
Line 44:		Line 52:
	The "sr_*" spawnargs describe how your custom entity will react to a frob stim.		The "sr_*" spawnargs describe how your custom entity will react to a frob stim.

	Place the following code inside your *.script file:		== Adding the script ==

			There are 2 types of script files. Map scripts and external scripts. Map scripts are used only in one map, while external scripts can be used in multiple maps. Map scripts always go in one script file which is stored inside the maps folder of your mission. The filename must always be: ''mapname''.script . In this example we use a map script. See also the guide [[A to Z Scripting: Setting up the .script files]].

			Place the following code inside your ''mapname''.script file:

	void FrobSewerMap()		void FrobSewerMap()
Line 59:		Line 71:
	{		{
	}		}

			The names in the script with a <code>$</code> next to them must match the <code>name</code> property of your entities, and the string in <code>setCurInvItem</code> must match the <code>inv_name</code> property of the <code>atdm:map_of entity</code>. $player1 is the player entity.

			== Result ==

	When you play the mission, frobbing the custom item that looks like a scroll will cause the script to run, which replaces the custom item in your inventory with the "atdm:map_of" entity you created at the top of this note.		When you play the mission, frobbing the custom item that looks like a scroll will cause the script to run, which replaces the custom item in your inventory with the "atdm:map_of" entity you created at the top of this note.

Geep: Add 2 sentences saying why alpha channel and how differs from Startpack method, with ref

2020-11-01T02:34:32Z

Add 2 sentences saying why alpha channel and how differs from Startpack method, with ref

← Older revision		Revision as of 02:34, 1 November 2020
Line 25:		Line 25:
	}		}

	Create the image you want displayed (your map) in "map_of_sewer.tga", with an alpha channel.		Create the image you want displayed (your map) in "map_of_sewer.tga", with an alpha channel. (The alpha channel supports a map with a ragged edge. Unlike the method in [[Startpack_Mappers%27_Guide#Adding_an_In-game_Map_to_your_FM]], here, a custom .mtr or .def file is unneeded for such support.)

	Put that image into guis/assets/game_maps/.		Put that image into guis/assets/game_maps/.

Petike: adding category tag

2018-11-21T15:24:04Z

adding category tag

← Older revision		Revision as of 15:24, 21 November 2018
Line 66:		Line 66:
	{{editing}}		{{editing}}
	[[Category:Tutorial]]		[[Category:Tutorial]]
			[[Category:Mapping Tutorials]]

Grayman at 04:21, 16 December 2013

2013-12-16T04:21:05Z

← Older revision		Revision as of 04:21, 16 December 2013
Line 35:		Line 35:
	"name" "SewerMap"		"name" "SewerMap"
	"inv_map_start" "0"		"inv_map_start" "0"
	"model" "models/darkmod/readables/scroll_rolled_up. lwo" (or use whatever model you prefer)		"model" "models/darkmod/readables/scroll_rolled_up.lwo" (or use whatever model you prefer)
	"sr_class_1" "R"		"sr_class_1" "R"
	"sr_effect_1_1" "effect_script"		"sr_effect_1_1" "effect_script"

Grayman at 17:03, 5 November 2013

2013-11-05T17:03:46Z

← Older revision		Revision as of 17:03, 5 November 2013
Line 28:		Line 28:

	Put that image into guis/assets/game_maps/.		Put that image into guis/assets/game_maps/.

			Retrieve a copy of guis/assets/game_maps/map_of_icon.tga from startmap.pk4 and place it into guis/assets/game_maps/.

	Create an "atdm:static_custom_item" entity with these spawnargs:		Create an "atdm:static_custom_item" entity with these spawnargs:

Grayman at 15:00, 3 September 2012

2012-09-03T15:00:18Z

← Older revision		Revision as of 15:00, 3 September 2012
Line 16:		Line 16:
	rect 0,0,640,480		rect 0,0,640,480
	nocursor 1		nocursor 1

	windowDef background_map		windowDef background_map
	{		{
	rect 64,48, 512, 384		rect 64,48, 512, 384
	background "guis/assets/game_maps/map_of_sewer"		background "guis/assets/game_maps/map_of_sewer"

	visible 1		visible 1
	}		}
	}		}



	Create the image you want displayed (your map) in "map_of_sewer.tga", with an alpha channel.		Create the image you want displayed (your map) in "map_of_sewer.tga", with an alpha channel.
Line 52:		Line 49:
	// MapOfSewer shows the sewer map when used while in inventory.		// MapOfSewer shows the sewer map when used while in inventory.
	// Make sure HUD shows the map icon.		// Make sure HUD shows the map icon.

	$player1.replaceInvItem($SewerMap,$MapOfSewer);		$player1.replaceInvItem($SewerMap,$MapOfSewer);
	$player1.setCurInvItem("Sewer Map"); // provide inventory name, not item name		$player1.setCurInvItem("Sewer Map"); // provide inventory name, not item name
	}		}

	void main() // this might already be there; skip if so		void main() // this might already be there; skip if so
	{		{
	}		}



	When you play the mission, frobbing the custom item that looks like a scroll will cause the script to run, which replaces the custom item in your inventory with the "atdm:map_of" entity you created at the top of this note.		When you play the mission, frobbing the custom item that looks like a scroll will cause the script to run, which replaces the custom item in your inventory with the "atdm:map_of" entity you created at the top of this note.