Frobbing - Revision history

Nbohr1more: /* Material Def */

2024-10-30T01:17:42Z

Material Def

← Older revision		Revision as of 01:17, 30 October 2024
Line 33:		Line 33:
	Texture authors can customize the appearance of Frob via new arguments.		Texture authors can customize the appearance of Frob via new arguments.

	See: [[Material_Files#Optional:_Customizing_frob-highlight\|Frob Stages]]		See: '''[[Material_Files#Optional:_Customizing_frob-highlight\|Frob Stages]]'''

	= Typical Default Values of Frob Distance =		= Typical Default Values of Frob Distance =

Nbohr1more at 01:16, 30 October 2024

2024-10-30T01:16:26Z

← Older revision		Revision as of 01:16, 30 October 2024
Line 27:		Line 27:
	* '''frob_master''' Set to the name of an entity. This is used to propagate the frob action to other entities when one frobbed entity is used. It sets up a chain, and frobbing any link in the chain will call the frobaction on the whole chain.		* '''frob_master''' Set to the name of an entity. This is used to propagate the frob action to other entities when one frobbed entity is used. It sets up a chain, and frobbing any link in the chain will call the frobaction on the whole chain.
	* '''inv_frob_distance_cap''' Max frob distance when acted upon by tool from the inventory, eg, key or lockpick used on door. Default is 40 to force player to move in closer. Can be adjusted for special individual cases, eg, a lock that cannot be quite reached through a gap or window.		* '''inv_frob_distance_cap''' Max frob distance when acted upon by tool from the inventory, eg, key or lockpick used on door. Default is 40 to force player to move in closer. Can be adjusted for special individual cases, eg, a lock that cannot be quite reached through a gap or window.

			= Material Def =

			As of TDM 2.11, all textures automatically generate a Frob interaction when targeted by Frob configuration.
			Texture authors can customize the appearance of Frob via new arguments.

			See: [[Material_Files#Optional:_Customizing_frob-highlight\|Frob Stages]]

	= Typical Default Values of Frob Distance =		= Typical Default Values of Frob Distance =

Datiswous: /* Entity Settings */ typos

2024-10-30T00:01:45Z

Entity Settings: typos

← Older revision		Revision as of 00:01, 30 October 2024
Line 24:		Line 24:
	* '''snd_acquire''' Name of the soundshader to play when the entity is "used" while frobbed. (NOTE: Maybe we should change the name of this to snd_frob or snd_frobaction or something?)		* '''snd_acquire''' Name of the soundshader to play when the entity is "used" while frobbed. (NOTE: Maybe we should change the name of this to snd_frob or snd_frobaction or something?)
	* '''frob_action_script''' String name of the script that will be called when an item is frobbed. Note that you must specify the scope to call the script in. If it's on the same entity, you should use "<name of entity scriptobject>::<function>". Similarly, if the script to call is within the namespace of a map, you should use "<map namespace>::<function>". Otherwise, just inputting "<function>" will call a global scriptfunction.		* '''frob_action_script''' String name of the script that will be called when an item is frobbed. Note that you must specify the scope to call the script in. If it's on the same entity, you should use "<name of entity scriptobject>::<function>". Similarly, if the script to call is within the namespace of a map, you should use "<map namespace>::<function>". Otherwise, just inputting "<function>" will call a global scriptfunction.
	* '''frob_peer_<N>''' Determines what other ents should ~~hilight~~ when this ent is ~~hilighted~~. For each ent you want to ~~hilight~~, put in a key of the form "frob_peer_<N>" with value: "<entity name>". If you just want one frob peer, putting in "frob_peer" is also fine, but multiple frob peers must have the form "frob_peer_*". NOTE: Currently this only works to propagate the ~~hilight~~. The frob action when you hit "use" is not propagated to all entities within a frob peer group. This is handled by setting "frob_master" described below.		* '''frob_peer_<N>''' Determines what other ents should highlight when this ent is highlighted. For each ent you want to highlight, put in a key of the form "frob_peer_<N>" with value: "<entity name>". If you just want one frob peer, putting in "frob_peer" is also fine, but multiple frob peers must have the form "frob_peer_*". NOTE: Currently this only works to propagate the highlight. The frob action when you hit "use" is not propagated to all entities within a frob peer group. This is handled by setting "frob_master" described below.
	* '''frob_master''' Set to the name of an entity. This is used to propagate the frob action to other entities when one frobbed entity is used. It sets up a chain, and frobbing any link in the chain will call the frobaction on the whole chain.		* '''frob_master''' Set to the name of an entity. This is used to propagate the frob action to other entities when one frobbed entity is used. It sets up a chain, and frobbing any link in the chain will call the frobaction on the whole chain.
	* '''inv_frob_distance_cap''' Max frob distance when acted upon by tool from the inventory, eg, key or lockpick used on door. Default is 40 to force player to move in closer. Can be adjusted for special individual cases, eg, a lock that cannot be quite reached through a gap or window.		* '''inv_frob_distance_cap''' Max frob distance when acted upon by tool from the inventory, eg, key or lockpick used on door. Default is 40 to force player to move in closer. Can be adjusted for special individual cases, eg, a lock that cannot be quite reached through a gap or window.

Thebigh: /* Entity Settings */ -typo

2022-03-16T20:20:53Z

Entity Settings: -typo

← Older revision		Revision as of 20:20, 16 March 2022
Line 24:		Line 24:
	* '''snd_acquire''' Name of the soundshader to play when the entity is "used" while frobbed. (NOTE: Maybe we should change the name of this to snd_frob or snd_frobaction or something?)		* '''snd_acquire''' Name of the soundshader to play when the entity is "used" while frobbed. (NOTE: Maybe we should change the name of this to snd_frob or snd_frobaction or something?)
	* '''frob_action_script''' String name of the script that will be called when an item is frobbed. Note that you must specify the scope to call the script in. If it's on the same entity, you should use "<name of entity scriptobject>::<function>". Similarly, if the script to call is within the namespace of a map, you should use "<map namespace>::<function>". Otherwise, just inputting "<function>" will call a global scriptfunction.		* '''frob_action_script''' String name of the script that will be called when an item is frobbed. Note that you must specify the scope to call the script in. If it's on the same entity, you should use "<name of entity scriptobject>::<function>". Similarly, if the script to call is within the namespace of a map, you should use "<map namespace>::<function>". Otherwise, just inputting "<function>" will call a global scriptfunction.
	* '''frob_peer_<N>''' Determines what other ents ~~shoud~~ hilight when this ent is hilighted. For each ent you want to hilight, put in a key of the form "frob_peer_<N>" with value: "<entity name>". If you just want one frob peer, putting in "frob_peer" is also fine, but multiple frob peers must have the form "frob_peer_*". NOTE: Currently this only works to propagate the hilight. The frob action when you hit "use" is not propagated to all entities within a frob peer group. This is handled by setting "frob_master" described below.		* '''frob_peer_<N>''' Determines what other ents should hilight when this ent is hilighted. For each ent you want to hilight, put in a key of the form "frob_peer_<N>" with value: "<entity name>". If you just want one frob peer, putting in "frob_peer" is also fine, but multiple frob peers must have the form "frob_peer_*". NOTE: Currently this only works to propagate the hilight. The frob action when you hit "use" is not propagated to all entities within a frob peer group. This is handled by setting "frob_master" described below.
	* '''frob_master''' Set to the name of an entity. This is used to propagate the frob action to other entities when one frobbed entity is used. It sets up a chain, and frobbing any link in the chain will call the frobaction on the whole chain.		* '''frob_master''' Set to the name of an entity. This is used to propagate the frob action to other entities when one frobbed entity is used. It sets up a chain, and frobbing any link in the chain will call the frobaction on the whole chain.
	* '''inv_frob_distance_cap''' Max frob distance when acted upon by tool from the inventory, eg, key or lockpick used on door. Default is 40 to force player to move in closer. Can be adjusted for special individual cases, eg, a lock that cannot be quite reached through a gap or window.		* '''inv_frob_distance_cap''' Max frob distance when acted upon by tool from the inventory, eg, key or lockpick used on door. Default is 40 to force player to move in closer. Can be adjusted for special individual cases, eg, a lock that cannot be quite reached through a gap or window.

Geep: Add scripting as category

2022-03-15T21:12:12Z

Add scripting as category

← Older revision		Revision as of 21:12, 15 March 2022
Line 99:		Line 99:

	{{editing}}		{{editing}}
			[[Category:Scripting]]

Geep: /* Setting Frob From a Script */

2022-03-15T21:08:22Z

Setting Frob From a Script

← Older revision		Revision as of 21:08, 15 March 2022
Line 81:		Line 81:
	$<entityname>.setFrobable(n);		$<entityname>.setFrobable(n);

	where n is "1" to make it frobable and "0" for unfrobable.		where n is 1 to make it frobable and 0 for unfrobable.

	Also, you can simulate a frob action performed by the player thusly:		Also, you can simulate a frob action performed by the player thusly:
Line 87:		Line 87:
	$<entityname>.frob();		$<entityname>.frob();

	If of interest, that function returns a float value: a boolean TRUE if the entity is frobable, FALSE otherwise. Of course, you can also retrieve that info with general spawnarg functions:		If of interest, that function returns a float value: a boolean TRUE if the entity is frobable, FALSE otherwise. Of course, you can also retrieve that info with general spawnarg functions or a specific function:

	boolean myFrob1 = $<entityname>.getBoolKey("frobable");		boolean myFrob1 = $<entityname>.getBoolKey("frobable");
	float myFrob2 = $<entityname>.getFloatKey("frobable");		float myFrob2 = $<entityname>.getFloatKey("frobable");
			float myFrob3 = $<entityname>.isFrobable();

	See also [[Altering Frob with Scripting]]		See also [[Altering Frob with Scripting]]

Geep: Add link to Altering_Frob_with_Scripting. Frobable vs Frobbable

2022-03-15T21:02:57Z

Add link to Altering_Frob_with_Scripting. Frobable vs Frobbable

← Older revision		Revision as of 21:02, 15 March 2022
Line 91:		Line 91:
	boolean myFrob1 = $<entityname>.getBoolKey("frobable");		boolean myFrob1 = $<entityname>.getBoolKey("frobable");
	float myFrob2 = $<entityname>.getFloatKey("frobable");		float myFrob2 = $<entityname>.getFloatKey("frobable");

			See also [[Altering Frob with Scripting]]

			= "Frobable" versus "Frobbable" =
			You'll see either spelling in this wiki, and both are acceptable. "Frobable" is preferred, being the name of the spawnarg and used in stock script function names.

	{{editing}}		{{editing}}

Geep: /* Setting Frob From a Script */

2022-03-14T20:12:06Z

Setting Frob From a Script

← Older revision		Revision as of 20:12, 14 March 2022
Line 87:		Line 87:
	$<entityname>.frob();		$<entityname>.frob();

	If of interest, that function returns a float value: a boolean TRUE if the entity is frobable, FALSE otherwise.		If of interest, that function returns a float value: a boolean TRUE if the entity is frobable, FALSE otherwise. Of course, you can also retrieve that info with general spawnarg functions:

			boolean myFrob1 = $<entityname>.getBoolKey("frobable");
			float myFrob2 = $<entityname>.getFloatKey("frobable");

	{{editing}}		{{editing}}

Geep: /* Using a target_set_frobable */

2022-02-01T17:21:16Z

Using a target_set_frobable

← Older revision		Revision as of 17:21, 1 February 2022
Line 66:		Line 66:
	= Using a target_set_frobable =		= Using a target_set_frobable =

	This is an entity (a single brush) used inside containers (cabinets, drawers, footlockers, etc.) to control when the objects inside it are frobable. Since the player shouldn't be able to frob objects inside the container when its lid or door is closed, frobbing the lid or door tells the '''target_set_frobable''' to disable (closed) or enable (open) frobbing of its objects.		This is an entity (a single brush) used inside containers (cabinets, drawers, footlockers, etc.) to control when the objects inside it are frobable. Since the player shouldn't be able to frob objects inside the container when its lid or door is closed, frobbing the lid or door tells the '''target_set_frobable''' to disable (closed) or enable (open) frobbing of its objects. For details of setting up spawnargs for this, see [[Containers,_Chests,_etc.]].

	The '''target_set_frobable''' determines what's "inside" it by checking the frobbox size or collision boundary of nearby objects. If you use these spawnargs on an object: ''frobbox_size'', or the ''frobbbox_mins & frobbox_maxs'' pair, it's possible for the '''target_set_frobable''' to find objects that really aren't "inside" it. They could be nearby and "outside", but if their frobbox extends into the '''target_set_frobable''', the '''target_set_frobable''' will see them and toggle their frobability as needed. This might not be what you want. So if you're having problems frobbing an object, check whether it uses a frobbox and if there are nearby '''target_set_frobable''' entities. This is a particular problem with the writing bureau prefab, which has multiple neighbouring '''target_set_frobable''' entities; when you think an object is "inside" one of these entities, but it's been assigned to a different one instead.		The '''target_set_frobable''' determines what's "inside" it by checking the frobbox size or collision boundary of nearby objects. If you use these spawnargs on an object: ''frobbox_size'', or the ''frobbbox_mins & frobbox_maxs'' pair, it's possible for the '''target_set_frobable''' to find objects that really aren't "inside" it. They could be nearby and "outside", but if their frobbox extends into the '''target_set_frobable''', the '''target_set_frobable''' will see them and toggle their frobability as needed. This might not be what you want. So if you're having problems frobbing an object, check whether it uses a frobbox and if there are nearby '''target_set_frobable''' entities. This is a particular problem with the writing bureau prefab, which has multiple neighbouring '''target_set_frobable''' entities; when you think an object is "inside" one of these entities, but it's been assigned to a different one instead.

Geep: /* Using Items on Other Items */ Include _N & "-" syntax

2021-12-14T16:40:17Z

Using Items on Other Items: Include _N & "-" syntax

← Older revision		Revision as of 16:40, 14 December 2021
Line 56:		Line 56:
	used_by2 key_simple_on_shelf		used_by2 key_simple_on_shelf

	~~To make this work, the~~ prefix "used_by" must be there, followed by either nothing or N. (Values of N don't have to be contiguous or ordered.)		The prefix "used_by" must be there. This is followed by either nothing or N or _N. Values of N don't have to be contiguous or ordered. If a door has no key (as is the case when first inserted into a map), that is indicated by:

	NOTE: An item ~~that can~~ be used on ~~another item (like a key)~~, must ~~also~~ have ~~the~~ spawnArg "usable~~" set to "~~1~~" in order to use it on something else.~~		used_by -

			NOTE: A key or other item, to be used on something else, must have this spawnArg set (typically by default):

			usable 1

	= Using a target_set_frobable =		= Using a target_set_frobable =