Tribe Scripting - Revision history

Talad: /* SpawnMember */

2026-01-05T17:09:02Z

SpawnMember

← Older revision		Revision as of 17:09, 5 January 2026
Line 455:		Line 455:

	== SpawnMember ==		== SpawnMember ==
	Syntax: spawnMember(x);		Syntax: spawnMember(x,y);

	Arguments:		Arguments:
	* 'x' is an integer and the ID of the master NPC to clone and spawn		* 'x' is an integer and the ID of the master NPC to clone and spawn
			* 'y' is a string identifying the type of member (example Warrior, Miner, Hunter, ...)

	Effect & Mechanics: This function spawns a new member of the tribe, without requiring anything else, in contrast with mate() that requires an existing member to spawn another member. This function can be used to create the first member of the tribe.		Effect & Mechanics: This function spawns a new member of the tribe, without requiring anything else, in contrast with mate() that requires an existing member to spawn another member. This function can be used to create the first member of the tribe.
Line 464:		Line 465:
	Example:		Example:

	"Consumer Evolve Tribe" recipe with requirements: tribesman(~~number~~,1,Consumer Ancestor Spawn);		"Consumer Evolve Tribe" recipe with requirements: tribesman(Warrior,1,Consumer Ancestor Spawn);

	"Consumer Ancestor Spawn" recipe with no requirements and script: spawnMember(42);		"Consumer Ancestor Spawn" recipe with no requirements and script: spawnMember(42, Warrior);

	IMPORTANT: The master NPC ID, should be created in characters table + there must be an entry for this NPC in sc_npc_definitions table, with the AbstractTribesman. This will properly initialize the member of the tribe.		IMPORTANT: The master NPC ID, should be created in characters table + there must be an entry for this NPC in sc_npc_definitions table, with the AbstractTribesman. This will properly initialize the member of the tribe.

Talad: /* SpawnMember */

2026-01-04T18:38:18Z

SpawnMember

← Older revision		Revision as of 18:38, 4 January 2026
Line 466:		Line 466:
	"Consumer Evolve Tribe" recipe with requirements: tribesman(number,1,Consumer Ancestor Spawn);		"Consumer Evolve Tribe" recipe with requirements: tribesman(number,1,Consumer Ancestor Spawn);

	"Consumer Ancestor Spawn" recipe with no requirements and script: spawnMember(~~156~~);		"Consumer Ancestor Spawn" recipe with no requirements and script: spawnMember(42);

			IMPORTANT: The master NPC ID, should be created in characters table + there must be an entry for this NPC in sc_npc_definitions table, with the AbstractTribesman. This will properly initialize the member of the tribe.

	== Wait ==		== Wait ==

Talad: /* Algorithm Steps */

2026-01-03T23:16:08Z

Algorithm Steps

@@ Line 453: / Line 453: @@
 In a NPC behavior:
   <wait duration="$NBUFFER[Work_Time]" />
 == Wait ==

Talad: /* Requirements */

2023-10-03T19:59:05Z

Requirements

← Older revision		Revision as of 19:59, 3 October 2023
Line 140:		Line 140:
	== Tribesman ==		== Tribesman ==

	Syntax 1: tribesman(x,y,r);		Syntax: tribesman(x,y,r);

	~~Syntax 2~~: tribesman(number,y,r);		Arguments:
			* x is a tribesman type (types are not well-defined at the moment). Keyword 'any' is accepted too in order to define any member.
			* y is an int defining the number of tribesmen needed
			*r is the recipe needed to spawn a new member if not enough members are found

			Effect & Mechanics: The tribal object checks for a number 'y' of tribesman typed 'x' regardless if they are busy or doing something else. If 'y' members are found, the requirement is considered met.

			== TribesmanIdle ==

			Syntax: tribesmanidle(x,y,r);

	Arguments:		Arguments:
	* x is a tribesman type (types are not well-defined at the moment). Keyword 'any' is accepted too in order to define any member~~. Keyword 'number' is accepted~~.		* x is a tribesman type (types are not well-defined at the moment). Keyword 'any' is accepted too in order to define any member.
	* y is an int defining the number of tribesmen needed		* y is an int defining the number of tribesmen needed
	*r is the recipe needed to spawn a new member if not ~~available~~		*r is the recipe needed to spawn a new member if not enough members are found

	Effect & Mechanics: The tribal object checks for a number 'y' of tribesman typed 'x' with the current behavior equal to the tribe's idle behavior. (e.g. "do nothing" behavior) If 'y' members are found idle, the requirement is considered met.		Effect & Mechanics: The tribal object checks for a number 'y' of tribesman typed 'x' with the current behavior equal to the tribe's idle behavior. (e.g. "do nothing" behavior) If 'y' members are found idle, the requirement is considered met.

	~~If x = number, then check if total members is the one specified in y (we don't care if their idle or not)~~

	== Resource ==		== Resource ==

Talad: /* Tribesman */

2023-10-03T12:33:22Z

Tribesman

← Older revision		Revision as of 12:33, 3 October 2023
Line 140:		Line 140:
	== Tribesman ==		== Tribesman ==

	Syntax: tribesman(x,y);		Syntax 1: tribesman(x,y,r);

			Syntax 2: tribesman(number,y,r);

	Arguments:		Arguments:
	* x is a tribesman type (types are not well-defined at the moment). Keyword 'any' is accepted too in order to define any member.		* x is a tribesman type (types are not well-defined at the moment). Keyword 'any' is accepted too in order to define any member. Keyword 'number' is accepted.
	* y is an int defining the number of tribesmen needed		* y is an int defining the number of tribesmen needed
			*r is the recipe needed to spawn a new member if not available

	Effect & Mechanics: The tribal object checks for a number 'y' of tribesman typed 'x' with the current behavior equal to the tribe's idle behavior. (e.g. "do nothing" behavior) If 'y' members are found idle, the requirement is considered met.		Effect & Mechanics: The tribal object checks for a number 'y' of tribesman typed 'x' with the current behavior equal to the tribe's idle behavior. (e.g. "do nothing" behavior) If 'y' members are found idle, the requirement is considered met.

			If x = number, then check if total members is the one specified in y (we don't care if their idle or not)

	== Resource ==		== Resource ==

Talad: /* LocateBuildingSpot */

2023-10-02T20:09:24Z

LocateBuildingSpot

@@ Line 304: / Line 304: @@
 Effect & Mechanics: This function works like the above-mentioned 'locateMemory' function. The sole difference is that this function tries to locate resource 'x', and it case it fails it tries to locate memories 'mine' or 'field'. (which are the standard names of unprospected/undiscovered resource zones). In case nor 'mine' or 'field' are found, it sends the previous selected npcs to explore for them.
 == LocateBuildingSpot ==
@@ Line 312: / Line 327: @@
 * 'x' is a building name.
-Effect & Mechanics: This functions locates a building spot previously reserved via 'reserveBuildingSpot' function. It searches for building spots in the asset array and set the selected assess in the npc building spot asset. The NPC can use the [[Behavior_Operations#Build Operation|Build Operation]] to build a building at the selected spot.  NBUFFER[Building] is set to x, and NBUFFER[Work_Duration] is set to the building time of the building.
+Effect & Mechanics: This functions locates a building spot previously reserved via 'reserveBuildingSpot' function. It searches for building spots in the asset array and set the selected assess in the npc "building_spot" variable.
 Example Tribe Script:

Talad: /* Tribe Info */

2023-09-28T21:53:15Z

Tribe Info

← Older revision		Revision as of 21:53, 28 September 2023
Line 37:		Line 37:
	Let's consider an example of a tribe which has some building spots available and the task to build on those spots.		Let's consider an example of a tribe which has some building spots available and the task to build on those spots.

	~~<uml>~~
	~~scale 0.8~~
	~~TribalRecipe *-- BuildingSpots~~
	~~TribalRecipe *-- ThreeBuildings~~
	~~ThreeBuildings *-- Breed : Not enough members~~
	~~Breed *-- GatherFood : Not enough food~~
	~~ThreeBuildings *-- GatherWood: Not enough wood~~
	~~ThreeBuildings *-- GatherStone: Not enough stone~~
	~~ThreeBuildings *-- LearnMasonry : knowledge masonry needed~~
	~~</uml>~~

	Having the tree above, it's easy to select the actions required to complete the task. We first get some more food. After that we get the required members, search for wood and stone, and finally build the buildings.		Having the tree above, it's easy to select the actions required to complete the task. We first get some more food. After that we get the required members, search for wood and stone, and finally build the buildings.
Line 77:		Line 67:
	Mechanics: Upon parsing this function, an extra reaction is added to the tribal npctype in respect of this function's argument.		Mechanics: Upon parsing this function, an extra reaction is added to the tribal npctype in respect of this function's argument.

	== ~~LoadRecipe~~ ==		== Growth ==
			Syntax: growth(x)
	Syntax: ~~loadRecipe(x); loadRecipe~~(x~~,distributed~~);

	Arguments:		Arguments:
	* 'x' is a Recipe Name

	~~Effect: Loads a recipe into the recipe tree. The new recipe's priority will be the current recipe's priority + 1.~~		* x in ?

	~~== LoadCyclicRecipe ==~~		Not implemented , at the moment all tribes have "conservatory" as value

	Syntax: ~~loadCyclicRecipe~~(x,t);		== Unity ==
			Syntax: unity(x)

	Arguments:		Arguments:
	* 'x' is a Recipe Name
	* 't' is an int, representing the number of ticks (milliseconds) between recipe executions

	~~Effect: Loads a recipe into~~ the ~~recipe tree once every 't' ticks, with highest priority~~.		* x in {*, cowards}

			At the moment anything but "cowards" will trigger one member of the tribe to help another member when attacked.

	== SleepPeriod ==		== SleepPeriod ==
Line 116:		Line 105:

	Mechanics: Upon parsing this function, an extra reaction is added to the tribal npctype. The reaction should react to timeofday perceptions.		Mechanics: Upon parsing this function, an extra reaction is added to the tribal npctype. The reaction should react to timeofday perceptions.

			== LoadRecipe ==

			Syntax: loadRecipe(x); loadRecipe(x,distributed);

			Arguments:
			* 'x' is a Recipe Name

			Effect: Loads a recipe into the recipe tree. The new recipe's priority will be the current recipe's priority + 1.

			== LoadCyclicRecipe ==

			Syntax: loadCyclicRecipe(x,t);

			Arguments:
			* 'x' is a Recipe Name
			* 't' is an int, representing the number of ticks (milliseconds) between recipe executions

			Effect: Loads a recipe into the recipe tree once every 't' ticks, with highest priority.

	= Requirements =		= Requirements =

Eonwind at 12:20, 4 November 2016

2016-11-04T12:20:17Z

← Older revision		Revision as of 12:20, 4 November 2016
Line 118:		Line 118:

	= Requirements =		= Requirements =

			== Building ==

			Syntax: building(x,y,r);

			Arguments:
			* 'x' is a building name.
			* 'y' is an int defining the quantity of buildings needed.
			* 'r' is the recipe needed to get the building if not available

			Effect & Mechanics: At the moment, items are 'magically' stored inside the tribal object. This object keeps track on items and buildings with the 'Asset' structure. 'x' can be any string with the condition that the tribe can actually gain the requested asset. Otherwise the requirement will never be met. Upon parsing this requirement, the tribal object checks it's asset arrays for the building 'x' of quantity 'y'.

	== Tribesman ==		== Tribesman ==

Eonwind: /* Percept */

2016-03-25T09:26:11Z

Percept

← Older revision		Revision as of 09:26, 25 March 2016
Line 348:		Line 348:

	Examples:		Examples:
			select(any,1);
	percept(selection,tribe:gather)		percept(selection,tribe:gather)
	percept(tribe,tribe:flee)		percept(tribe,tribe:flee)

Eonwind: /* LoadCyclicRecipe */

2016-03-25T09:23:17Z

LoadCyclicRecipe

← Older revision		Revision as of 09:23, 25 March 2016
Line 92:		Line 92:
	Arguments:		Arguments:
	* 'x' is a Recipe Name		* 'x' is a Recipe Name
	* 't' is an int, representing the number of ticks between recipe executions		* 't' is an int, representing the number of ticks (milliseconds) between recipe executions

	Effect: Loads a recipe into the recipe tree once every 't' ticks, with highest priority.		Effect: Loads a recipe into the recipe tree once every 't' ticks, with highest priority.