Osiris/Shared/DB CheckPoint - Revision history

Tinkerer at 09:31, 26 February 2018

2018-02-26T09:31:21Z

← Older revision		Revision as of 09:31, 26 February 2018
Line 6:		Line 6:
	* '''PROC_CheckPointDialogue'''(''(CHARACTERGUID)'''''_Player''', ''(CHARACTERGUID)'''''_Guard''')		* '''PROC_CheckPointDialogue'''(''(CHARACTERGUID)'''''_Player''', ''(CHARACTERGUID)'''''_Guard''')
	===== Description =====		===== Description =====
	Defines a checkpoint situation with two guards. Both guards must have the ''GLO_SneakSpotter'' script assigned. When a player enters '''_PermissionWarningTrigger''' without permission (see later), '''PROC_CheckPointDialogue'''('''_Player''', '''_Guard1''') will be called, with the character flag '''''GLO_CP_WarningSomeone''''' set on '''_Guard1'''. You have to overload and implement this routine for any guard this routine may be called for. Usually, you will just want to call [[Osiris/Shared/Proc_StartDialog\|Proc_StartDialog]]('''''0''''', '''''GuardDialog''''', '''''CHARACTERGUID_SomeGuard_UUID''''', '''_Player''') from that proc. You can use the '''''GLO_CP_WarningSomeone''''' flag that's set on the guard in your dialog to check the dialog has been started because of a checkpoint infraction. This flag gets removed from the guard after their dialog ends.		Defines a checkpoint situation with two guards. Both guards must have the ''GLO_SneakSpotter'' script assigned. When a player enters '''_PermissionWarningTrigger''' without permission (see later), '''PROC_CheckPointDialogue'''('''_Player''', '''_Guard1''') will be called, with the character flag '''''GLO_CP_WarningSomeone''''' set on '''_Guard1'''. You have to overload and implement this routine for any guard this routine may be called for. Usually, you will just want to call [[Osiris/Shared/Proc_StartDialog\|Proc_StartDialog]]('''''0''''', '''''GuardDialog''''', '''''CHARACTERGUID_SomeGuard_UUID''''', '''_Player''') from that proc. You can use the '''''GLO_CP_WarningSomeone''''' flag that's set on the guard in your dialog to check whether the dialog has been started because of a checkpoint infraction (in case it is also used as a default dialog). This flag gets removed from the guard after their dialog ends.

	Similarly, when a player enters '''_EnterWarningTrigger''' without permission, the same happens with '''_Guard2'''.		Similarly, when a player enters '''_EnterWarningTrigger''' without permission, the same happens with '''_Guard2'''.

Tinkerer at 09:29, 26 February 2018

2018-02-26T09:29:03Z

← Older revision		Revision as of 09:29, 26 February 2018
Line 6:		Line 6:
	* '''PROC_CheckPointDialogue'''(''(CHARACTERGUID)'''''_Player''', ''(CHARACTERGUID)'''''_Guard''')		* '''PROC_CheckPointDialogue'''(''(CHARACTERGUID)'''''_Player''', ''(CHARACTERGUID)'''''_Guard''')
	===== Description =====		===== Description =====
	Defines a checkpoint situation with two guards. Both guards must have the ''GLO_SneakSpotter'' script assigned. When a player enters '''_PermissionWarningTrigger''' without permission (see later), '''PROC_CheckPointDialogue'''('''_Player''', '''_Guard1''') will be called, with the character flag '''''GLO_CP_WarningSomeone''''' set on '''_Guard1'''. You have to overload and implement this routine for any guard this routine may be called for. Usually, you will just want to call [[Osiris/Shared/Proc_StartDialog\|Proc_StartDialog]]('''''0''''', '''''GuardDialog''''', '''''CHARACTERGUID_SomeGuard_UUID''''', '''_Player''') from that proc. ~~Before~~ '''~~ProcCheckPointDialogue~~''~~' gets called, the character flag~~ '''~~GLO_CP_WarningSomeone~~''' ~~will be~~ set on the guard ~~it's called for. You can use this~~ in your dialog to check the dialog has been started because of a checkpoint infraction. This flag gets removed from the guard after their dialog ends.		Defines a checkpoint situation with two guards. Both guards must have the ''GLO_SneakSpotter'' script assigned. When a player enters '''_PermissionWarningTrigger''' without permission (see later), '''PROC_CheckPointDialogue'''('''_Player''', '''_Guard1''') will be called, with the character flag '''''GLO_CP_WarningSomeone''''' set on '''_Guard1'''. You have to overload and implement this routine for any guard this routine may be called for. Usually, you will just want to call [[Osiris/Shared/Proc_StartDialog\|Proc_StartDialog]]('''''0''''', '''''GuardDialog''''', '''''CHARACTERGUID_SomeGuard_UUID''''', '''_Player''') from that proc. You can use the '''''GLO_CP_WarningSomeone''''' flag that's set on the guard in your dialog to check the dialog has been started because of a checkpoint infraction. This flag gets removed from the guard after their dialog ends.

	Similarly, when a player enters '''_EnterWarningTrigger''' without permission, the same happens with '''_Guard2'''.		Similarly, when a player enters '''_EnterWarningTrigger''' without permission, the same happens with '''_Guard2'''.

Tinkerer at 14:48, 19 December 2017

2017-12-19T14:48:44Z

← Older revision		Revision as of 14:48, 19 December 2017
Line 19:		Line 19:
	* Helper [[Osiris/Shared/DB_TrespassTrigger\|DB_TrespassTrigger]]		* Helper [[Osiris/Shared/DB_TrespassTrigger\|DB_TrespassTrigger]]

	[[Category:Osiris Shared Mod Helpers]]		[[Category:Osiris Shared Mod Helpers\|CheckPoint]]

Tinkerer: Corrected description of how to start a dialog when someone enters any of the triggers

2017-11-05T16:01:33Z

Corrected description of how to start a dialog when someone enters any of the triggers

← Older revision		Revision as of 16:01, 5 November 2017
Line 4:		Line 4:
	* '''DB_CheckPoint'''(''(CHARACTERGUID)'''''_Guard1''',''(CHARACTERGUID)'''''_Guard2''',''(TRIGGERGUID)'''''_PermissionWarningTrigger,''(TRIGGERGUID)'''''_EnterWarningTrigger''',''(TRIGGERGUID)'''''_EnterAttackTrigger''',''(STRING)'''''_PermissionFlag''')		* '''DB_CheckPoint'''(''(CHARACTERGUID)'''''_Guard1''',''(CHARACTERGUID)'''''_Guard2''',''(TRIGGERGUID)'''''_PermissionWarningTrigger,''(TRIGGERGUID)'''''_EnterWarningTrigger''',''(TRIGGERGUID)'''''_EnterAttackTrigger''',''(STRING)'''''_PermissionFlag''')
	* '''DB_CheckPoint'''(''(CHARACTERGUID)'''''_Guard1''',''(CHARACTERGUID)'''''_Guard2''',''(TRIGGERGUID)'''''_PermissionWarningTrigger,''(TRIGGERGUID)'''''_EnterWarningTrigger''',''(TRIGGERGUID)'''''_EnterAttackTrigger''',''(STRING)'''''_PermissionFlag''',''(STRING)'''''_CustomCrime''')		* '''DB_CheckPoint'''(''(CHARACTERGUID)'''''_Guard1''',''(CHARACTERGUID)'''''_Guard2''',''(TRIGGERGUID)'''''_PermissionWarningTrigger,''(TRIGGERGUID)'''''_EnterWarningTrigger''',''(TRIGGERGUID)'''''_EnterAttackTrigger''',''(STRING)'''''_PermissionFlag''',''(STRING)'''''_CustomCrime''')
			* '''PROC_CheckPointDialogue'''(''(CHARACTERGUID)'''''_Player''', ''(CHARACTERGUID)'''''_Guard''')
	===== Description =====		===== Description =====
	Defines a checkpoint situation with two guards. Both guards must have the ''GLO_SneakSpotter'' script assigned. When a player enters '''_PermissionWarningTrigger''' without permission (see later), '''_Guard1 '''will ~~start his default dialog with the player~~ with the character flag '''''GLO_CP_WarningSomeone''''' set on '''_Guard1''' (~~so you~~ can use ~~a different~~ dialog ~~flow compared~~ to a ~~regular conversation with the guard; the~~ flag removed ~~again when~~ the dialog ends). Similarly, when a player enters '''_EnterWarningTrigger''' without permission, the same happens with '''_Guard2'''. When a player enters '''_EnterAttackTrigger''' without permission, by default the trespass crime will be generated. If '''_CustomCrime''' is specified, this crime will be generated instead. Note that you will also have to [[Generic_behaviour#Defining_Generic_Behaviours\|define this custom crime]] if you want it to do anything.		Defines a checkpoint situation with two guards. Both guards must have the ''GLO_SneakSpotter'' script assigned. When a player enters '''_PermissionWarningTrigger''' without permission (see later), '''PROC_CheckPointDialogue'''('''_Player''', '''_Guard1''') will be called, with the character flag '''''GLO_CP_WarningSomeone''''' set on '''_Guard1'''. You have to overload and implement this routine for any guard this routine may be called for. Usually, you will just want to call [[Osiris/Shared/Proc_StartDialog\|Proc_StartDialog]]('''''0''''', '''''GuardDialog''''', '''''CHARACTERGUID_SomeGuard_UUID''''', '''_Player''') from that proc. Before '''ProcCheckPointDialogue''' gets called, the character flag '''GLO_CP_WarningSomeone''' will be set on the guard it's called for. You can use this in your dialog to check the dialog has been started because of a checkpoint infraction. This flag gets removed from the guard after their dialog ends.

			Similarly, when a player enters '''_EnterWarningTrigger''' without permission, the same happens with '''_Guard2'''.

			When a player enters '''_EnterAttackTrigger''' without permission, by default the '''trespass''' crime will be generated. If '''_CustomCrime''' is specified, this crime will be generated instead. Note that you will also have to [[Generic_behaviour#Defining_Generic_Behaviours\|define this custom crime]] if you want it to do anything.

	'''_PermissionFlag''' is a character flag that can be set on a player to indicate they have permission to enter all of the aforementioned triggers. Typically, this flag can be obtained during the dialog that gets started with '''_Guard1''' when entering '''_PermissionWarningTrigger'''. Once you have this flag, none of the dialogs will be started anymore. If there is no way to obtain permission, specify something like '''''INVALIDFLAG''''' rather than an empty string as '''_PermissionFlag''', as it is not intuitive what the result should be of checking whether an en empty character flag is set.		'''_PermissionFlag''' is a character flag that can be set on a player to indicate they have permission to enter all of the aforementioned triggers. Typically, this flag can be obtained during the dialog that gets started with '''_Guard1''' when entering '''_PermissionWarningTrigger'''. Once you have this flag, none of the dialogs will be started anymore. If there is no way to obtain permission, specify something like '''''INVALIDFLAG''''' rather than an empty string as '''_PermissionFlag''', as it is not intuitive what the result should be of checking whether an en empty character flag is set.

Tinkerer: Mention the fact that this DB is actually in the DivinityOrigins mod rather than in shared

2017-11-03T12:22:49Z

Mention the fact that this DB is actually in the DivinityOrigins mod rather than in shared

← Older revision		Revision as of 12:22, 3 November 2017
Line 1:		Line 1:
			{{warning\|This functionality was accidentally added to the DivinityOrigins mod instead of to the Shared mod. If you wish to use it in a mod that does not depend on the main game, copy the contents of the DivinityOrigins '''GLO_Checkpoints''' story goal to your own mod and ensure it gets [[Osiris_Overview#Goal_Initialisation_and_Completion\|initialised]] before any goal that may define a '''DB_Checkpoint()'''.}}

	===== Full Definition(s) =====		===== Full Definition(s) =====
	* '''DB_CheckPoint'''(''(CHARACTERGUID)'''''_Guard1''',''(CHARACTERGUID)'''''_Guard2''',''(TRIGGERGUID)'''''_PermissionWarningTrigger,''(TRIGGERGUID)'''''_EnterWarningTrigger''',''(TRIGGERGUID)'''''_EnterAttackTrigger''',''(STRING)'''''_PermissionFlag''')		* '''DB_CheckPoint'''(''(CHARACTERGUID)'''''_Guard1''',''(CHARACTERGUID)'''''_Guard2''',''(TRIGGERGUID)'''''_PermissionWarningTrigger,''(TRIGGERGUID)'''''_EnterWarningTrigger''',''(TRIGGERGUID)'''''_EnterAttackTrigger''',''(STRING)'''''_PermissionFlag''')

Tinkerer: Corrected name of character script

2017-11-03T12:12:26Z

Corrected name of character script

← Older revision		Revision as of 12:12, 3 November 2017
Line 3:		Line 3:
	* '''DB_CheckPoint'''(''(CHARACTERGUID)'''''_Guard1''',''(CHARACTERGUID)'''''_Guard2''',''(TRIGGERGUID)'''''_PermissionWarningTrigger,''(TRIGGERGUID)'''''_EnterWarningTrigger''',''(TRIGGERGUID)'''''_EnterAttackTrigger''',''(STRING)'''''_PermissionFlag''',''(STRING)'''''_CustomCrime''')		* '''DB_CheckPoint'''(''(CHARACTERGUID)'''''_Guard1''',''(CHARACTERGUID)'''''_Guard2''',''(TRIGGERGUID)'''''_PermissionWarningTrigger,''(TRIGGERGUID)'''''_EnterWarningTrigger''',''(TRIGGERGUID)'''''_EnterAttackTrigger''',''(STRING)'''''_PermissionFlag''',''(STRING)'''''_CustomCrime''')
	===== Description =====		===== Description =====
	Defines a checkpoint situation with two guards. Both guards must have the ''~~SneakTriggerSpotter~~'' script assigned. When a player enters '''_PermissionWarningTrigger''' without permission (see later), '''_Guard1 '''will start his default dialog with the player with the character flag '''''GLO_CP_WarningSomeone''''' set on '''_Guard1''' (so you can use a different dialog flow compared to a regular conversation with the guard; the flag removed again when the dialog ends). Similarly, when a player enters '''_EnterWarningTrigger''' without permission, the same happens with '''_Guard2'''. When a player enters '''_EnterAttackTrigger''' without permission, by default the trespass crime will be generated. If '''_CustomCrime''' is specified, this crime will be generated instead. '''_PermissionFlag''' is a character flag that can be set on a player to indicate they have permission to enter all of the aforementioned triggers. Typically, this flag can be obtained during the dialog that gets started with '''_Guard1''' when entering '''_PermissionWarningTrigger'''. Once you have this flag, none of the dialogs will be started anymore. If there is no way to obtain permission, specify something like '''''INVALIDFLAG''''' rather than an empty string as '''_PermissionFlag''', as it is not intuitive what the result should be of checking whether an en empty character flag is set.		Defines a checkpoint situation with two guards. Both guards must have the ''GLO_SneakSpotter'' script assigned. When a player enters '''_PermissionWarningTrigger''' without permission (see later), '''_Guard1 '''will start his default dialog with the player with the character flag '''''GLO_CP_WarningSomeone''''' set on '''_Guard1''' (so you can use a different dialog flow compared to a regular conversation with the guard; the flag removed again when the dialog ends). Similarly, when a player enters '''_EnterWarningTrigger''' without permission, the same happens with '''_Guard2'''. When a player enters '''_EnterAttackTrigger''' without permission, by default the trespass crime will be generated. If '''_CustomCrime''' is specified, this crime will be generated instead. Note that you will also have to [[Generic_behaviour#Defining_Generic_Behaviours\|define this custom crime]] if you want it to do anything.

			'''_PermissionFlag''' is a character flag that can be set on a player to indicate they have permission to enter all of the aforementioned triggers. Typically, this flag can be obtained during the dialog that gets started with '''_Guard1''' when entering '''_PermissionWarningTrigger'''. Once you have this flag, none of the dialogs will be started anymore. If there is no way to obtain permission, specify something like '''''INVALIDFLAG''''' rather than an empty string as '''_PermissionFlag''', as it is not intuitive what the result should be of checking whether an en empty character flag is set.
	===== Notes =====		===== Notes =====
	* /		* /

Tinkerer at 20:53, 25 August 2017

2017-08-25T20:53:22Z

← Older revision		Revision as of 20:53, 25 August 2017
Line 8:		Line 8:

	===== See also =====		===== See also =====
	* [[Osiris/Shared/DB_TrespassTrigger\|DB_TrespassTrigger]]		* Helper [[Osiris/Shared/DB_TrespassTrigger\|DB_TrespassTrigger]]

	[[Category:Osiris Shared Mod Helpers]]		[[Category:Osiris Shared Mod Helpers]]

Tinkerer at 20:53, 25 August 2017

2017-08-25T20:53:03Z

← Older revision		Revision as of 20:53, 25 August 2017
Line 8:		Line 8:

	===== See also =====		===== See also =====
	* [[Osiris/Shared/~~DB TrespassTrigger~~]]		* [[Osiris/Shared/DB_TrespassTrigger\|DB_TrespassTrigger]]

	[[Category:Osiris Shared Mod Helpers]]		[[Category:Osiris Shared Mod Helpers]]

Tinkerer at 12:16, 9 August 2017

2017-08-09T12:16:45Z

← Older revision		Revision as of 12:16, 9 August 2017
Line 8:		Line 8:

	===== See also =====		===== See also =====
	* [[~~Osirs~~/Shared/~~DB_TrespassTrigger~~]]		* [[Osiris/Shared/DB TrespassTrigger]]

	[[Category:Osiris Shared Mod Helpers]]		[[Category:Osiris Shared Mod Helpers]]

Tinkerer at 12:16, 9 August 2017

2017-08-09T12:16:15Z

← Older revision		Revision as of 12:16, 9 August 2017
Line 8:		Line 8:

	===== See also =====		===== See also =====
	* ~~'''~~DB_TrespassTrigger~~'''~~		* [[Osirs/Shared/DB_TrespassTrigger]]

	[[Category:Osiris Shared Mod Helpers]]		[[Category:Osiris Shared Mod Helpers]]