A to Z Scripting: Scriptobjects - Revision history

Dragofer at 07:52, 11 March 2021

2021-03-11T07:52:28Z

← Older revision		Revision as of 07:52, 11 March 2021
Line 163:		Line 163:
	void target_unbind::init() //initial setup; gets called automatically when this entity spawns		void target_unbind::init() //initial setup; gets called automatically when this entity spawns
	{		{
	sys.onSignal(SIG_TRIGGER, self, "unbind_targets"); //when receiving a trigger signal on this entity, call the script unbind_targets() (contained in this scriptobject)		sys.onSignal(SIG_TRIGGER, self, "target_unbind::unbind_targets"); //when receiving a trigger signal on this entity, call the script unbind_targets() (contained in this scriptobject)
	}		}

Dragofer: /* Next / previous article */

2020-12-27T19:46:19Z

Next / previous article

← Older revision		Revision as of 19:46, 27 December 2020
Line 213:		Line 213:
	== Next / previous article ==		== Next / previous article ==

	*Next article: [[A to Z Scripting: ~~Utility scripts~~]]		*Next article: [[A to Z Scripting: Script addons for players]]
	*Previous article: [[A to Z Scripting: ~~Special methods~~]]		*Previous article: [[A to Z Scripting: Utility scripts]]
	*Table of contents: [[A to Z Scripting]]		*Table of contents: [[A to Z Scripting]]

	[[Category:Scripting]]		[[Category:Scripting]]

Dragofer: /* Accessing variables of a scriptobject in a global script */

2020-12-27T18:00:10Z

Accessing variables of a scriptobject in a global script

← Older revision		Revision as of 18:00, 27 December 2020
Line 118:		Line 118:
	== Accessing variables of a scriptobject in a global script ==		== Accessing variables of a scriptobject in a global script ==
	If you want to access the variables of this scriptobject from a global script, i.e. if you want to check whether a specific fountain is "active" or not, you will need to make the variables visible in some way:		If you want to access the variables of this scriptobject from a global script, i.e. if you want to check whether a specific fountain is "active" or not, you will need to make the variables visible in some way:
	* The easiest way is to let the scriptobject set custom spawnargs on ~~itself~~, i.e. setKey("active", "1"). Any other script can access that.		* The easiest way is to let the scriptobject set custom spawnargs on its entity, i.e. setKey("active", "1"). Any other script can access that.

	* Alternatively, you can use the approach seen earlier for accessing "AI flags". You can create a variable where the the fountain is defined as a subcategory of entity named after the scriptobject. Example:		* Alternatively, you can use the approach seen earlier for accessing "AI flags". You can create a variable where the the fountain is defined as a subcategory of entity named after the scriptobject. Example:
	healing_fountain fountain = $fountain_1; //define $fountain_1 as a variable of type "healing_fountain" (identical to the scriptobject's name		healing_fountain fountain = $fountain_1; //define $fountain_1 as a variable of type "healing_fountain" (identical to the scriptobject's name
	Then:		Then:
	if ( fountain.active ) sys.println(fountain + " is ready to heal the player.");		if ( fountain.active ) sys.println(fountain + " is ready to heal the player.");
	* A further option is to create scripts in the scriptobject that return the current value of a specific variable, similar to a script event. See [[A to Z Scripting: Utility scripts]] for more on using "return" for this purpose.


			* A further option is to create scripts in the scriptobject that return the current value of a specific variable, similar to a script event. See [[A to Z Scripting: Utility scripts]] for more on using "return" for this purpose. Example:
			float healing_fountain::isActive()
			{
			return active;
			}

	== Inheriting from an existing scriptobject ==		== Inheriting from an existing scriptobject ==

Dragofer: /* Part 3: the actual scripts */

2020-12-27T17:51:41Z

Part 3: the actual scripts

← Older revision		Revision as of 17:51, 27 December 2020
Line 70:		Line 70:
	if ( (last_used + getFloatKey("cooldown")) > sys.getTime() ) active = 1;		if ( (last_used + getFloatKey("cooldown")) > sys.getTime() ) active = 1;
	}		}

Dragofer at 17:51, 27 December 2020

2020-12-27T17:51:30Z

← Older revision		Revision as of 17:51, 27 December 2020
Line 105:		Line 105:

	You can find example entity definitions near the bottom of this article as well as in tdm_defs01.pk4.		You can find example entity definitions near the bottom of this article as well as in tdm_defs01.pk4.


	== Calling individual scripts of a scriptobject ==		== Calling individual scripts of a scriptobject ==

Dragofer: /* Part 3: the actual scripts */

2020-12-27T17:49:16Z

Part 3: the actual scripts

← Older revision		Revision as of 17:49, 27 December 2020
Line 92:		Line 92:
	ResponseEnable(STIM_FROB,1);		ResponseEnable(STIM_FROB,1);

	return; //abort		return; //abort
	}		}
	}		}

Dragofer: /* Part 3: the actual scripts */

2020-12-27T17:48:39Z

Part 3: the actual scripts

← Older revision		Revision as of 17:48, 27 December 2020
Line 87:		Line 87:
	{		{
	startSound("snd_inactive", SND_CHANNEL_ANY, false); //play inactive sound		startSound("snd_inactive", SND_CHANNEL_ANY, false); //play inactive sound
	~~sys.clearSignalThread(SIG_TRIGGER, $func_static_1);~~
	ResponseEnable(STIM_FROB,0); //disable the frob response for 3s to prevent sound spamming		ResponseEnable(STIM_FROB,0); //disable the frob response for 3s to prevent sound spamming
	sys.wait(3);		sys.wait(3);
	ResponseEnable(STIM_FROB,1);		ResponseEnable(STIM_FROB,1);
	return; //abort
			return; //abort
	}		}
	}		}



	=== Recommended: the entity definition ===		=== Recommended: the entity definition ===

Dragofer: /* The script */

2020-12-27T17:47:31Z

The script

← Older revision		Revision as of 17:47, 27 December 2020
Line 164:		Line 164:
	{		{
	sys.wait(getFloatKey("delay")); //wait for "delay" seconds before running the script		sys.wait(getFloatKey("delay")); //wait for "delay" seconds before running the script

	float i; //used for cycling through all targets of this entity with for()		float i; //used for cycling through all targets of this entity with for()
	entity target; //a target of this entity		entity target; //a target of this entity

Dragofer: /* The script */

2020-12-27T17:47:08Z

The script

← Older revision		Revision as of 17:47, 27 December 2020
Line 152:		Line 152:
	void unbind_targets(); //performs the unbinding		void unbind_targets(); //performs the unbinding

	//~~Define all variables~~		//SPAWNARGS
	~~entity target;~~ //~~a target of this entity~~		//delay //wait this amount before performing the unbind; value comes from a spawnarg
	~~float i; //used for cycling through all targets of this entity~~
	~~float~~ delay; //wait this amount before performing the unbind; value comes from a spawnarg
	}; //semicolon needed after the closing curly bracket of a scriptobject definition		}; //semicolon needed after the closing curly bracket of a scriptobject definition

Line 161:		Line 159:
	{		{
	sys.onSignal(SIG_TRIGGER, self, "unbind_targets"); //when receiving a trigger signal on this entity, call the script unbind_targets() (contained in this scriptobject)		sys.onSignal(SIG_TRIGGER, self, "unbind_targets"); //when receiving a trigger signal on this entity, call the script unbind_targets() (contained in this scriptobject)
	~~delay = getFloatKey("delay"); //retrieve a spawnarg value on self. "self" is implied, since it's a scriptobject~~
	}		}

	void target_unbind::unbind_targets() //performs the unbinding		void target_unbind::unbind_targets() //performs the unbinding
	{		{
	sys.wait(delay); //wait for "delay" seconds before running the script		sys.wait(getFloatKey("delay")); //wait for "delay" seconds before running the script

			float i; //used for cycling through all targets of this entity with for()
			entity target; //a target of this entity

	for (i = 0; i < numTargets() ; i++) //repeat for every target of this entity		for (i = 0; i < numTargets() ; i++) //repeat for every target of this entity

Dragofer at 17:45, 27 December 2020

2020-12-27T17:45:03Z

← Older revision		Revision as of 17:45, 27 December 2020
Line 122:		Line 122:
	Then:		Then:
	if ( fountain.active ) sys.println(fountain + " is ready to heal the player.");		if ( fountain.active ) sys.println(fountain + " is ready to heal the player.");
			* A further option is to create scripts in the scriptobject that return the current value of a specific variable, similar to a script event. See [[A to Z Scripting: Utility scripts]] for more on using "return" for this purpose.