Scripting - Revision history

Rimevan: /* CHECK or IF */

2018-12-11T18:20:05Z

CHECK or IF

← Older revision		Revision as of 18:20, 11 December 2018
Line 321:		Line 321:
	ENDIF		ENDIF
	INTERRUPT		INTERRUPT
			ACTIONS
	Reset()		Reset()
	</pre>		</pre>
	In this case we're checking something in the reaction when it's executing, but we don't do anything if the IF fails. There is no ELSE behaviour. This means that in combat this reaction could keep failing and not do anything, which will cause a ForceEndTurn for that character. Here we should have checked CharacterCanCast in the CHECK and not write a separate IF check. In general when the IF check in a REACTION is blocking the whole REACTION from executing it's probably better to place it in the CHECK instead.		In this case we're checking something in the reaction when it's executing, but we don't do anything if the IF fails. There is no ELSE behaviour. This means that in combat this reaction could keep failing and not do anything, which will cause a ForceEndTurn for that character. Here we should have checked CharacterCanCast in the CHECK and not write a separate IF check. In general when the IF check in a REACTION is blocking the whole REACTION from executing it's probably better to place it in the CHECK instead.
	<br />		<br />

	===Check order===		===Check order===
	<pre>		<pre>

Tinkerer: Link script editor and script activation pages from the introduction; add category

2017-12-03T21:03:09Z

Link script editor and script activation pages from the introduction; add category

← Older revision		Revision as of 21:03, 3 December 2017
Line 1:		Line 1:
	=Introduction=		=Introduction=
	The scripting system is currently used for the behaviour of characters and items. For characters this is only part of the behaviour, as many more systems ~~are influencing~~ this in the following priority:		The scripting system is currently used for the behaviour of characters and items. For characters this is only part of the behaviour, as many more systems influence this in the following priority:
	<ul>		<ul>
	<li>Story: executing Osiris Tasks</li>		<li>Story: executing Osiris Tasks</li>
Line 6:		Line 6:
	<li>Statuses: dying, frozen, petrified, ...</li>		<li>Statuses: dying, frozen, petrified, ...</li>
	<li>Scripts: executing the current reaction or scriptframe</li></ul>		<li>Scripts: executing the current reaction or scriptframe</li></ul>
	Scripts are the lowest priority and will only execute if none of the other systems want to do something. For items it's a lot simpler, as the scripting system is the only thing that influences the items behaviour.		Scripts are the lowest priority and will only execute if none of the other systems want to do something. For items it's a lot simpler, as the scripting system is the only thing
			that influences the items behaviour.

			To create and modify scripts, use the [[Script_editor\|script editor]]. Make sure to also [[Activating_Scripts\|activate them]] so they can be checked for errors and actually apply to objects.

	<br />		<br />
	=Object Naming=		=Object Naming=
Line 335:		Line 339:
	<br />		<br />
	===AD interrupts===		===AD interrupts===

			[[Category:Behaviour_Scripts]]

Tinkerer: Refer to S_ naming convention

2017-10-13T09:03:05Z

Refer to S_ naming convention

← Older revision		Revision as of 09:03, 13 October 2017
Line 8:		Line 8:
	Scripts are the lowest priority and will only execute if none of the other systems want to do something. For items it's a lot simpler, as the scripting system is the only thing that influences the items behaviour.		Scripts are the lowest priority and will only execute if none of the other systems want to do something. For items it's a lot simpler, as the scripting system is the only thing that influences the items behaviour.
	<br />		<br />
			=Object Naming=
			When you with to refer to objects/local instances from script or elsewhere, make sure to follow the [[Templates_explanation#Local_instances.2Ftemplates\|correct naming convention]].
	=Sections=		=Sections=
	Before any section in a script, we can INCLUDE files. When you INCLUDE a file, you're telling the system to parse that file first.		Before any section in a script, we can INCLUDE files. When you INCLUDE a file, you're telling the system to parse that file first.

Kevin: Protected "Scripting" ([Edit=⧼protect-level-larianeditonly⧽] (indefinite) [Move=⧼protect-level-larianeditonly⧽] (indefinite))

2017-10-02T11:35:30Z

Protected "Scripting" ([Edit=⧼protect-level-larianeditonly⧽] (indefinite) [Move=⧼protect-level-larianeditonly⧽] (indefinite))

← Older revision	Revision as of 11:35, 2 October 2017
(No difference)

Rimevan: /* Common Mistakes */

2017-09-13T18:30:22Z

Common Mistakes

← Older revision		Revision as of 18:30, 13 September 2017
Line 331:		Line 331:
	</pre>		</pre>
	Make sure to perform your checks in the right order. Before checking a stat make sure to fetch it. Before checking if the character is a player consider checking if it is a valid player. Could it be the player is off stage? Could it be dead? Is it even set?		Make sure to perform your checks in the right order. Before checking a stat make sure to fetch it. Before checking if the character is a player consider checking if it is a valid player. Could it be the player is off stage? Could it be dead? Is it even set?
			<br />
			===AD interrupts===

Rimevan: /* Variables */

2017-09-13T18:26:50Z

Variables

← Older revision		Revision as of 18:26, 13 September 2017
Line 152:		Line 152:
	<li>DEATH_TYPE: death types can be found [[Scripting_death_types\|here]].</li>		<li>DEATH_TYPE: death types can be found [[Scripting_death_types\|here]].</li>
	<li>STATUS_ID: all loaded statuses from stats</li>		<li>STATUS_ID: all loaded statuses from stats</li>
	<li>ARCHETYPE: all available archetypes that are loaded. More information on archetypes can be found [[~~CombatAi_Archetypes_and_Modifiers~~\|here]].</li>		<li>ARCHETYPE: all available archetypes that are loaded. More information on archetypes can be found [[CombatAi_Archetypes_And_Modifiers\|here]].</li>
	<li>SURFACE_TRANSFORM_TYPE: surface transform types can be found [[Scripting_surface_transform_types\|here]].</li>		<li>SURFACE_TRANSFORM_TYPE: surface transform types can be found [[Scripting_surface_transform_types\|here]].</li>
	</ul>		</ul>

Rimevan: /* Variables */

2017-09-13T18:25:54Z

Variables

← Older revision		Revision as of 18:25, 13 September 2017
Line 152:		Line 152:
	<li>DEATH_TYPE: death types can be found [[Scripting_death_types\|here]].</li>		<li>DEATH_TYPE: death types can be found [[Scripting_death_types\|here]].</li>
	<li>STATUS_ID: all loaded statuses from stats</li>		<li>STATUS_ID: all loaded statuses from stats</li>
	<li>ARCHETYPE: all available archetypes that are loaded. More information on archetypes can be found [[~~Combat_Ai_archetypes_and_modifiers~~\|here]].</li>		<li>ARCHETYPE: all available archetypes that are loaded. More information on archetypes can be found [[CombatAi_Archetypes_and_Modifiers\|here]].</li>
	<li>SURFACE_TRANSFORM_TYPE: surface transform types can be found [[Scripting_surface_transform_types\|here]].</li>		<li>SURFACE_TRANSFORM_TYPE: surface transform types can be found [[Scripting_surface_transform_types\|here]].</li>
	</ul>		</ul>
Line 203:		Line 203:
	Now, how would you use these lists?		Now, how would you use these lists?
	<br />		<br />

	=Important Events=		=Important Events=
	===OnInit and OnShutDown===		===OnInit and OnShutDown===

Rimevan at 18:21, 13 September 2017

2017-09-13T18:21:43Z

← Older revision		Revision as of 18:21, 13 September 2017
Line 134:		Line 134:
	<li>FLOAT: all other numbers. For example: 0.1, -0.323, 8.3, ...</li>		<li>FLOAT: all other numbers. For example: 0.1, -0.323, 8.3, ...</li>
	<li>STRING and FIXEDSTRING: the difference between STRING and FIXEDSTRING is not important when scripting, just make sure to pass the correct type in actions. For example: "", "testString", "testing123", ... . <b>Important note:</b> do not start a string with the characters '%' or '_', as they will get recognized as a variable instead (it's not intended, it's a bug).</li>		<li>STRING and FIXEDSTRING: the difference between STRING and FIXEDSTRING is not important when scripting, just make sure to pass the correct type in actions. For example: "", "testString", "testing123", ... . <b>Important note:</b> do not start a string with the characters '%' or '_', as they will get recognized as a variable instead (it's not intended, it's a bug).</li>
	<li>CHARACTER, ITEM, and ~~TRIGGER~~: objects that are currently loaded in the game. This includes globals and locals of the curently loaded level. The script will assert if the script uses an object that isn't currently loaded. It will also warn you if the character's name does not start with the prefix 'S_'. This prefix helps to prevent objects being deleted because they aren't used (they could be used in script). For example: S_GLO_Dallis, S_MyFirstItem, ...</li>		<li>CHARACTER, ITEM, TRIGGER, and SPLINE: objects that are currently loaded in the game. This includes globals and locals of the curently loaded level. The script will assert if the script uses an object that isn't currently loaded. It will also warn you if the character's name does not start with the prefix 'S_'. This prefix helps to prevent objects being deleted because they aren't used (they could be used in script). For example: S_GLO_Dallis, S_MyFirstItem, ...</li>
	<li>RELATION_TYPE: only used in a handful actions. A list of possible relation types can be found [[scripting_relation_types\|here]].</li>		<li>RELATION_TYPE: only used in a handful actions. A list of possible relation types can be found [[scripting_relation_types\|here]].</li>
	<li>SKILL_ID: the name/id of a skill as it can be found in [[skill_creation\|SkillData]]. For example: Target_Bless, Projectile_Fireball, ...</li>		<li>SKILL_ID: the name/id of a skill as it can be found in [[skill_creation\|SkillData]]. For example: Target_Bless, Projectile_Fireball, ...</li>
Line 146:		Line 146:
	<li>COMPARE_TYPE: compare types can be found [[Scripting_compare_types\|here]].</li>		<li>COMPARE_TYPE: compare types can be found [[Scripting_compare_types\|here]].</li>
	<li>COMPARE_FUNCTION: compare functions can be found [[Scripting_compare_functions\|here]].</li>		<li>COMPARE_FUNCTION: compare functions can be found [[Scripting_compare_functions\|here]].</li>
	<li>FLOAT3:</li>		<li>FLOAT3: floats are written as {number;number;number}, and can contain integers as well</li>
	<li>CHARACTERTEMPLATE, ITEMTEMPLATE, and PROJECTILETEMPLATE:</li>		<li>CHARACTERTEMPLATE, ITEMTEMPLATE, and PROJECTILETEMPLATE: the script will warn you if the template's name does not start with the prefix 'S_'. This prefix helps to prevent objects being deleted because they aren't used (they could be used in script). For example: S_Chair_A, S_Human_Male_B, ...</li>
	<li>POTION_ID:</li>		<li>POTION_ID: all loaded potions from stats</li>
	<li>ABILITY_TYPE:</li>		<li>ABILITY_TYPE: ability types can be found [[Scripting_ability_types\|here]].</li>
	<li>DEATH_TYPE:</li>		<li>DEATH_TYPE: death types can be found [[Scripting_death_types\|here]].</li>
	<li>STATUS_ID:~~</li>~~		<li>STATUS_ID: all loaded statuses from stats</li>
	~~<li>SPLINE:~~</li>		<li>ARCHETYPE: all available archetypes that are loaded. More information on archetypes can be found [[Combat_Ai_archetypes_and_modifiers\|here]].</li>
	<li>ARCHETYPE:</li>		<li>SURFACE_TRANSFORM_TYPE: surface transform types can be found [[Scripting_surface_transform_types\|here]].</li>
	<li>SURFACE_TRANSFORM_TYPE:</li>
	</ul>		</ul>
	<br />		<br />

Rimevan at 17:52, 13 September 2017

2017-09-13T17:52:56Z

← Older revision		Revision as of 17:52, 13 September 2017
Line 138:		Line 138:
	<li>SKILL_ID: the name/id of a skill as it can be found in [[skill_creation\|SkillData]]. For example: Target_Bless, Projectile_Fireball, ...</li>		<li>SKILL_ID: the name/id of a skill as it can be found in [[skill_creation\|SkillData]]. For example: Target_Bless, Projectile_Fireball, ...</li>
	<li>SURFACE_TYPE: surface types can be found [[scripting_surface_types\|here]].</li>		<li>SURFACE_TYPE: surface types can be found [[scripting_surface_types\|here]].</li>
	<li>STATUS_TYPE: </li>		<li>STATUS_TYPE: status types can be found [[Scripting_status_types\|here]].</li>
	<li>CHARACTERSTAT_TYPE:</li>		<li>CHARACTERSTAT_TYPE: characterstat types can be found [[Scripting_characterstat_types\|here]].</li>
	<li>ITEMSTAT_TYPE:</li>		<li>ITEMSTAT_TYPE: itemstat types can be found [[Scripting_itemstat_types\|here]].</li>
	<li>WEAPON_TYPE:</li>		<li>WEAPON_TYPE: weapon types can be found [[Scripting_weapon_types\|here]].</li>
	<li>DAMAGE_TYPE:</li>		<li>DAMAGE_TYPE: damage types can be found [[Scripting_damage_types\|here]].</li>
	<li>TALENT_TYPE:</li>		<li>TALENT_TYPE: talent types can be found [[Scripting_talent_types\|here]].</li>
	<li>COMPARE_TYPE:</li>		<li>COMPARE_TYPE: compare types can be found [[Scripting_compare_types\|here]].</li>
	<li>COMPARE_FUNCTION:</li>		<li>COMPARE_FUNCTION: compare functions can be found [[Scripting_compare_functions\|here]].</li>
	<li>FLOAT3:</li>		<li>FLOAT3:</li>
	<li>CHARACTERTEMPLATE, ITEMTEMPLATE, and PROJECTILETEMPLATE:</li>		<li>CHARACTERTEMPLATE, ITEMTEMPLATE, and PROJECTILETEMPLATE:</li>

Rimevan at 14:51, 13 September 2017

2017-09-13T14:51:46Z

Show changes