XML:BINA/OBJC/NEUT: Difference between revisions

{{XML_OBJC_Header | prev=MELE | type=NEUT | next=PART | name=Neutral}}

==File structure==

'''''[...]''''' means at least one neutral behavior block. Paste all your behavior data into there (this includes the <NEUT Id="..."> and </NEUT> tag).

==Tags==

!width=120px| Content type

! Description

| The ID here doesn't matter.

| XYZ position, unused

| XYZ rotation, unused

| The name of the NEUT profile. Used by [[BSL]] command '''ai2_neutralbehavior'''.

| Used by [[XML:BINA/OBJC/CHAR|BINA/OBJC/CHAR]] and [[XML:BINA/OBJC/MELE|BINA/OBJC/MELE]].

*'''None''' - No flags utilized

*'''NoResume''' - If the conversation is interrupted, NEUT behavior terminates. Conversation cannot be re-initiated.

*'''NoResumeAfterGive''' - Interrupted conversation can be re-initiated, as long as we have not reached a line of dialogue which had the flag "GiveItems". Also, if a line of dialogue is interrupted AFTER the line with the "GiveItems" flag, then the sound file of the interrupted dialogue line is fully played (is not stopped by the conversation interruption). Maybe a bug?

*'''Uninterruptible''' - Running, crouching or jumping will not be able to interrupt the conversation; only attacking the NPC will.

| The distance between the AI and the player character when the NEUT behavior mechanics kick in.

*If '''"distance to player" > "Talk range"''' then the NEUT-driven AI keeps approaching the player character.

*If  '''"distance to player" <= "Talk range"''' then the NEUT-driven AI stands still, rotates in order to keep looking at the player, and keeps repeating the "Hail" anim type and playing the <Trigger> speech line (see below) at a 5 second interval.

*If  '''"distance to player" <= "Talk range"''' AND '''"distance to player" <= 35 game world units''' (based on observation), then the conversation can be triggered by facing the NEUT-driven AI and pressing the action key.

An "allowed travel" distance for the NEUT-driven AI, starting from the moment the player entered the <Trigger> range (see above). The NEUT-driven AI is allowed to travel only this far from its pre-trigger location before it gives up on chasing the player character. When the <Follow> distance is expended, the NEUT behavior for the given character is terminated and control over the character is handed to some other AI2 system (for example the Patrol Path system). Of course if the player again enters the <Trigger> range, the NEUT mechanics kick in again (with a reset <Follow> distance to expend).

The range within which the NEUT-driven AI will react to the presence of enemies (even those behind its back!). Who is considered an "enemy" is defined according to Oni's team affiliations.<BR>

*If an enemy is within the <Enemy> range prior to the conversation, then the conversation cannot begin till the enemy is either outside of that range or neutralized.

*If an enemy gets inside the <Enemy> range while the conversation is occurring, the conversation is stopped and the <Enemy> speech sound (see below) is played.

The further reaction of the NEUT-driven AI to the enemy depends on their [[CHAR]] settings — it can start cowering in fear (NonCombatant flag is set) or go attack the enemy (default setup).

|valign=top| Speech sound for hailing the player. If  '''"distance to player" <= "Talk range"''' then the NEUT-driven AI stands still, rotates in order to keep looking at the player, and keeps repeating the Hail anim type and playing the speech sound specified in this <Trigger> tag at a 5 second interval.

 

 

Examples of such OSBD .amb files:

|valign=top| Speech sound for when player interrupts the conversation. This sound is played when the player aborts the conversation by performing some offensive action such as a punch/kick or by breaking away in the middle of the conversation with a movement.

 

 

Examples of such OSBD .amb files:

|valign=top| Speech sound to play when conversation is interrupted due to an enemy entering the <Enemy> range.

 

 

Examples of such OSBD .amb files:

| A name of a BSL function. The function will will be executed after the conversation is finished. The function in BSL can have an optional parameter of type ''string'' which receives the name of the NEUT-driven AI.

| You can get rewards for saving people. A reward can be a weapon, ballistic ammo, energy cells, hypos, a shield, a phase cloak, or an [[LSI]].

| Any weapon. Filename without prefix ONWC and suffix .oni, for example "w6_vdg".

|valign=top| These flags can be combined:

| There can be multiple dialogue lines.

| These flag can be combined:

*'''None''' - No special flags.

*'''IsPlayer''' - Reverses the subjects of Anim and OtherAnim — now Anim is applied to the player character and OtherAnim is applied to the NEUT-driven AI.

*'''GiveItems''' - Will make the conversation participants play their respective give and take animations AND will add item(s) to the player's inventory. This exchange cannot be interrupted by player's input.

*'''AnimOnce''' - NEUT-driven AIs will play their prescribed anim type only once during the dialogue line.

*'''OtherAnimOnce''' - player character will play its prescribed anim type only once during the dialogue line.

|valign=top| [[XML:StNA#Animation_types|<Anim>]]

| The anim type ID of the TRAM applied to the NEUT-driven AI during this dialogue line. Any TRAM which has the anim state "Standing" and is present in a NEUT-driven AI's [[TRAC]] should be valid.

| [[XML:StNA#Animation_types|<OtherAnim>]]

| Anim type ID of the TRAM applied to the player character during this dialogue line. Any TRAM which has the anim state "Standing" and is present in the player character's [[TRAC]] should be valid.

|The actual sound played during the dialogue line. The length of this sound file determines the length of the dialogue line's effect in-game.

 

 

For example: