(Category, Tableification) |
TorturedCats (talk | contribs) (Apply approved Sinfar resource-page layout: native headings, compact tables and responsive navigation; preserve existing content.) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
<div class="sf-page sf-article-page sf-guidance-family sf-resource-page"> | |||
<div class="sf-family-path">[[Main Page|Main Page]] · [[:Category:Builders Tools|Builder resources]]</div> | |||
<div class="sf-hero"><div class="sf-eyebrow">Builder resources · Scripting reference</div> | |||
<div class="sf-title">Creature Event System</div> | |||
<p>Default creature scripts and the variables used to attach event behavior.</p> | |||
</div> | |||
== On this page == | |||
<div class="sf-task-index">[[#Default_scripts|Default scripts]] [[#The_variables|The variables]] [[#OnUserDefined|OnUserDefined]]</div> | |||
== Default scripts == | |||
Sinfar uses a custom system by which you can assign default scripts to a monster then use variables to inject a script and its behavior onto the monster based on the event. | Sinfar uses a custom system by which you can assign default scripts to a monster then use variables to inject a script and its behavior onto the monster based on the event. | ||
[[File:Scripts Onto Monsters.png | <div class="sf-guide-image">[[File:Scripts Onto Monsters.png]]<div class="sf-caption">Screenshot of what the script and save scriptset/load script set buttons look like in the toolset underneath the 'scripts' tab on creature editors.</div></div> | ||
The default scripts are as following: | The default scripts are as following: | ||
{| class=" | {| class="sf-reference-table sf-table" | ||
|- class="sf-table-head" | |||
!Field!!Default Script | !Field!!Default Script | ||
|- | |- | ||
| Line 35: | Line 48: | ||
|} | |} | ||
- The only script that isn't defined by Sinfar edits is OnUserDefined (as far as I know). | - The only script that isn't defined by Sinfar edits is OnUserDefined (as far as I know). The UserDefined event does not have an associated EVENT variable and should be set directly. See more below. | ||
- It is recommended you create a monster and assign the default scripts to it in the toolset, and 'save the script set' and inject it to all monsters hereon. This way you can use 'load script' to inject all the code at once. | - It is recommended you create a monster and assign the default scripts to it in the toolset, and 'save the script set' and inject it to all monsters hereon. This way you can use 'load script' to inject all the code at once. | ||
- When creating creatures directly on the Builder Website, the correct scripts are automatically assigned. | |||
[[File:Image.png | |||
== The variables == | |||
<div class="sf-guide-image">[[File:Image.png]]<div class="sf-caption">Example of the EVENT_AI_DEATH use</div></div> | |||
The variables in bold are what you would use to put on your monster. | The variables in bold are what you would use to put on your monster. | ||
<div | <div> | ||
{| class="sf-reference-table sf-matrix" | |||
!Script! | |- class="sf-table-head" | ||
! scope="col" | Script | |||
! scope="col" | Script description | |||
! scope="col" | Event Name String | |||
! scope="col" | Pre-event description | |||
|- | |- | ||
|nw_c2_default1| | ! scope="row" | nw_c2_default1 | ||
| <span class="sf-data-label">Script description</span><span class="sf-data-value">On Heartbeat event</span> | |||
| <span class="sf-data-label">Event Name String</span><span class="sf-data-value">'''EVENT_AI_HEARTBEAT''' (string)</span> | |||
| <span class="sf-data-label">Pre-event description</span><span class="sf-data-value">Script name for pre-event use.</span> | |||
|- | |- | ||
|nw_c2_default2| | ! scope="row" | nw_c2_default2 | ||
| <span class="sf-data-label">Script description</span><span class="sf-data-value">On Perception event</span> | |||
| <span class="sf-data-label">Event Name String</span><span class="sf-data-value">'''EVENT_AI_PERCEPTION''' (string)</span> | |||
| <span class="sf-data-label">Pre-event description</span><span class="sf-data-value">Script name for pre-event use.</span> | |||
|- | |- | ||
|nw_c2_default3| | ! scope="row" | nw_c2_default3 | ||
| <span class="sf-data-label">Script description</span><span class="sf-data-value">On Combat Round End event</span> | |||
| <span class="sf-data-label">Event Name String</span><span class="sf-data-value">'''EVENT_AI_ENDCOMBATROUND''' (string)</span> | |||
| <span class="sf-data-label">Pre-event description</span><span class="sf-data-value">Script name for pre-event use.</span> | |||
|- | |- | ||
|nw_c2_default4| | ! scope="row" | nw_c2_default4 | ||
| <span class="sf-data-label">Script description</span><span class="sf-data-value">On Conversation event</span> | |||
| <span class="sf-data-label">Event Name String</span><span class="sf-data-value">'''EVENT_AI_CONVERSATION''' (string)</span> | |||
| <span class="sf-data-label">Pre-event description</span><span class="sf-data-value">Script name for pre-event use.</span> | |||
|- | |- | ||
|nw_c2_default5| | ! scope="row" | nw_c2_default5 | ||
| <span class="sf-data-label">Script description</span><span class="sf-data-value">On Attacked event</span> | |||
| <span class="sf-data-label">Event Name String</span><span class="sf-data-value">'''EVENT_AI_ATTACKED''' (string)</span> | |||
| <span class="sf-data-label">Pre-event description</span><span class="sf-data-value">Script name for pre-event use.</span> | |||
|- | |- | ||
|nw_c2_default6| | ! scope="row" | nw_c2_default6 | ||
| <span class="sf-data-label">Script description</span><span class="sf-data-value">On Damaged event</span> | |||
| <span class="sf-data-label">Event Name String</span><span class="sf-data-value">'''EVENT_AI_DAMAGED''' (string)</span> | |||
| <span class="sf-data-label">Pre-event description</span><span class="sf-data-value">Script name for pre-event use.</span> | |||
|- | |- | ||
|nw_c2_default7| | ! scope="row" | nw_c2_default7 | ||
| <span class="sf-data-label">Script description</span><span class="sf-data-value">On Death event</span> | |||
| <span class="sf-data-label">Event Name String</span><span class="sf-data-value">'''EVENT_AI_DEATH''' (string)</span> | |||
| <span class="sf-data-label">Pre-event description</span><span class="sf-data-value">Script name for pre-event use.</span> | |||
|- | |- | ||
|nw_c2_default8| | ! scope="row" | nw_c2_default8 | ||
| <span class="sf-data-label">Script description</span><span class="sf-data-value">On Disturbed event</span> | |||
| <span class="sf-data-label">Event Name String</span><span class="sf-data-value">'''EVENT_AI_DISTURBED''' (string)</span> | |||
| <span class="sf-data-label">Pre-event description</span><span class="sf-data-value">Script name for pre-event use.</span> | |||
|- | |- | ||
|nw_c2_default9| | ! scope="row" | nw_c2_default9 | ||
| <span class="sf-data-label">Script description</span><span class="sf-data-value">On Spawned event</span> | |||
| <span class="sf-data-label">Event Name String</span><span class="sf-data-value">'''EVENT_AI_SPAWN''' (string)</span> | |||
| <span class="sf-data-label">Pre-event description</span><span class="sf-data-value">Script name for pre-event use.</span> | |||
|- | |- | ||
|nw_c2_defaultb| | ! scope="row" | nw_c2_defaultb | ||
| <span class="sf-data-label">Script description</span><span class="sf-data-value">On Spell Cast At event</span> | |||
| <span class="sf-data-label">Event Name String</span><span class="sf-data-value">'''EVENT_AI_CASTAT''' (string)</span> | |||
| <span class="sf-data-label">Pre-event description</span><span class="sf-data-value">Script name for pre-event use.</span> | |||
|- | |- | ||
|nw_c2_defaulte| | ! scope="row" | nw_c2_defaulte | ||
| <span class="sf-data-label">Script description</span><span class="sf-data-value">On Blocked event</span> | |||
| <span class="sf-data-label">Event Name String</span><span class="sf-data-value">'''EVENT_AI_BLOCKED''' (string)</span> | |||
| <span class="sf-data-label">Pre-event description</span><span class="sf-data-value">Script name for pre-event use.</span> | |||
|} | |} | ||
</div> | </div> | ||
[[File:OnUserDefinedScreenshot.png | |||
== OnUserDefined == | |||
<div class="sf-guide-image">[[File:OnUserDefinedScreenshot.png]]<div class="sf-caption">At the very bottom, you would hardcode and directly use the script name on the OnUserDefined event.</div></div>For OnUserDefined functions, you would apply the script '''directly''' onto the monster. | |||
Note : nw_c2_default9 uses the variable ENTIRE_APPEARANCE2 already | Note : nw_c2_default9 uses the variable ENTIRE_APPEARANCE2 already | ||
You can also register these events dynamically using [[Variable Based Events]]. | You can also register these events dynamically using [[Variable Based Events]]. | ||
<div class="sf-footerlinks">[[Main Page|Return to Main Page]] · [[Player Guidance Directory]] · [[:Category:Builders Tools|Builder resources]]</div> | |||
</div> | |||
[[Category:Builders Tools]] | [[Category:Builders Tools]] | ||
Latest revision as of 22:51, 10 November 2026
Default creature scripts and the variables used to attach event behavior.
On this page
Default scripts
Sinfar uses a custom system by which you can assign default scripts to a monster then use variables to inject a script and its behavior onto the monster based on the event.

The default scripts are as following:
| Field | Default Script |
|---|---|
| OnBlocked | nw_c2_defaulte |
| OnDamaged | nw_c2_default6 |
| OnDeath | nw_c2_default7 |
| OnConversation | nw_c2_default4 |
| OnDisturbed | nw_c2_default8 |
| OnCombatRoundEnd | nw_c2_default3 |
| OnHeartbeat | nw_c2_default1 |
| OnPhysicalAttacked | nw_c2_default5 |
| OnPerception | nw_c2_default2 |
| OnRested | x2_def_rested |
| OnSpawn | nw_c2_default9 |
| OnSpellCast | nw_c2_defaultb |
| OnUserDefined | x2_def_userdef |
- The only script that isn't defined by Sinfar edits is OnUserDefined (as far as I know). The UserDefined event does not have an associated EVENT variable and should be set directly. See more below.
- It is recommended you create a monster and assign the default scripts to it in the toolset, and 'save the script set' and inject it to all monsters hereon. This way you can use 'load script' to inject all the code at once.
- When creating creatures directly on the Builder Website, the correct scripts are automatically assigned.
The variables
The variables in bold are what you would use to put on your monster.
| Script | Script description | Event Name String | Pre-event description |
|---|---|---|---|
| nw_c2_default1 | Script descriptionOn Heartbeat event | Event Name StringEVENT_AI_HEARTBEAT (string) | Pre-event descriptionScript name for pre-event use. |
| nw_c2_default2 | Script descriptionOn Perception event | Event Name StringEVENT_AI_PERCEPTION (string) | Pre-event descriptionScript name for pre-event use. |
| nw_c2_default3 | Script descriptionOn Combat Round End event | Event Name StringEVENT_AI_ENDCOMBATROUND (string) | Pre-event descriptionScript name for pre-event use. |
| nw_c2_default4 | Script descriptionOn Conversation event | Event Name StringEVENT_AI_CONVERSATION (string) | Pre-event descriptionScript name for pre-event use. |
| nw_c2_default5 | Script descriptionOn Attacked event | Event Name StringEVENT_AI_ATTACKED (string) | Pre-event descriptionScript name for pre-event use. |
| nw_c2_default6 | Script descriptionOn Damaged event | Event Name StringEVENT_AI_DAMAGED (string) | Pre-event descriptionScript name for pre-event use. |
| nw_c2_default7 | Script descriptionOn Death event | Event Name StringEVENT_AI_DEATH (string) | Pre-event descriptionScript name for pre-event use. |
| nw_c2_default8 | Script descriptionOn Disturbed event | Event Name StringEVENT_AI_DISTURBED (string) | Pre-event descriptionScript name for pre-event use. |
| nw_c2_default9 | Script descriptionOn Spawned event | Event Name StringEVENT_AI_SPAWN (string) | Pre-event descriptionScript name for pre-event use. |
| nw_c2_defaultb | Script descriptionOn Spell Cast At event | Event Name StringEVENT_AI_CASTAT (string) | Pre-event descriptionScript name for pre-event use. |
| nw_c2_defaulte | Script descriptionOn Blocked event | Event Name StringEVENT_AI_BLOCKED (string) | Pre-event descriptionScript name for pre-event use. |
OnUserDefined
For OnUserDefined functions, you would apply the script directly onto the monster.Note : nw_c2_default9 uses the variable ENTIRE_APPEARANCE2 already
You can also register these events dynamically using Variable Based Events.

