Guide to snpc - История изменений

imported>Denton: adds removed content category

2018-11-13T20:03:56Z

adds removed content category

← Предыдущая версия		Версия от 20:03, 13 ноября 2018
Строка 57:		Строка 57:
	** TRAIT_* are bitflags that can be used to give the NPC special checks, such as always stealing things (TRAIT_THIEVING) or never fighting (TRAIT_FRIENDLY)		** TRAIT_* are bitflags that can be used to give the NPC special checks, such as always stealing things (TRAIT_THIEVING) or never fighting (TRAIT_FRIENDLY)

			[[Category:Removed Content]]

	~~{{Contribution guides}}~~
	[[Category:~~Game Resources]] [[Category:Guides~~]]

imported>Denton: added PR reference to SNPC removal

2018-11-13T20:02:22Z

added PR reference to SNPC removal

← Предыдущая версия		Версия от 20:02, 13 ноября 2018
Строка 1:		Строка 1:
	{{Important		{{Important
	\|Title=SNPCs have been removed		\|Title=SNPCs have been removed
	\|Note=As of 28-02-18, SNPCs have been removed from /tg/station. This page is maintained as a historical archive.}}		\|Note=As of 28-02-18, SNPCs have been removed from /tg/station. This page is maintained as a historical archive.<br>See the Pull Request here: [https://github.com/tgstation/tgstation/pull/36016 #36016]}}

	==Writing a SNPC module==		==Writing a SNPC module==

imported>Denton: adds notice that SNPCs are kill

2018-11-13T20:01:08Z

adds notice that SNPCs are kill

← Предыдущая версия		Версия от 20:01, 13 ноября 2018
Строка 1:		Строка 1:
			{{Important
			\|Title=SNPCs have been removed
			\|Note=As of 28-02-18, SNPCs have been removed from /tg/station. This page is maintained as a historical archive.}}

	==Writing a SNPC module==		==Writing a SNPC module==
	Writing a module for an SNPC is easy, but several things need to be kept in mind for optimum process:		Writing a module for an SNPC is easy, but several things need to be kept in mind for optimum process:

imported>Oranges: Categories

2015-01-07T03:26:27Z

imported>Oranges: Unbalanced titles meme

2015-01-07T03:23:41Z

Unbalanced titles meme

← Предыдущая версия		Версия от 03:23, 7 января 2015
Строка 34:		Строка 34:
	*Most interaction that NPCs do with the world should use target_filter(var/target) and denied_filter(var/denied) to check if they are valid targets.		*Most interaction that NPCs do with the world should use target_filter(var/target) and denied_filter(var/denied) to check if they are valid targets.

	===Doing Var==		===Doing Var===
	*The "doing" var has three distinct flags that are checked and changed for what the NPC is doing.		*The "doing" var has three distinct flags that are checked and changed for what the NPC is doing.
	** INTERACTING: defines that an NPC is interacting with something.		** INTERACTING: defines that an NPC is interacting with something.

imported>Oranges: Rformatatat

2015-01-07T03:23:00Z

Rformatatat

← Предыдущая версия		Версия от 03:23, 7 января 2015
Строка 1:		Строка 1:
	~~writing~~ a module for an SNPC is easy, but several things need to be kept in mind for optimum process:		==Writing a SNPC module==
			Writing a module for an SNPC is easy, but several things need to be kept in mind for optimum process:
	*Modules are processed in a linear, but staggered fashion (from left to right in the /list/functions).		*Modules are processed in a linear, but staggered fashion (from left to right in the /list/functions).
	*Modules use sleep(1) to run them, and thus they are queued behind each other in the execution time.		*Modules use sleep(1) to run them, and thus they are queued behind each other in the execution time.
	*Modules that interrupt normal function, or edit NPC vars, should use isNotFunc() as the first proc, else strange problems will occur.		*Modules that interrupt normal function, or edit NPC vars, should use isNotFunc() as the first proc, else strange problems will occur.

			==Item Handling==
	Item handling (such as keeping hands free, putting in bags etc) should be mostly done by the main loop, so it is safe to just call take_to_slot(/obj/item), and the NPC does the rest.		Item handling (such as keeping hands free, putting in bags etc) should be mostly done by the main loop, so it is safe to just call take_to_slot(/obj/item), and the NPC does the rest.

			==Existing Modules==
	It has several pre-made modules, which are as follows:		It has several pre-made modules, which are as follows:
	* Nearbyscan: keeps a list of nearby mobs.		* Nearbyscan: keeps a list of nearby mobs.
Строка 13:		Строка 16:
	* Chatter: handles bot responses and random chatter.		* Chatter: handles bot responses and random chatter.

			==NPC traits==
	NPCs can be "varied" from each other in several ways:		NPCs can be "varied" from each other in several ways:
	* The five "trait" vars, which are set from 1 - 100, used as prob(trait):		* The five "trait" vars, which are set from 1 - 100, used as prob(trait):
Строка 21:		Строка 25:
	* Greytide: A 1/0 bool, Overrides most behaviour and causes the NPC to act like a "greytider", breaking things and hurting people.		* Greytide: A 1/0 bool, Overrides most behaviour and causes the NPC to act like a "greytider", breaking things and hurting people.

			==NPC base functions==
	Accessing NPC base functions and controlling them:		Accessing NPC base functions and controlling them:
	*Overall, the NPC uses the var "interest" to determine how long they have been doing something, if interest peaks under certain amounts, the NPC will shift to doing something else. Interest goes up while the "doing" var is not equal 0 (has bitflags assigned).		*Overall, the NPC uses the var "interest" to determine how long they have been doing something, if interest peaks under certain amounts, the NPC will shift to doing something else. Interest goes up while the "doing" var is not equal 0 (has bitflags assigned).

	*NPCs keep track of their ID and their PDA using the MYID and MYPDA variables. These are direct references to the items, and can be used to activate, unlock/lock, and do all things both would do in general.		*NPCs keep track of their ID and their PDA using the MYID and MYPDA variables. These are direct references to the items, and can be used to activate, unlock/lock, and do all things both would do in general.

	*NPCs also keep track of what is their hands in a "smart" way. The variables "main_hand" and "other_hand" reference the l_hand and r_hand of the NPC, but are shifted (and can be forced using enforce_hands()) when then NPC drops items, changes items etc, to make sure there is always something in the main_hand. The var "update_hands" can be set to 1 to force a recheck of hands (such as when picking items up)		*NPCs also keep track of what is their hands in a "smart" way. The variables "main_hand" and "other_hand" reference the l_hand and r_hand of the NPC, but are shifted (and can be forced using enforce_hands()) when then NPC drops items, changes items etc, to make sure there is always something in the main_hand. The var "update_hands" can be set to 1 to force a recheck of hands (such as when picking items up)

	*NPCs have two variables, TARGET and LAST_TARGET, which are used primarly for combat recognition. Setting TARGET to anything other than null will cause the Combat module to attempt to fight that target. LAST_TARGET is the last var TARGET has been set to. Additionally, the var "retal_target" refers to the last person to attack the NPC.		*NPCs have two variables, TARGET and LAST_TARGET, which are used primarly for combat recognition. Setting TARGET to anything other than null will cause the Combat module to attempt to fight that target. LAST_TARGET is the last var TARGET has been set to. Additionally, the var "retal_target" refers to the last person to attack the NPC.

	*NPCs have a custom travel proc, tryWalk(var/turf), which will attempt to walk them to the target. In cases where you want to force them to walk (such as sidestepping in combat, dancing etc), use walk2derpless(var/target) directly.		*NPCs have a custom travel proc, tryWalk(var/turf), which will attempt to walk them to the target. In cases where you want to force them to walk (such as sidestepping in combat, dancing etc), use walk2derpless(var/target) directly.

	*Most interaction that NPCs do with the world should use target_filter(var/target) and denied_filter(var/denied) to check if they are valid targets.		*Most interaction that NPCs do with the world should use target_filter(var/target) and denied_filter(var/denied) to check if they are valid targets.

			===Doing Var==
	*The "doing" var has three distinct flags that are checked and changed for what the NPC is doing.		*The "doing" var has three distinct flags that are checked and changed for what the NPC is doing.
	** INTERACTING: defines that an NPC is interacting with something.		** INTERACTING: defines that an NPC is interacting with something.
Строка 40:		Строка 41:
	** "doing" is a bitflag and can be changed with doing \|= flag to add a flag, or doing = ~doing&flag to remove one.		** "doing" is a bitflag and can be changed with doing \|= flag to add a flag, or doing = ~doing&flag to remove one.

	Designing a ~~Module:~~		==Designing a module==
	*Modules should not interrupt the flow of other modules, nor should they try to take precidence. Treat modules as an extra "task" for the NPC, Like crafting an item or opening a door.		*Modules should not interrupt the flow of other modules, nor should they try to take precidence. Treat modules as an extra "task" for the NPC, Like crafting an item or opening a door.
			**Modules handling Inventory items should make use of take_to_slot(var/obj) and insert_into_backpack() to do automated handling of item and hands.
			*Once a module is created, add it to the var/list/functions and it will be automatically executed.

			==Misc variable==
	*Several Variables exist for ease of use, these include:		*Several Variables exist for ease of use, these include:
	** MAX_RANGE_FIND and MIN_RANGE_FIND are the Max/Min range an NPC searches for things.		** MAX_RANGE_FIND and MIN_RANGE_FIND are the Max/Min range an NPC searches for things.
Строка 48:		Строка 52:
	** CHANCE_TALK is the probability the NPC will say things.		** CHANCE_TALK is the probability the NPC will say things.
	** TRAIT_* are bitflags that can be used to give the NPC special checks, such as always stealing things (TRAIT_THIEVING) or never fighting (TRAIT_FRIENDLY)		** TRAIT_* are bitflags that can be used to give the NPC special checks, such as always stealing things (TRAIT_THIEVING) or never fighting (TRAIT_FRIENDLY)

	**Modules handling Inventory items should make use of take_to_slot(var/obj) and insert_into_backpack() to do automated handling of item and hands.

	*Once a module is created, add it to the var/list/functions and it will be automatically executed.

imported>Oranges: REFORMATTTING

2015-01-07T03:21:05Z

REFORMATTTING

imported>Oranges: Create page

2015-01-07T03:17:24Z

Create page

Новая страница

writing a module for an SNPC is easy, but several things need to be kept in mind for optimum process:
- Modules are processed in a linear, but staggered fashion (from left to right in the /list/functions).
- Modules use sleep(1) to run them, and thus they are queued behind each other in the execution time.
- Modules that interrupt normal function, or edit NPC vars, should use isNotFunc() as the first proc, else
strange problems will occur.

Item handling (such as keeping hands free, putting in bags etc) should be mostly done by the main loop, so it is safe to just call take_to_slot(/obj/item), and the NPC does the rest.

It has several pre-made modules, which are as follows:
- Nearbyscan: keeps a list of nearby mobs.
- Combat: handles all the default combat actions.
- Doorscan: keeps a list of nearby doors.
- Shitcurity: handles using handcuffs on people.
- Chatter: handles bot responses and random chatter.

NPCs can be "varied" from each other in several ways:
- The five "trait" vars, which are set from 1 - 100, used as prob(trait):
- Robustness: Determines how often they should perform a robust action (hit right, break things)
- Smartness: Usually used as a negative (!prob(smartness)), indicates how often they should do "smart" things, like use an object or speak.
- Attitude: Determines how often they will retaliate and/or fight things.
- Slyness: Determines how often they will do "illegal" actions, ie stealing.
- Greytide: A 1/0 bool, Overrides most behaviour and causes the NPC to act like a "greytider", breaking things and hurting people.

Accessing NPC base functions and controlling them:
Overall, the NPC uses the var "interest" to determine how long they have been doing something, if interest
peaks under certain amounts, the NPC will shift to doing something else. Interest goes up while the "doing"
var is not equal 0 (has bitflags assigned).

NPCs keep track of their ID and their PDA using the MYID and MYPDA variables. These are direct references to
the items, and can be used to activate, unlock/lock, and do all things both would do in general.

NPCs also keep track of what is their hands in a "smart" way. The variables "main_hand" and "other_hand"
reference the l_hand and r_hand of the NPC, but are shifted (and can be forced using enforce_hands()) when
then NPC drops items, changes items etc, to make sure there is always something in the main_hand. The var
"update_hands" can be set to 1 to force a recheck of hands (such as when picking items up)

NPCs have two variables, TARGET and LAST_TARGET, which are used primarly for combat recognition. Setting TARGET to anything other than null will cause the Combat module to attempt to fight that target. LAST_TARGET
is the last var TARGET has been set to. Additionally, the var "retal_target" refers to the last person to attack the NPC.

NPCs have a custom travel proc, tryWalk(var/turf), which will attempt to walk them to the target. In cases
where you want to force them to walk (such as sidestepping in combat, dancing etc), use
walk2derpless(var/target) directly.

Most interaction that NPCs do with the world should use target_filter(var/target) and
denied_filter(var/denied) to check if they are valid targets.

The "doing" var has three distinct flags that are checked and changed for what the NPC is doing.
- INTERACTING: defines that an NPC is interacting with something.
- FIGHTING: defines that an NPC is in combat.
- TRAVEL: defines that an NPC is moving from one location to another.
"doing" is a bitflag and can be changed with doing |= flag to add a flag, or doing = ~doing&flag to remove one.

Designing a Module:
Modules should not interrupt the flow of other modules, nor should they try to take precidence. Treat modules as an extra "task" for the NPC, Like crafting an item or opening a door.

Several Variables exist for ease of use, these include:
- MAX_RANGE_FIND and MIN_RANGE_FIND are the Max/Min range an NPC searches for things.
- FUZZY_CHANCE_HIGH and FUZZY_CHANCE LOW are the high and low for a lot of NPC probability
that isn't trait related roll.
- CHANCE_TALK is the probability the NPC will say things.
- TRAIT_* are bitflags that can be used to give the NPC special checks, such as always
stealing things (TRAIT_THIEVING) or never fighting (TRAIT_FRIENDLY)

Modules handling Inventory items should make use of take_to_slot(var/obj) and insert_into_backpack()
to do automated handling of item and hands.

Once a module is created, add it to the var/list/functions and it will be automatically executed.

← Предыдущая версия		Версия от 03:26, 7 января 2015
Строка 52:		Строка 52:
	** CHANCE_TALK is the probability the NPC will say things.		** CHANCE_TALK is the probability the NPC will say things.
	** TRAIT_* are bitflags that can be used to give the NPC special checks, such as always stealing things (TRAIT_THIEVING) or never fighting (TRAIT_FRIENDLY)		** TRAIT_* are bitflags that can be used to give the NPC special checks, such as always stealing things (TRAIT_THIEVING) or never fighting (TRAIT_FRIENDLY)



			{{Contribution guides}}
			[[Category:Game Resources]] [[Category:Guides]]

← Предыдущая версия		Версия от 03:21, 7 января 2015
Строка 1:		Строка 1:
	writing a module for an SNPC is easy, but several things need to be kept in mind for optimum process:		writing a module for an SNPC is easy, but several things need to be kept in mind for optimum process:
	- Modules are processed in a linear, but staggered fashion (from left to right in the /list/functions).		*Modules are processed in a linear, but staggered fashion (from left to right in the /list/functions).
	- Modules use sleep(1) to run them, and thus they are queued behind each other in the execution time.		*Modules use sleep(1) to run them, and thus they are queued behind each other in the execution time.
	- Modules that interrupt normal function, or edit NPC vars, should use isNotFunc() as the first proc, else		*Modules that interrupt normal function, or edit NPC vars, should use isNotFunc() as the first proc, else strange problems will occur.
	strange problems will occur.


	Item handling (such as keeping hands free, putting in bags etc) should be mostly done by the main loop, so it is safe to just call take_to_slot(/obj/item), and the NPC does the rest.		Item handling (such as keeping hands free, putting in bags etc) should be mostly done by the main loop, so it is safe to just call take_to_slot(/obj/item), and the NPC does the rest.

	It has several pre-made modules, which are as follows:		It has several pre-made modules, which are as follows:
	- Nearbyscan: keeps a list of nearby mobs.		* Nearbyscan: keeps a list of nearby mobs.
	- Combat: handles all the default combat actions.		* Combat: handles all the default combat actions.
	- Doorscan: keeps a list of nearby doors.		* Doorscan: keeps a list of nearby doors.
	- Shitcurity: handles using handcuffs on people.		* Shitcurity: handles using handcuffs on people.
	- Chatter: handles bot responses and random chatter.		* Chatter: handles bot responses and random chatter.

	NPCs can be "varied" from each other in several ways:		NPCs can be "varied" from each other in several ways:
	- The five "trait" vars, which are set from 1 - 100, used as prob(trait):		* The five "trait" vars, which are set from 1 - 100, used as prob(trait):
	- Robustness: Determines how often they should perform a robust action (hit right, break things)		* Robustness: Determines how often they should perform a robust action (hit right, break things)
	- Smartness: Usually used as a negative (!prob(smartness)), indicates how often they should do "smart" things, like use an object or speak.		* Smartness: Usually used as a negative (!prob(smartness)), indicates how often they should do "smart" things, like use an object or speak.
	- Attitude: Determines how often they will retaliate and/or fight things.		* Attitude: Determines how often they will retaliate and/or fight things.
	- Slyness: Determines how often they will do "illegal" actions, ie stealing.		* Slyness: Determines how often they will do "illegal" actions, ie stealing.
	- Greytide: A 1/0 bool, Overrides most behaviour and causes the NPC to act like a "greytider", breaking things and hurting people.		* Greytide: A 1/0 bool, Overrides most behaviour and causes the NPC to act like a "greytider", breaking things and hurting people.

	Accessing NPC base functions and controlling them:		Accessing NPC base functions and controlling them:
	Overall, the NPC uses the var "interest" to determine how long they have been doing something, if interest		*Overall, the NPC uses the var "interest" to determine how long they have been doing something, if interest peaks under certain amounts, the NPC will shift to doing something else. Interest goes up while the "doing" var is not equal 0 (has bitflags assigned).
	peaks under certain amounts, the NPC will shift to doing something else. Interest goes up while the "doing"
	var is not equal 0 (has bitflags assigned).

	NPCs keep track of their ID and their PDA using the MYID and MYPDA variables. These are direct references to		*NPCs keep track of their ID and their PDA using the MYID and MYPDA variables. These are direct references to the items, and can be used to activate, unlock/lock, and do all things both would do in general.
	the items, and can be used to activate, unlock/lock, and do all things both would do in general.

	NPCs also keep track of what is their hands in a "smart" way. The variables "main_hand" and "other_hand"		*NPCs also keep track of what is their hands in a "smart" way. The variables "main_hand" and "other_hand" reference the l_hand and r_hand of the NPC, but are shifted (and can be forced using enforce_hands()) when then NPC drops items, changes items etc, to make sure there is always something in the main_hand. The var "update_hands" can be set to 1 to force a recheck of hands (such as when picking items up)
	reference the l_hand and r_hand of the NPC, but are shifted (and can be forced using enforce_hands()) when
	then NPC drops items, changes items etc, to make sure there is always something in the main_hand. The var
	"update_hands" can be set to 1 to force a recheck of hands (such as when picking items up)

	NPCs have two variables, TARGET and LAST_TARGET, which are used primarly for combat recognition. Setting TARGET to anything other than null will cause the Combat module to attempt to fight that target. LAST_TARGET		*NPCs have two variables, TARGET and LAST_TARGET, which are used primarly for combat recognition. Setting TARGET to anything other than null will cause the Combat module to attempt to fight that target. LAST_TARGET is the last var TARGET has been set to. Additionally, the var "retal_target" refers to the last person to attack the NPC.
	is the last var TARGET has been set to. Additionally, the var "retal_target" refers to the last person to attack the NPC.

	NPCs have a custom travel proc, tryWalk(var/turf), which will attempt to walk them to the target. In cases		*NPCs have a custom travel proc, tryWalk(var/turf), which will attempt to walk them to the target. In cases where you want to force them to walk (such as sidestepping in combat, dancing etc), use walk2derpless(var/target) directly.
	where you want to force them to walk (such as sidestepping in combat, dancing etc), use
	walk2derpless(var/target) directly.

	Most interaction that NPCs do with the world should use target_filter(var/target) and		*Most interaction that NPCs do with the world should use target_filter(var/target) and denied_filter(var/denied) to check if they are valid targets.
	denied_filter(var/denied) to check if they are valid targets.

	The "doing" var has three distinct flags that are checked and changed for what the NPC is doing.		*The "doing" var has three distinct flags that are checked and changed for what the NPC is doing.
	- INTERACTING: defines that an NPC is interacting with something.		** INTERACTING: defines that an NPC is interacting with something.
	- FIGHTING: defines that an NPC is in combat.		** FIGHTING: defines that an NPC is in combat.
	- TRAVEL: defines that an NPC is moving from one location to another.		** TRAVEL: defines that an NPC is moving from one location to another.
	"doing" is a bitflag and can be changed with doing \|= flag to add a flag, or doing = ~doing&flag to remove one.		** "doing" is a bitflag and can be changed with doing \|= flag to add a flag, or doing = ~doing&flag to remove one.

	Designing a Module:		Designing a Module:
	Modules should not interrupt the flow of other modules, nor should they try to take precidence. Treat modules as an extra "task" for the NPC, Like crafting an item or opening a door.		*Modules should not interrupt the flow of other modules, nor should they try to take precidence. Treat modules as an extra "task" for the NPC, Like crafting an item or opening a door.

	Several Variables exist for ease of use, these include:		*Several Variables exist for ease of use, these include:
	- MAX_RANGE_FIND and MIN_RANGE_FIND are the Max/Min range an NPC searches for things.		** MAX_RANGE_FIND and MIN_RANGE_FIND are the Max/Min range an NPC searches for things.
	- FUZZY_CHANCE_HIGH and FUZZY_CHANCE LOW are the high and low for a lot of NPC probability		** FUZZY_CHANCE_HIGH and FUZZY_CHANCE LOW are the high and low for a lot of NPC probability that isn't trait related roll.
	that isn't trait related roll.		** CHANCE_TALK is the probability the NPC will say things.
	- CHANCE_TALK is the probability the NPC will say things.		** TRAIT_* are bitflags that can be used to give the NPC special checks, such as always stealing things (TRAIT_THIEVING) or never fighting (TRAIT_FRIENDLY)
	- TRAIT_* are bitflags that can be used to give the NPC special checks, such as always
	stealing things (TRAIT_THIEVING) or never fighting (TRAIT_FRIENDLY)

	Modules handling Inventory items should make use of take_to_slot(var/obj) and insert_into_backpack()		**Modules handling Inventory items should make use of take_to_slot(var/obj) and insert_into_backpack() to do automated handling of item and hands.
	to do automated handling of item and hands.

	Once a module is created, add it to the var/list/functions and it will be automatically executed.		*Once a module is created, add it to the var/list/functions and it will be automatically executed.