AI

Foreword

Motivational video: http://www.youtube.com/watch?v=8Okn7u_-oVs

An action game like Oni needs artificial intelligence-driven characters ("AIs" or "bots") and some sort of interaction amongst these characters and between them and the world. The goal is to make an AI act at least a bit like a human being. That means giving the AI abilities such as moving in the game world believably, and seeing, hearing, and reacting to events in the game world. Different games deal with these problems in various ways, but in this article, we will take a look at Oni and its AI.

This page serves two purposes: to give an overview of Oni's AI and to help modders with AI tweaking.

Pathfinding and movement

File:Pathfinding grid.JPG

An example of a pathfinding grid.

An example of the A* algorithm's work: nodes chosen as a path for AI are highlighted.

Oni has two ways to make an AI move in a game world - pathfinding, and what could be called vector-based.

Pathfinding is used when AI-driven character needs to travel from one place to another. Examples of pathfinding movement are:

• patrol paths - AI-driven character moves in a pre-designed fashion (see PATR)
• alarm running - AI character is requested to go to given console and use it, see section Alarm behavior
• pursuit of target - AI character loses direct sight of the enemy, see section Pursuit of enemy
• running to weapons in order to pick them up, see Combat behavior part 2

Pathfinding utilizes an A* (A-star) algorithm to design routes for AI within the game world.

Human players see walls and obstacles placed between their current location and their desired location, thus they can plan their route thanks to the best computer so far known to man -- the human brain. The AI, on the other hand, has to be told where it can go and where it cannot (a wall, a pit, an obstacle, etc.). Since the A* is a chart-searching algorithm, there is a need to have some sort of chart, conveniently mapping the environment for AI purposes. And that is a pathfinding grid, which can be seen in-game by entering ai2_showgrids = 1 (see picture on right).

If an AI has to travel through the level by pathfinding, then a "mark" is set at the final destination and the "chart" mentioned above is consulted to get the shortest available route. After this process, the AI is continually fed with "traversal nodes" -- temporary marks placed in the part of the pathfinding grid which the AI is currently running through. An AI will simply run directly towards each mark, so when an AI needs to turn a corner, a number of these nodes have to be generated in order to make the AI run around the corner.

Pathfinding grids are tied to AKVAs and are loaded into memory only for the period of time that they serve some purpose (i.e., when the character is inside the AKVA volume). More detailed info about various types of pathfinding grid tiles and their effects on pathfinding can be found here.

There was a short-lived modding initiative to alter pathfinding grids manually, but it failed due to the extreme amount of labor required. These days, OniSplit can import levels and generate pathfinding grids.

Modding hints: if an AI has to turn a sharp corner, the pathfinding still picks the shortest route possible. This usually results in the AI having problems turning corners at full running/sprinting speed -- the AI stops at the corner, turns, runs past the corner, turns again to finish the path, and continues on its way. This is caused by the limited rotation speed assigned to the character in his ONCC.

In an ONCC XML file there is a <RotationSpeed> under <AIConstants>. The default is 1, but 1.5 works way better without causing any visible negative influence on the game. A rotation speed of 2.0 is the maximum recommended because the pathfinding in the game is designed for a speed of 1.0, so with a much higher rotation rate comes the paradox that new problems in pathfinding may appear, instead of issues being erased (mainly the AI colliding with obstacles).

Vector-based movement is used when an AI-driven character:

• enters close combat state and begins to use melee
• is dodging gunfire, be it firing spreads or projectiles
• is asked to run away from an enemy by a special setting in their CMBT profile

In this mode, an AI is not given an exact destination. Instead it is given a "desire" to go in some direction. This mode still uses the pathfinding grid, however in a bit of a different way than pathfinding does, so glitches occur, mainly unexpected collisions and ignored tiles (e.g., an AI runs off a ledge and falls to its death).

Unexpected Collision movement happens when an AI runs on its own towards some destination and suddenly hits an obstacle. Ideally that should never happen, as the pathfinding grid is designed to prevent it, but still... when a collision happens, the game decides what to do according to which method is being used to move the character:

• Pathfinding: the game makes the AI take a few steps back, rotate a bit, and lets the AI continue its journey. There is a limit to how many unexpected collisions an AI can undergo before it gives up on its destination as unreachable.
• Vector-based: according to the angle at which the AI is facing the obstacle, the game decides either to let the character slide along the obstacle or to stop the character completely until the angle of the AI's vector of movement changes.

Vision and hearing

File:VisionFields.JPG

An example of a blue Striker's central and peripheral vision.

File:SoundSpheres.JPG

Three examples of sound spheres.

When emulating humans with AI, senses have to be taken into an account: sight, hearing, taste, smell, touch. Unfortunately, Oni emulates only sight and hearing.

Sight is important. Without it, the only option for AI to recognize an enemy would be getting attacked by the enemy first. Unlike the majority of action games, Oni AIs have two kinds of vision:

• Central: an enemy seen by central vision will be recognized and attacked
• Peripheral: an enemy seen by peripheral vision will raise the AI's alert level to low and the AI will go into pursuit of the enemy; see Pursuit section

Modding hints - the parameters of the vision fields are stored in ONCC, under <VisionConstants>. The central vision field distance has to be greater than the peripheral vision field distance, otherwise peripheral vision detection will somehow be broken (it will not detect). Since peripheral vision makes the AI pursue the enemy but not attack it, it can be set quite large in order to surprise lousy stealth players. But be warned: nobody likes cheating AI ^_^.

Hearing is crucial in Oni. The majority of AI character interaction is done via the sound system. Oni recognizes these types of sound (colors in parentheses are used for sound visualization when ai2_showsounds is set to 1):

• Unimportant (blue) - is ignored to some extent if alert level of AI is "lull", but after some period of time, the AI will register it.
• Interesting (green) - raises alert level to "low"
• Danger (yellow) - raises alert level to "medium"
• Melee (orange) - raises alert level to "medium", but the AI reacts a bit differently than to a Danger sound
• Gunfire (red) - raises alert level to "high"

For more info about AI alert levels, see section Reactions and awareness. These sound types are used by impact effects (ONIE), and a danger sound type can be set in a particle's as part of its "danger radius".

Modding hints: The sound system and ONIE are mighty tools if a modder knows how to use them. Even doors can have attached to them a sound sphere of one of the types listed above, so a modder can create doors which draw the attention (sound type Interesting) of nearby AIs when those doors are used.

Another example is a workaround for AIs to get alerted by dead bodies:

Set the death particle in the ONCC to emit a custom impact effect. That impact effect will have no sound or effect attached, but will be set to be heard by AIs as gunfire within a large radius (say, 200 units).

Reactions and awareness

In real life, each human being is unique in its reactions. But even then, reactions differ with mood; when calm or when nervous or when suspicious, a man does not always react the same way. And what about Oni?

In Oni, reaction to a stimulus is based on the type of stimulus (see previous section) and on the alert level of the AI. Oni AIs have these alert levels:

• Lull
• Low
• Medium
• High
• Combat

The level of alert for an AI can be set via BSL using ai2_setalert. Alert levels play the role of "behavior modifier" in how an AI reacts to seeing or hearing allies and enemies. Alert levels can be increased in the following ways:

• hearing a sound which raises alert level (for detailed info, read previous section)
• a special rise from Lull to Low can come from an enemy being seen by peripheral vision or by an enemy causing too many Unimportant sounds
• a special rise to Combat level will come from being hit by the enemy or by an alarm being triggered (see OBD:BINA/OBJC/CONS), or by the scripting functions ai2_tripalarm, ai2_makeaware or ai2_attack.

Alert level also affects the movement mode of AI-driven characters. There are six movement modes: "creep", "walk", "walk_noaim", "run", "run_noaim", and "by_alert_level". The "*_noaim" movement modes tell the AI that, if it is armed, it should walk or run with the gun in hand but not aim with it. Movement mode can be forced via the BSL command ai2_setmovementmode. Alert level affects movement mode only if movement mode is set as "by_alert_level". In that case:

• Lull and Low alerts use "walk_noaim"
• Medium, High and Combat use "run"

If a patrol path (PATR) is assigned to a character, it can force a Lull-alerted character to run with an aimed weapon. However, when the AI becomes aware of and starts its pursuit of an ally/enemy, the movement mode is then dictated by its alert level (if the movement mode is set as by_alert_level).

An alert level can be decreased via BSL's ai2_setalert or with the passage of time (the location of the timer settings is unknown, maybe hardcoded).

The next component of the AI's reaction logic is its awareness of the ally/enemy. Oni distinguishes between allies ("friendlythreat") and enemies ("hostilethreat"). Oni's AIs always know whether a disturbance was caused by an ally or enemy. That means that if player is playing as Konoko and shoots, alerting some Striker, the Striker knows which character (from CHAR) shot and which team the character belongs to, and reacts accordingly (but more about that later). Oni defines four levels of awareness:

friendlythreat

• Definite: the AI is 100% sure where the ally is located and ignores him. Is achieved by seeing the ally with the central vision field, being hit by his gun by accident, or being told of the ally's presence by the BSL function ai2_makeaware, ai2_tripalarm or ai2_attack.
• Strong: the AI has a strong awareness of an ally's presence, but cannot pinpoint the exact location of the ally. Is caused by all sound types, which are described in previous section. If the ally is outside the central vision field and <FriendlyThreatDefiniteTimer> runs out, the AI decreases its level of awareness from Definite to Strong.
• Weak: the AI has a weak awareness of the ally's presence. It is caused either by seeing an ally with peripheral vision or by <FriendlyThreatStrongTimer> running out.
• Forgotten: the AI encountered some ally, but over time forgot about its presence (<FriendlyThreatWeakTimer> ran out).

hostilethreat

• Definite: the AI is 100% sure where the enemy is located, and will go attack her/him. Is achieved by seeing the enemy with its central vision field, being hit by her/him (or her/his gun), or being told of the enemy's presence by the BSL function ai2_makeaware, ai2_tripalarm or ai2_attack.
• Strong: the AI has a strong awareness of an enemy's presence, but cannot pinpoint the exact location of the enemy. Is caused by all sound types, which are described in previous section. If enemy manages to out of an AI's central vision field and <HostileThreatDefiniteTimer> runs out, the AI decreases its level of awareness from Definite to Strong. If the AI is allowed to investigate, the corresponding pursuit behavior is executed (more about this later).
• Weak: the AI has a weak awareness of an enemy's presence. It is caused either by seeing an enemy with peripheral vision or by <HostileThreatStrongTimer> running out. If the AI is allowed to investigate, the corresponding pursuit behavior is executed (more about this later)
• Forgotten: the AI encountered an enemy, but over time forgot about its presence (<EnemyThreatWeakTimer> ran out).

When an AI character is freshly spawned, it does not have any record of contact with other characters (a tabula rasa). Through hearing and vision, an AI learns about the presence of other characters and reacts to them according to team affiliation, alert level, and awareness level. Even when an AI character ceases to be aware of an ally/enemy, it does not completely forget them. For example, the startle behavior when an AI sees an enemy is played only once for this particular enemy; it won't play the startle animation the next time it sees him, but will go directly to attacking him.

Friendly warning: the awareness level "Forgotten" IS NOT equivalent to the result of the ai2_forget command. "Ai2_forget" actually sets the AI's memory back to tabula rasa status.

Pursuit

Now that alert and awareness levels have been covered, let's take a look at pursuit behavior. Pursuit behavior in Oni emulates the situation when a person knows "somebody is here", but does not see anybody. In Oni there are following types of pursuit behavior:

• None: No pursuit taking place
• Forget: the AI drops to the Forgotten level of awareness of this enemy
• GoTo: the AI moves to the source of the disturbance and performs 600 frames (10 seconds) of Look behavior
• Wait: the AI simply stands and waits to see/hear something more
• Look: the AI turns in place, looking all around
• Move: unimplemented; probably was meant to be similar to Look, but with character randomly moving around
• Hunt: unimplemented; probably was meant to make AI purposefully hunt around for the enemy
• Glance: the AI does not rotate its whole body, but only turns its head

Plus there are three types of lost behavior (when an AI had definite contact with the enemy but the enemy managed to get away):

• ReturnTo Job: the AI returns to its job
• KeepLooking: the AI does not return to its job, and keeps using the last used pursuit behavior
• FindAlarm: the AI tries to switch to alarm behavior (see section Alarm behavior); if it does not succeed, then it returns to its job.

In Oni, a character is spawned in the level from a character profile (a CHAR file). This CHAR profile contains links to:

• ONCC file, for character class, eg. Konoko or Comguy_1
• CMBT file, for the combat profile for this character
• MELE file, for the melee profile for this character
• PATR file (OPTIONAL), for the patrol path
• NEUT file (OPTIONAL), for neutral behavior (e.g., a civilian giving the player a powerup)

Pursuit behavior is executed only within the Pursuit range, which is the parameter <PursuitDistance> in the CMBT profile attached to the AI. If anything suspicious happens outside of this range, the AI only looks in the direction of the disturbance for a short time, then ignores it and returns to its job.

Pursuit behavior greatly depends on the AI's level of alert. There are four parameters regarding alert levels in the CHAR profile:

• Initial: the AI is spawned with the specified level of alert
• Minimal: the minimal alert level this AI can have
• JobStart: the alert level of the AI when it starts some job (typically a patrol)
• Investigate: From the alert level specified here, and all greater alert levels, the AI will tend to pursue any suspicious sound it hears or any hostile peripheral contact it makes

Also in CHAR are five fields regarding pursuit behavior:

• Lull/Low alert level and strong awareness behavior: in XML labeled as <StrongUnseen>
• Lull/Low alert level and weak awareness behavior: in XML labeled as <WeakUnseen>
• Medium/High/Combat alert level and strong awareness behavior: in XML labeled as <StrongSeen>
• Medium/High/Combat alert level and weak awareness behavior: in XML labeled as <WeakSeen>
• Lost (when an AI had a definite contact but lost it): in XML labeled as <Lost>

If an AI registers any sound or peripheral vision contact inside its pursuit range while its alert level is below the alert level set in its Investigate parameter, then this AI will only look in the direction of the disturbance for a short time, then ignore it and return to its job. However, if the alert level of the AI is high enough, the AI goes into pursuit mode. That means that the AI will get a strong awareness of the enemy (or only weak in the case of peripheral contact), go to the source of the disturbance (the center of the sound sphere in the case of a sound, or the spot where the enemy stood in the case of peripheral eye contact), and will perform the pursuit behavior Look for 10 seconds. After this initial Look mode expires, the AI will perform the pursuit behavior prescribed in its CHAR profile.

The length of each pursuit behavior's execution depends on the HostileThreat timers (ONCC file), as described in the section above.

Modding hints: Pursuit mode complications and weird glitches

Watch this YouTube video. Pursuit mode is quite buggy, so when setting pursuit behaviors, there are several important things a modder has to have in mind.

• The pursuit distance parameter in CMBT is important in deciding whether the character should be more of a pursuer or more of a guard.
• Within the pursuit distance, peripheral vision pursuit follows its own rules. When an AI sees an enemy with its peripheral vision, this AI always goes into weak awareness mode and either just glances in the direction of this enemy (alert level was below Investigate level) or moves to the spot and performs weak investigation pursuit behavior (alert level was at Investigate on higher).
• Remember that there are TWO sets of pursuit behavior:
  • strong and weak pursuit for lull/low alert levels. In XML these are called <StrongUnseen> and <WeakUnseen>, however those names simply reflect how many changes were made to this part of the game.
  • strong and weak pursuit for medium/high/combat levels, in XML called <StrongSeen> and <WeakSeen>.
• From all the available pursuit behaviors, only GoTo, Look, Glance, Forget and Wait can be effectively used as CHAR pursuit behavior parameters. Hunt and Move are not finished code-wise.
• Remember that general pursuit behavior is simply glitched, and the parameters from CHAR are more often ignored than actually used. The glitchiness is somehow connected with vision. When AI vision is turned off via ai2_blind=1, pursuit mechanics work as they should. However, the moment that AIs are allowed to see, then when pursuit should be performed, it results in:
  • pursuit values from CHAR being ignored if pursuit mode was called while the character was idle or moving along a patrol path. The AI character performs basic GoTo + timer-based Look for the whole period of pursuit behavior, for both strong and weak awareness. Looks so-so but definitely is a glitch.
  • one GoTo + timer based Look being called, but the timer for Look fails to decrement, so the AI simply stands and stares forever. This happens when pursuit mode is called while an AI stands at a job location on a patrol path. And, well... it looks really bad.
  • correct behavior roughly 10% of the time. It is quite random, but it looks like the AI has to be somehow disturbed while going for the source of a previous disturbance. And then Oni writes to the developer console "pursuit mode Hunt not yet implemented" ^_^.
• The best way how to deal with the pursuit/vision issue is to either ignore it (so the character often gets glitched) or use a BSL script to create a small looping function where ai2_blind is set to 1 for at least one second (60 frames), then set to 0 again. It can cause funny moments of an AI completely ignoring an enemy right in front of it, but it silently fixes these pursuit problems.

Alarm behavior - "She's everywhere!"

Control	Alarm	Data

In order to make AI look more humane, it is a good idea to grant it ability to interact with the world the same way player does. In Oni that means for example to give AI option to use consoles.

Watch this YouTube video.

BSL scripting provides a command to make AI go and use a console - ai2_doalarm ai_name/index number of console. This way AI can be told to use any console. But there is a method to make AI character use a console completely on it own.

In order to utilize those mechanics, there is a need for a console which has ALARM CONSOLE flag set (see OBD:BINA/OBJC/CONS). In XML this flag has a string IsAlarm. Such a console then can be used by AI characters without scripting.

Next, there are Alarm parameters in CMBT profiles which define AI character's alarm behavior:

• Search distance - a perimeter around the character where engine checks for any console with ALARM CONSOLE flag. In xml it is named <SearchDistance>.
• Ignore distance - a perimeter around AI character where this AI character (which is currently executing alarm behavior) acknowledges enemies. Enemies outside of this perimeter are ignored by the AI character. In xml it is named <EnemyIgnoreDistance>.
• Attack distance - a perimeter around AI character where this AI character (which is currently executing alarm behavior) temporarily stops its run for the console and attacks enemies if they are within this range and AI character sees them with central vision field. In xml it is named <EnemyAttackDistance>.
• Damage threshold - in xml named <DamageThreshold>. Time interval for which AI character keeps awareness of enemy who attacked it. If this enemy crosses Attack distance perimeter, AI temporarily stops its run for alarm and immediately attacks this enemy (does not have to see him with central vision field).
• Fight timer - in xml called <FightTimer>, duh. Numer of frames for which AI character should fight with the enemy before it attempts to resume its run for alarm.

Logic for alarm running is set, now how to trip it? There are three ways how to make character run and use a console without BSL. the console must have ALARM CONSOLE flag set and ust lie within Search distance perimeter:

• in CMBT: If no gun behavior set to "Run for Alarm". In xml it is RunForAlarm string inside <NoGunBehavior>. By setting this parameter, AI character will attempt to run and use a console when it does not have a loaded weapon or spare clips in inventory (then it reload and continues shooting). If there is no alarm console nearby, AI will switch to Melee.
• in CMBT: Behaviors (Long, Medium, Short, MediumRetreat, LongRetreat) can be set to be "Run for Alarm". DO NOT confuse with "Run for alarm If no gun" behavior! This behavior is never used in retail Oni, the reason probably being the fact if there is no useable console within Alarm search distance radius, then AI character simply stands and stares even when enemy is visible with central vision field.
• In CHAR: Lost behavior "FindAlarm" - When AI character makes definite contact with enemy and then enemy manages to escape, AI executes "Lost" behavior (see "Pursuit of enemy" section). This behavior is typically set as ReturnToJob, but FindAlarm works well with no known issues. If alarm console is not found within search distance, AI returns to its job.

A couple of notes regarding AI character:

• in order to register enemy and attack her/him pre-emptively, AI character must have "HostileThreatDefinite" timer set in ONCC file to some value over 60 (Oni runs 60 frames per second).
• "If no gun" behavior "Run for Alarm" can get glitched. "Alarm enemy attack distance" is set to some value, let's say 100. Now when AI character runs for alarm and enemy attacks it, then if in this CMBT profile there is not set melee override for range at least 100 (via melee override or by heving "Melee" set in corresponding combat ranges, see section Combat behavior), chances are AI will get stuck in a loop trying to reach both enemy and console at the same time.
• Similar issue can happen with combat behavior Run For Alarm as well, but this time problems rise when this combat behavior Run For Alarm is set as Short range behavior.

A couple of notes regarding target console:

• Console must be in "activated" mode. If console is in deactivated or used modes, alarm behavior will not be executed.
• Console must be directly accessible. Oni AI cannot use consoles in order to open path to get to the point of interest (target console in this case). Target console must be directly accessible. Still, it can be directly accessible across the whole level ^_^.

As already mentioned, Alarm behavior can be tripped by BSL command ai2_doalarm. In that case alarm behavior is executed but this time console is set by command instead of being looked for via Search distance. Also, by ai2_doalarm AI can be made to use any console, not only those with ALARM CONSOLE flag.

Modding hints: ability of AI to use consoles is an excellent tool for increasing a challenge.

• Beware of setting Run For Alarm combat behavior as close range one. Such a setup causes glitches.
• On the other side, combat behavior Run For Alarm can be deliberately used to add element of surprise to fights. In CMBT profile, set Run For Alarm as either Medium or MediumRetreat behavoir, then shorten interval between <MediumRange> and <ShortRange> values (for example set "Medium Range" to 60 and "Short Range" to 59). Thanks to this setup, AI can attempt to find an alarm console while still being capable of fighting even when no alarm is nearby.
• In BSL a modder can easily distinguish if console was used by player or AI thanks to chr_is_player(ai_name) function. All what is required is a BSL function being triggered when console is used. Here is example where console triggers a function called console1_used:

func void console1_used(string ai_name)
{
 if(chr_is_player(ai_name))
 {
  *Some code in case player used the console*
 }
 else
 {
  *Some code in case AI used the console*
 }
}

• Other way of using alarm mechanics is to create a feeling of cooperation - player has to achieve something and in order to do so, an AI driven sidekick who goes after needed console and uses it is required.

• In extreme case, AI character can be even made to though the level on it own, moving from one console to another. That can be used to create chasing levels - AI character has to activate a certain number of consoles while player is required to stop this AI character from doing so. Thanks to Alarm behavior the task of tripping consoles can be fully completed by AI, no scripting needed. such a setup is on the one side prone to possible AI glitches, but on the other side can add element of randomness and increase replayability.

Combat behavior part 1 : "Hokey religions and ancient weapons..."

File:CombatRanges.PNG

Combat ranges of an AI character.

Of course an action game like Oni is not complete without guns blazing and fists flying through the air. But combat in real life is usually very fickle and everything has to be considered. How can Oni AI possibly deal with such a complex task?

Oni AI character has to have definite awareness of the enemy in order to actively attack him. Alert level of the AI character when in combat mode is Combat (duh). Definite awareness can be achieved by these ways:

• Enemy was seen by this AI character's central vision field.
• AI character is made to attack the enemy by BSL function ai2_attack.
• AI character was hurt by the enemy, be it melee or gun damage.

Once combat mode is entered, then as long as HostileThreatDefinite timer for this enemy does not reach zero, AI character will always know exact location of this enemy and will attempt to attack it. The moment HostileThreatDefinite timer is depleted, AI character loses the privilege of knowing exact location, awareness decerases from definite to strong and AI character either switches from combat mode with this enemy to pursuit mode with this enemy (see section Pursuit of enemy) or, in case of other enemy being present in central vision field, picks this new enemy as a target to attack and keeps old enemy in strong (and later weak and later forgotten) awareness.

Since generally method of combat depends on distance between participants, some sort of spacing is needed. Oni uses system of three ranges around AI, called combat ranges. See picture on right. Perimeters of these ranges can be set in CMBT profile.

These ranges work as "triggers" to make the AI character execute various behaviors, based on enemy's position. Moreover, Oni can distinguish between states when enemy entered specified range or exited specified range. So all range possibilities in Oni which can be assigned some combat behavior are:

• Short - enemy is closest to the AI character
• Medium - enemy is approaching the AI character and crossed from Long Range into Medium Range.
• Long - enemy is approaching the AI character and starts from the Long Range.
• Medium Retreat - enemy is retreating from Short Range into Medium Range.
• Long Retreat - enemy is retreating from Medium Range into Long Range.

Well of course nothing is perfect and in Oni there is a bit of an issue with proper switching between combat ranges, so Long and Medium ranges are used only once at the beginning of enemy approach. Only Short, Medium Retreat and Long Retreat ranges are used on regular basis in a combat. Even when enemy runs into Long Retreat and goes back to to medium range, engine does not switch AI behavior range to Medium, but (contrary to its name) to Medium Retreat.

OK, we have positioning, now for actual behaviors AI character can be set to execute within these ranges. There are fourteen possible combat behaviors (in brackets are xml strings):

• None (None) - simply nothing
• Stare (Stare) - AI character stands and stares, does not even rotate to face enemy
• Hold and fire (HoldAndFire) - AI character stands still and fires a weapon. If this character does not have a weapon, then she/he switches to melee.
• Firing charge (FiringCharge) - AI character runs towards the enemy and fires a weapon. If this character does not have a weapon, then she/he switches to melee.
• Melee (Melee) - AI character always uses melee, even when she/he holds a loaded weapon.
• Barabbas shoot (BarabasShoot) - AI character stands still and fires a weapon with hardcoded three seconds pause between shots. If this character does not have a weapon, then he switches to melee. If this character meets certain conditions, she/he can start health regeneration. More detailed info about regeneration mechanics can be read HERE.
• Barabbas advance (BarabasAdvance) - AI character runs towards the enemy and fires a weapon with secondary fire mode (as if player pressed right button). If this character does not have a weapon, then she/he switches to melee. If this character meets certain conditions, she/he can start health regeneration. More detailed info about regeneration mechanics can be read HERE.
• Barabbas melee (BarabasMelee) - AI character uses melee, even with loaded weapon in hand. If this character meets certain conditions, she/he can start health regeneration. More detailed info about regeneration mechanics can be read HERE.
• Superninja fireball (SuperNinjaFireball) - Mukade's long range behavior. With this behavior AI cannot shoot weapons and cannot use melee, simply runs towards the enemy. However, if weapon is held, character can use melee (probably something from weapon melee override). AI character is occasionally teleported into the back of the enemy (AnimType 222 - Teleport In) if distance to enemy is greater than 100. It seems like it should work regularly once distance to enemy exceeds 100, but in reality something screws this teleport mechanics ^_^. Anyway, to add more to this behavior AI executes two special TRAM animations:
  • AnimType 224 - Ninja Fireball, after the use there is 20 seconds pause before then this TRAM is used again.
  • AnimType 225 - Ninja Invisible, grants 10 second cloak, after the use there is 20 seconds pause before this TRAM is used again.

IMPORTANT There is an annoying problem with this behavior. When it is called, it checks character's position height-wise from the origin of the game world (coordinates 0,0,0) and if the height is below 550, this character is automatically moved to height 550 (which in almost all cases means death by falling).

• Superninja advance (SuperNinjaAdvance) - Mukade's medium range behavior. With this behavior AI cannot shoot weapons and cannot use melee, simply runs towards the enemy. However, if weapon is held, character can use melee (probably something from weapon melee override). This behavior gives ability to use AnimType 225 - Ninja Invisible which grants 10 seconds invisibility. In order to be able to use this ability, AI has to be at least 50 (or 40?) units far from its enemy. Cooldown for this special technique is 20 seconds. Again, annoying over 550 height check is present.
• Superninja melee (SuperNinjaMelee) - Mukade's short range behavior. With this behavior AI cannot shoot weapons but can use melee. This behavior gives ability to use AnimType 225 - Ninja Invisible which grants 10 seconds invisibility. In order to be able to use this ability, AI has to be at least 50 (or 40?) units far from its enemy. Cooldown for this special technique is 20 seconds. This behavior also grants ability to teleport away from enemy to certain distance (around 100 units) if any one of these conditions is met:
  • About 35 points of damage dealt to this character in a short time (exact amount of damage and exact timing not known).
  • This character get thrown by any throw.

Again, annoying over 550 height check is present.

• Run for alarm (RunForAlarm) - see section Alarm behavior.
• Mutant Muro melee (MutantMuroMelee) - AI character is only allowed to melee, will not fire weapons. This behavior casts chenille (overpower effect) on the user. Of course in order to see visible effect character has to have set <HasDaodanPowers> to 1 in ONCC. This chenille mode does not grant damage overpower effect, melee attacks deal their usual damage. If ONCC has set both <HasDaodanPowers> and <HasSuperShield> to 1, the chenille mode called by this behavior grants super shield.

Chenille mode lasts forever if it is not terminated either via BSL or by AI character performing a TRAM which has a DisableShield flag. After 10 seconds interval, chenille is turned back on. Another specialty of this behavior is automatic backwards evasion move when about 35 points of damage or a throw are applied on the AI character. Chenille mode is turned off if this AI character switches to some other combat behavior because the enemy moved to some other combat range.

• Mutant Muro thunderbolt (MuroThunderbolt) - Upon initial contact AI chracter turns on chenille mode and runs towards enemy. If chenille mode is turned off, then until definite awareness of the enemy is lost this behavior will not cast chenille mode again. This behavior also allows the AI character to use special long range attack - chracter turns off chenille, goes into AnimState 69 (Thunderbolt) and loops special TRAM animation of AnimState 69 (Thunderbolt) and AnimType 231 (Muro_Thunderbolt). That lasts for 10 seconds. Then AI makes 5 seconds pause during which it runs towards enemy. If after those 5 seconds AI character is still executing Mutant Muro thunderbolt behavior, AI character starts again looping the TRAM animation which has AnimType 231 and AnimState 69.

This behavior's special (looping TRAM animation) lasts even when enemy enters some other combat range with the exception of Short range. If enemy enters Short range while the looped animation is running, the loop is forced to stop and AI character starts using Short range behavior.

Modding hints: Combat behaviors can have severe impact on AI performance in a fight but can as well hinder the AI

• Remember: due to a glitch, crucial behaviors for combat are Short, MediumRetreat and LongRetreat. Long And Medium are used only at the beginning of an ecounter.
• In general, use common sense. There is little use in setting Firing Charge as Short range behavior.
• Barabbas Shoot and Barabbas Melee behaviors have access to heal ability which can be a great asset for introducing mutants or stronger enemy units. However, remember that Barabbas Shoot limits rate of fire to one shot per three seconds.
• Barabbas Advance is the only behavior which allows AI to fire a weapon with secondary fire mode. However the behavior is quite glitched (AI character often looks away and fires stray shots). Still, with proper gun and proper setup it can be useable for boss fights.
• Superninja's behaviors sound excellent for cunning enemy units, however annoying check for character's minimal allowed height from world origin and subsequent forced repositions severely impact these behaviors' usefulness. Despite the height limit, with deliberately designed level which is uplifted enough on purpose, the behavior will not cause random AI character repositioning. Then it can be used to its fullest.

One other important thing about these behaviors - if AI character does not have required TRAMs in her/his TRAC, the AI character can get stuck if she/he uses these behaviors.

• If there is no console with ALARM CONOSLE flag within Alarm sarch distance, then behavior "Run For Alarm" will make AI enemy just stand and stare. Set this behavior with caution and consider using a workaround where medium and short combat ranges have very close diameters with Run For Alarm being MediumRetreat behavior, so Run For Alarm behavior is executed only for a brief amount of time as AI practically immediately switches to LongRetreat. However even one frame is enough because if alarm is found, AI character is requested to perform alarm run which can override combat (see section Alarm behavior for more info).
• MutantMuro melee can be used to create tricky foes which have to be eliminated from distance because if player comes up close, these enemies will turn on their (super)shield and won't put it away (no TRAM with DisableShield flag). That means player has to put some distance between him and these AI characters in order to make them disable the shield.
• MutantMuro thunderbolt should NEVER be assigned to Short range behavior as that will negatively affect its special attack. Set it as LongRetreat or MediumRetreat. This kind of behavior (with proper TRAMs) can be used to create foes who will perform special long range attack if player tries to keep a distance. This ranged attack does not have to be the same as Muro's tractor thunderbolt. For quick example, AI character can be made to fire a sort of aggressive plasma beam.

Combat behavior part 2 : "Guns or not, my fists are hot."

Combat ranges and various AI combat behavior was discussed in previous section. Even with combat ranges, there are still other parts of combat to be taken care of - picking up weapons from the ground, melee overrides of weapons, behavior if character is unarmed and of course, firing weapons or using hand to hand combat. Files inspected in this section will be CMBT profiles and ONCC files.

"Melee override" (CMBT profile) - similar to BSL command chr_dontaim, this behavior bids the AI character to use hand to hand animation varient (see TRAM) and to switch from whatsoever other behavior to melee combat. This field was probably added to deal with conflicts when multiple AI behaviors are applied on character. Possible values are (xml strings in brackets):

• None (None) - no override is used.
• If Punched (IfPunched) - melee override applied when AI character is melee attacked by its enemy. Does not work when the character is invincible (cheat).
• Cancelled - unfinished stuff, does nothing. Remains only the question what it was meant to be...
• Short (ShortRange) - Melee override is applied when enemy is within Short range.
• Medium (MediumRange) - Melee override is applied when enemy is within Medium or Short range.
• Always melee (AlwaysMelee) - Melee override is applied withing all combat ranges

This override can affect:

• Alarm running - It is even required if alarm run is called via "If no gun" alarm run behavior, otherwise glitches will appear.
• Retreating behavior - When "If no gun" is set as "Retreat", unarmed AI character will try to run away from its enemy. However, if enemy meets Melee override parameter (for example get into Short range while Melee overrride is set to ShortRange), then this AI stops running away and starts attacking the enemy.
• Weapon firing - If distance between AI character and its enemy is smaller than minimal shooting distance, AI tries to run away from its enemy (still facing the enemy) till distance between characters is greater than minimal shooting distance. However, this backpedal behavior can be overriden by "Melee override" if all conditions are met - AI character then starts using melee (even with loaded weapon in hand) for at least 10 seconds (hardcoded timer) After ten seconds AI tries to restore its previous behavior. If enemy is still too close, Melee override is immediately applied again.
• Weapon pickup - if AI is trying to pick up a weapon and enemy crosses the range specified in MeleeOverride, then weapon pickup behavior is overridden by melee.
• Maybe some other aspects of AI behavior?

"If no gun" behavior (CMBT profile) - this parameter tells AI character what kind of action AI should do if it is unarmed or has empty weapon and no spare clips. Possibilites are (xml strings in brackets):

• Melee (Melee) - AI character attacks enemy with hand to hand combat
• Retreat (Retreat) - AI character runs away from its enemy (a bit glitchy, but works)
• Run For Alarm (RunForAlarm) - see section Alarm behavior. Remainder: this alarm calling behavior requires Melee override set as ShortRange, MediumRange or AlwaysMelee, otherwise alarm behavior gets glitched and AI character gets stuck. If no alarm console is found within Alarm search distance, AI character resorts to melee.

File:GoForGun.JPG

AI character moving to a weapon.

Weapon pickup behavior (ONCC file) - when in combat mode, unarmed AI character can be told to move to a loaded weapon and pick it up or to switch held empty gun for a loaded gun which is lying on the floor. Overall, AI characters only register pickable weapons which are lying around them up to a distance of 60 units (hardcoded). Weapons which are lying further than 60 units from the AI character are ignored. In ONCC file these parameters can be set to alter gun pickup behavior (xml tags in brackets ):

• Chance for pickup (GoForGunChance) - percentual chance of AI being told to go and pick up a weapon. It seems that the weapon closest to the AI character is always chosen to be picked up.
• Running pickup (RunPickupChance) - percentual chance of AI picking the weapon by performing an evasion move (melee dodge move).

Getting up after being knocked down (ONCC file) - if AI character is knocked to the ground, it stays on the ground for a while (simulation of concussion) then gets up. In ONCC file there are two parameters regarding getups (xml tags in brackets):

• Knockdown minimal number of frames (DazedMinFrames) - minimal number of frames for which AI character stays on the ground.
• Knockdown maximal number of frames (DazedmaxFrames) - maximal number of frames for which AI character stays on the ground.

If knockdowned AI character gets hit by melee, it gets up immediately after the hit. Being hit by weapons does not make AI character instantly get up. Standard getups are simple ones (as if knockdowned player hit some direction key). If AI character is in melee combat mode, its MELE profile has getup attacks listed and enemy is within the required range, chance is this AI character will use getup attacks or instead of simple getups.

Making sure enemy is dead (ONCC file) - yes, even this is a part of Oni combat Artificial Intelligence.

When enemy is defeated in hand to hand fighting, AI character stands for a while and "checks" if enemy is dead. During this interval AI character can utter a short victory speech if corresponding sound slot in ONCC is filled and percentual chance roll is successful. Also during "check body" time interval AI character can perform a taunt animation if percentual roll is successful. Here are listed all related fields from ONCC file (xml tags in brackets):

• Investigate body (InvestigateBodyDelay) - time interval for which AI character stands next to its defeated enemy and stares at him.
• Dead taunt chance (DeadTauntChance) - percentual chance of performing taunt animation.
• Check body sound probability (CheckBodyProbability) - Percentual chance of playing victory speech.
• Check body sound (CheckBodySound) - link to Oni Ambient sound file (OBD:OSBD/OSAm).

If the enemy is defeated by weapon, then AI character keeps shooting this dead enemy for some extra time to "make sure" the enemy is dead, then comes close to investigate the body. No taunts, no win phrases. Parameters of this behavior are:

• Dead make sure (DeadMakeSureDelay) - time interval for which AI character keeps shooting the dead enemy
• Investigate body (InvestigateBodyDelay) - it is the same as the one listed above.

Modding hints - behaviors enlisted in this section can be combined to achieve quite impressive results.

• Unfortuantely, Oni does not provide (code-wise) any AI routines to deal with dynamic holstering and unholstering of possessed weapons. Thus, melee overrides are the only way how make armed AI character somehow defend itself when enemy gets too close.

Nevertheless, BSL provides function to make character holster or unholster a weapon - chr_forceholster. In order to make a character holster the held weapon, this character has to be using pistol or rifle animation variant (see TRAM). Since AI characters can use walk_noaim and run_noaim movmement modes (which disable weapon variant i.e. aiming with weapon), the weapon variant should be explicitly coerced via BSL function chr_dontaim. Unholster is easier, simply character has to be be executign some overlay-comaptible animation at the moment when chr_forceholster is executed. That means standing/running/crouching/walking/jumping is OK and function will succeed, but attack animations or animations of getting hit are not OK and function will fail.

• IMPORTANT NOTE: The AI character must be "active" all the time in order to perform BSL animation checks (chr_wait_animation/animtype/animstate checks). Remember that Oni was made back in years 2000/2001, so various tricks were used to save memory and enhance performance. One of these feints is making invisible characters (behind wall, behind closed doors etc) go into INACTIVE mode, which means they are only stored in a RAM memory as a structure, but no physics, no checks for collisions and no drawing functions are applied on them in order to save system resources (BTW yes, that means inactive characters can walk in air and pass through walls). On the contrary when character is ACTIVE, it is fully operational, physics working, collisions being checked and character being ready in graphics memory to be drawn anytime. To make sure character stays active means either applying individually "chr_lock_active ai_name", or (since now is year 2011 ^_^) simply applying "chr_all_active=1" to make all characters be ready to be drawn anytime.

Here is a simple example of a BSL scripted holster behavior. Character is given a gun, then weapon is holstered. When this AI character notices enemy and plays startle animation, then unholster is called. THIS YouTube video shows the script in action.

 #Setup of AI - gets spawned, forced to be always active, weapon gets holstered.
 ai2_spawn A_t48
 chr_giveweapon A_t48 w1_tap
 chr_lock_active A_t48
 sleep 1
 chr_dontaim A_t48 0
 chr_forceholster A_t48 1
 sleep 1
 #Surprise behavior - unholster weapon when AI character is startled
 chr_wait_animtype (A_t48, Startle_Forward, Startle_Back, Startle_Left, Startle_Right)
 chr_forceholster A_t48 0
 #Aftermath - AI is usually walking only if it is not in combat mode, so let's use it as a trigger that weapon can be holstered.
 chr_wait_animtype (A_t48, Walk, Walk_Backwards)
 chr_dontaim A_t48 0
 chr_forceholster A_t48 1

• Melee override can be used together with "Go For Gun" behavior and properly sized Short combat range to create AI characters who jump the gun each time they have a chance yet they are not allowing enemy to land free hits in the process (If enemy gets too close, Short range melee override kicks in).

• "If No Gun" behavior "Retreat" works in a rather simple manner - if unarmed, AI character is given a desire to run as far away from the enemy as possible. This behavior can look a bit awkward, but is useful for making more life-like civilians. Combined with Melee override at "short range" or "if punched" and a bit of BSL scripting to deliberately switch between "combatant" and "non-combatant", a modder can achieve impressive yet lightweight (on game engine) results. See this YouTube video.

• Setting short getup times is a good way to make AI driven character formidable opponent in hand to hand combat. However, too short getup times can introduce problems. It is a good idea to experiment with getup parameters till the character feels "natural".

• Don't overextend "Check body" and "Dead make sure" timers. It looks silly and on top of that it makes AI characters easy targets of a surprise rear throw.

Combat behavior part 3: "They see me shootin', they hatin'..."

Back in 2001 Oni was highly praised for its mixture of shooting and hand to hand combat. Now what could AI designers of Oni possibly do to make AI characters aim, pull a trigger or to make them avoid being hit by enemy? In this section, ONWC, together with ONCC and PAR3 will tell the story.

First let's look into ONCC file. In XML file, under <AIConstants>, there's a tag named <Flags>. In binary file it is a bitset, so more than one flag can be written into it. XML strings for flags are:

• noStartleAnim - Disables startle animation when AI sees the enemy for the first time.
• EnableMeleeDodge - Enables firingspread/projectile dodging when AI is in pathfinding mode or combat melee mode
• RunAwayDodge - Enables firingspread/projectile dodging even when AI itself is shooting a gun. AI character stops shooting and tries to move away from the danger area.
• ShootDodge - Enables firingspread/projectile dodging even when AI itself is shooting a gun. AI character keeps shooting its enemy while at the same time attempts to move away from the danger area.
• NotUsed - Some ONCC character have this bit set, however it looks like it does nothing.

File:Firingspread.PNG

Example of a firingspread.

File:Projectile.PNG

Example of a projectile with AI dodge radius (blue sphere).

Gunfire dodging mechanics. Gunfire dodging mechanics is a quite interesting part of Oni AI system. Interesting because the retail version features little to no such a behavior displayed which is sad because it gives a feeling of challenge to a gunplay. In order to make AI character perform dodge mechanics, this AI must be in combat mode with some enemy. Without combat mode and some enemy, AI character won't dodge. Next, AI characters perform dodge when the character intersects with:

• Firingspread - can be seen by ai2_showfiringspreads=1. Firing spread is an invisible prism (dimensions set in ONWC) which can be created when a weapon is fired. Not every gun has a firingspread as for some guns firingspread is useless (SCRAM cannon, SuperBall gun). If AI character can dodge gunfire and intersects with a firingspread, this AI character starts gunfire dodging mechanics.
• Projectile - epic win of Oni modders, can be seen with ai2_showprojectiles=1. In retail version of Oni, projectile dodging is defunct due to a couple of bugs in a projectile dodging code. Since the engine hackers/modders fixed this issue, AI characters can execute gunfire dodge mechanics versus PAR3 particle, if these AIs are in combat mode with some enemy and the particle has set <AIDodgeRadius> to a positive non-zero value.

AI parameters regarding gunfire dodging are set in ONCC (xml tags in brackets):

• Dodge reaction delay (DodgeReactFrames) - a delay in number of frames. This delay makes A.I character wait a bit inside danger zone before this AI character starts its reaction on firingspred/projectile.
• Dodge timescale (DodgeTimeScale) - how long should the AI character's gunfire dodge reaction last.
• Dodge weight (DodgeWeightScale) - how strong is the desire (???length of vector???) of this AI character to dodge a gunfire. Dodge can add together with other "vector" movements and a sum of all vectors is the direction in which AI character will try to move.

Parameters of firingspread in ONWC are (xml tags in brakets):

• Firingspread length (FireSpreadLength)
• Firingspread width (FireSpreadWidth)
• Firingspread skew (FireSpreadSkew)

Parameter of projectile dodging in particle system PAR3 is AI dodge radius (AIDodgeRadius).

AI character's prowess with guns. Still in ONCC, there are data how "skillful" this AI character should be with each weapon in the game. Weapons are indexed (starting from zero) as follows:

• w0_sec (0) - Only Bungie West empl-yees know what this weapon was supposed to be.
• w1_tap (1) - TCTF automatic pistol
• w2_sap (2) - Syndicate sub-machine gun
• w3_phr (3) - plasma rifle
• w4_psm (4) - phase stream projector
• w5_sbg (5) - grenade launcher alias SuperBall Gun
• w6_vdg (6) - stun gun (Van De Graaf gun)
• w7_scc (7) - scram cannon (swarm of small homing rockets)
• w8_mbo (8) - mercury bow
• w9_scr (9) - screaming cannon
• w10_sni (10) - Mukade's Devil star (annoying red ball) as a holdable weapon; probably a relic from game development
• w10_ba1 (11) - Barabas' gun
• w11_ba2 (12) - Barabas' gun; this one cannot be shot and is probably just a development relic.

For each one of these weapons, there are in ONCC defined these parameters (xml tag in brackets):

• Recoil compensation (RecoilCompensation) - How much the AI cahracter compensates the recoil of the weapon. Setting this to 0.0 mean no compensation, setting this to 1.0 means full compensation.
• Best aiming angle (BestAimingAngle) - In radians, but question is whether it really affects aiming.
• Shoot group error (ShotGroupError) - Random deviation of AI's aim within the target spot. Incorporated to simulate human inaccuracy. Can be set more than 1.0.
• Shoot droup decay (ShotGroupDecay) - Random deviation of the target spot. Target spot is always loosely based on enemy's position. Can be set more than 1.0.
• Shooting inaccuracy multiplier (ShootingInaccuracyMultiplier) - How much can AI stray with its aim from the target. Not clear how much it really affects aiming.
• Minimal shooting delay (MinShotDelay) - Minimal pause between reload and the beginning of a gunfire for this AI character.
• Maximal hooting delay (MaxShotDelay)- Minimal pause between reload and the beginning of a gunfire for this AI character.

Targeting and prediction of enemy's movement. Apart from majority of other games, Oni AI does not "cheat" by being 100% accurate and then having some kind of additive error (even tough additive error is present in Oni, see above). It is a bit inverse - there's a bit of a problem making AI being a reasonably precise marksman ^_^. AI character is given input parameters such as distance between characters, present velocity of its enemy (vector) and velocity of held gun's projectile (number, not a vector). From this data, AI logic computes a prediction of enemy's location and ideal aiming direction in order to hit the enemy.

ONCC parameters for targeting and prediction (xml tags in brackets):

• Predict amount (PredictAmount)- Some sort of multiplier for prediction mechanics.
• Predict position delay (PredictPositionDelay) - In frames, delay before prediction is applied, so AI characters always uses a bit outdated prediction result.
• Predict delay frames (PredictDelayFrames) - In frames, delay before prediction is computed. Must be set at least to 1.0.
• Predict velocity frames (PredictVelocityFrames) - Number of frames interval but meaning not 100% sure. Maybe enemy's velocity data are obtained and used for prediction algorithm during the interval? Must be set at least to 2.0.
• Predict trend frames (PredictTrendFrames) - Number of frames interval but meaning not 100% sure. Maybe a trend (sort of extrapolation of enemy's movement) is computed with data from this interval? Must be set at least to 2.0.

ONWC parameters for targeting and prediction (xml tags in brackets):

• Prediction speed (PredictionSpeed) - More precisely "projectile prediction speed". This value is taken by prediction algorithm as a speed of a projectile fired with the corresponding fire mode of the ONWC weapon. Thus when actual PAR3 projectile's speed is changed, prediction behavior produces misleading values (AI is unable to hit moving targets).
• Maximal inaccuracy angle (MaxInaccuracyAngle) - Maximal allowed deviation of aim from the enemy's character pelvis in order to keep firing the weapon. If exceeded, AI ceases fire and corrects aiming, the resumes fire. Pelvis is taken as a root point of the character, so without any extra chages done to targeting origin and targeting vector (see ONWC) AI characters always target pelvis of the enemy.
• Aim radius (AimRadius) - no idea what it does.
• Ballistic projectile speed (ProjectileSpeed) - special prediction can be used if weapon is meant to fire relatively slow but gravity affected projectiles (grenades). AI then adjusts aiming in order to hit enemy with the projectile according to the ideal (parabolic) ballistic curve. This is a horizontal speed component.
• Ballistic projectile gravity (ProjectileGravity) - vertical gravity attraction for the projectile.

• Targeting direction (Direction) - Vector with three components (x, y, z) which gives orientation of a firingspread. When set to wrong values, firingspread will not cover area where the weapon shoots, but will be pointing in some other direction ( can even point backwards ^_^). Friendly advice: do not alter unless needed.

• Targeting origin (Origin) - Vector with three components (x, y, z) which tells AI where to fire according to enemy's pelvis position. When armed AI is in combat mode with the enemy and shoots him, the AI searches for pelvis (see TRIA) as the pelvis is the only bone recognized by AI system. For AI, pelvis is a representation of a whole character. Now when AI fires at its enemy, the AI aims for pelvis. The vector described in this parameter tells AI where and how much to deviate from enemy's pelvis position.

So when the vector is set as (0, 0, -2), AI will aim and fire at enemy's pelvis position + two units above. That means AI will fire ABOVE the pelvis position. Here is described effect of setting "x,y,z" from SHOOTER's point of view. First to positive, then to neative value:

• x - deviate forward/backward (does not have much of an effect)
• y - deviate right/left
• z - deviate down/up (headshots, anyone?)

Miscellaneous ONWC AI setup - there are a few more parameters in ONWC which affect AI behavior with the weapon. They are (xml tags in brackets):

• Minimal shooting distance (MinShootingDistance) - defines how close can enemy be to the armed shooting AI character. If enemy comes closer than this distance, AI stops shooting and tends to move back a bit (vector type of movement, see HERE) until the distance is again equal or greater than Minimal shooting distance. Then AI opens fire again. To witness the effect, see some AI operating an SBG when its enemy is close to it.

IMPORTANT - for some unknown reason, value from this field is divided by 2. So when 100 is set, ingame AI starts backing when its enemy is 50 units close to it.

• Maximal shooting distance (MaxShootingDistance) - contrary to the parameter described above, this limits how far can enemy be till the AI stops shooting and tends to come closer. See some AI character shooting with w2_sap at distant enemy.
• Fight timer (FightTimer) - a bit similar to timer-based BSL command chr_dontaim. Defines in frames for how long should AI switch from a weapon varient (shooting) to a melee varient (hand to hand combat) if this firing mode was used (don't forget, weapon can has two firing modes) and certain conditions were met. See below for KnockdownSwitcher and StunSwitcher flags explanations.

• basic parameters of a weapon (pistol or rifle type, type of ammunition etc.) can be set as a various flags in ONWC flags field (<Flags> in xml). These three flags from them affect AI behavior (xml tags in brackets):
  • NoHolster - apart from holster disabled, this flag also makes AI character ignore this weapon on the ground. One exception is w10_ba1 when AI character has set Superammo flag (InfiniteAmmo in xml) in its CHAR profile, then this AI character can pick up WMC cannon. If AI character is given the weapon it will fire it, but if the weapon is lying on the ground and AI character does not have superammo flag, this AI character will never pick it up.
  • Stun switcher (StunSwitcher) - if the enemy is within armed AI character's shooting distance and was knockdowned, stunned or blownupped, the AI character switches to a melee for a time specified in the weapon's Fight timer (see above). The flag was designed specially for w6_vdg weapon.
  • Knockdown switcher (KnockdownSwitcher) - Similar to Stun switcher, but only knockdown or blownup makes AI switch to melee. Tailored for w4_psm, probably to avoid AI abuse of an unfair advantage the w4_psm weapon grants (enemy cannot get up as long as she/he is shot).

Modding hints: Phew, what a long section. Described material has plenty of modding possiblities. Still, modders should be aware of a few things:

• Don't set too strong dodge vector (DodgeWeightScale) and don't overdo it with dodge timer (DodgeTimeScale, the smallest possible value is 0.4; lower is not registered). Delay before gunfire dodging (DodgeReactFrames) should be minimal, otherwise it can happen AI won't start dodging till shooter's weapon is empty.

As a side note, there is a glitch in gunfire dodging. It is not a coding bug, but simple limitation of a "vector" type of movement. When AI starts gunfire dodge, it tries to get away from the source of danger (be it firingspread or projectile). And because vector movement works as a "desire" to go to some direction, it can happen AI will express a "desire" to go into wall. In such a case, character stops until the desire to move into a wall stops (in other words, until enemy stops shooting the AI character). When AI character is unarmed, she/he will try to switch between pathfinding movement (to go to enemy and attack him with melee) and vector projectile dodge movement, so it kind of looks like the AI still tries to dodge the gunfire. If weight of a gunfire dodge is set to be smaller than standard vector movement type weight, then AI even does not have to get stuck as it will run in zig-zag pattern towards the armed enemy.

In case AI is armed with a loaded weapon, there is no point in AI running towards enemy. That means if the AI character starts dodging and meets a wall, this AI character gets "stuck" until enemy's gunfire stops. In case this character has set "ShootDodge" in ONCC, it will at least fire back at the enemy shooter. But in case the character has set "RunAwayDodge", then it simply stands near the wall and stares and waits till enemy's gunfire ceases.

From the text above it can be seen that gunfire dodge parameters should be set to make AI dodge but to not make dodge vector outweight the vector for moving towards the enemy.

• AI's skills with weapons (in ONCC) can be used greatly to create sharpshooters or rookies who cannot hold a gun properly. For example by setting "ShootGroupError = 10.0" for w1_tap, we create a total amateur who's hand shakes all over the place when he fires Campbell equalizer.

• Unless really needed, do NOT alter ONCC prediction parameters. Bungie set them quite reasonably and if they are messed, AI character loses the ability of prediction.

• In ONWC, Prediction speed is used for a calculation of AI's aim. The value should be exactly the same as the value of this weapon's projectile. Projectile's velocity is usually set in a emitter of a projectile particle (PAR3). That means Prediction speed and actual speed of a particle used as weapon's projectile may differ, the most significant case being w3_phr (plasma balls accelerate rapidly).

If Prediction speed is set lower than the speed of a projectile is, AI will tend to shoot too much in front of the moving enemy since it will assume projectile is slower than it really is. On the other side, setting this value higher means AI will shoot more directly at the moving enemy (and probably miss) as the AI will assume projectiles are fast enough to hit the target.

• Similar to Prediction speed, there are Ballistic projectile speed and Ballistic projectile gravity. When these two are set non-zero, AI assumes ballistic projectiles (grenades) and tries to shoot projectiles according to an ideal parabole (the solution with shorter fly time is always chosen). In order to make AI sucesfully hit enemy's pelvis, these two must again corespond with PAR3 particles's speed and particles's gravity attraction, but they can be used for modding purposes as well. For example if projectiles's gravity attaction is 0.5 but in ONWC Ballistic projectile gravity is set as 0.3, AI will shoot projectiles at enemy's feet as it will assume that gravity attraction of the projectile is lower thus it does not have to aim so high in order to hit the pelvis (credits to Gumby). Remember: for AI system, pelvis is a representation of a whole character.

• Targeting origin vector (ONWC) can be utilized to make AI fire not directly at pelvis, but for example higher (negative "z" component), so AI can score headshots. So far such a change does not have any purpose as characters don't have damage multipliers for bodyparts. But maybe in future...or with Paradox's headshot mod / material dependent damage mod ideas (see HERE).

• One thing purposefully left out in main talk about weapons is that there is an option for AI chracters to make "startle" misses - when startled, AI fires at some random direction. Parameters for this behavior are in ONCC and ONWC, but overall this feature is so subtle it does not need any special modding attention.

• Remember: in ONWC, Minimal shooting distance is divided by 2. Reason is unknown, maybe some bug in a code.

• Through modification of Minimal shooting distance in conjunction with BSL scripting, a modder can achieve pseudo-dynamic holster behavior. If enemy gets too close, AI start moving away, facing the enemy. Since simply backing away is almost never used by armed AI (it usually move to the side), it can be detected via BSL function chr_wait_animation and subsequent script makes AI character holster held weapon. To unholster, different animation check has to be used, for example a check for a taunt animation. In MELE, modder can set up approppriate melee profile which makes AI character taunt only at safe distance.

Drawback of this modification is is that enemy will not fire the weapon at point blank range and also it limits Melee override in CMBT to be only None or IfPunched, otherwise instead of backing away, AI character goes directly into melee.

Combat behavior part 4 : "Everybody was kung fu fighting..."

Ah yes. After all those OTHER things, we finally got to how AI system handles the core gameplay feature of this game, hand to hand combat. First things first. As usual, player can see her/his enemy trying to perform some move, so player can then react. AI character cannot see a thing beacuse it does not have human eyes nor human brain. Thus the first question is how the AI knows about incoming attacks?

File:Melee zones.JPG

Rough idea of melee zones.

Answer lies within TRAM files. Each animation which can hurt somebody should have EXTENTS. Extents are invisible marks which tell AI character how the attack's trajectory looks. There are two types, horizontal and vertical, but more important thing AI wise is that without extents attack TRAMs will not be registered by AI characters as attacks, so AI will not try to block them or dodge or attack with the TRAM animation properly. But if the attack has extents, then AI gets a complete knowledge of a whole path of attacking bodyparts of this enemy's attack (see attack part of TRAM).

This info is used by melee part of AI for defense purposes (deciding what kind of dodge move to choose and whether to crouch or not) and for attack purposes - position move in melee techniques are used to give general info about the melee technique's positioning, but AI character will not execute the attack move of the technique till enemy is within chosen attack move's extent range.

Also, for hand to hand purposes engine recognizes roughly four zones around a character, see picture on right. These zones are then corresponding with position moves, so when melee techique has for example CloseBack, then the only time this melee techique is listed for possible execution is when enemy is in the back of the AI character. In all other cases (enemy in left, right or front zone), this techique is NOT listed for use. Exception is a technique with GenerousDir flag, see below for more info.

Fistfighting AI mode is handled via MELE profiles. MELE profile is assigned to the spawnable character in its CHAR profile. When in melee mode, AI character uses vector type of movement. Unless specified otherwise, AI character is made to run towards its enemy.

MELE profile always contains these parameters (xml tags in brackets):

• Character class (CharacterClass) - Link to an ONCC class. Level of importance of this parameter not known, but maybe it is neccessary in order to allow for performance of some attack moves (engine checks referenced ONCC class and its TRAC).
• Notice (Notice) - percentual chance that AI will register incoming attack. In retail profiles it is always set 100.
• Dodge base (Base inside Dodge) - percentual chance AI will try to use one of evade moves (if it has any in evade section of MELE profile) to avoid getting hurt.
• Dodge extra (Extra inside Dodge) - extra chance to dodge
• Dodge extra damage (ExtraDamageThreshold inside Dodge) - amount of damage for activation of extra dodge
• Single block skill - (Single inside BlockSkill) - percentual chance of attempt to block incoming enemy's attack
• Group block skill - (Group inside BlockSkill) - percentual chance of ???. Not sure, maybe of blocking more attackers?

• Not blocked (NotBlocked) - Multiplier which affects weight of techniques which will not be blocked by the enemy under current circuumstances (punch combo against opponent who is running forward).
• Must change stance (MustChangeStance) - Multiplier which affects weight of techniques which force enemy to change stance (standing, crouching) in order to block it under current circuumstances (leg sweep against standing opponent).
• Blocked but unblockable (BlockedButUnblockable) - Multiplier which affects weight of techniques that have "unblockable" flag in its attack part, see TRAM-attack part.
• Blocked but has stagger (BlockedButHasStagger) - Multiplier which affects weight of techniques that makes enemy stagger if the enemy blocks the technique. Depends on TRAM attack part settings (BlockStagger), see TRAM-attack part.
• Blocked but has blockstun (BlockedButHasBlockStun) - Multiplier which affects weight of techniques that lock enemy in a blocking animation for longer than 20 frames. Depends on TRAM attack part settings (BlockStun), see TRAM-attack part.
• Blocked (Blocked) - Multiplier which affects weight of techniques that will be certainly blocked by the enemy under current circuumstances and will not stagger nor stun the enemy.
• Throw Danger (ThrowDanger) - Something with throws, but only Bungie West knows what's the meaning of this field.

• DazedMinFrames, DazedMaxFrames - documented by Neo. Question is - do these two parameters actually have effect, since getup time is controlled from ONCC?

Basic melee setup is done. Now the profile branches into attack part, evade part and maneouver part. Each part has a certain number of "melee techniques". Melee technique is a compound of one or more melee moves. Melee move is a simple element of hand to hand combat - attack, throw, positioning command or some maneuver. Maximal amount of techniques in one melee profile is 32. If this limit is exceeded, Oni crashes. Let's have detailed look at all three mentioned parts of MELE profile:

• Attack branch - Techniques from this branch are executed when AI is trying to attack and hurt it enemy. Attack branch contains not only attack techniques, but also maneuver techniques as well (more about this later).
• Evade branch - Techniques contain moves which are used to evade attack. That means escape moves (SHIFT + some direction) and/or various jumps/slides. These techniques are picked only when AI character reacts on incoming enemy's attack.
• Maneuver branch - Techniques from this branch should be used by AI to maneuver around, in order to move not only in a straightforward fashion towards the enemy, but also circle around, retreat or advance. Unfortunately, this branch is probably a development relic. In order to see these techniques performed, global BSL variable ai2_spacing_cookies has to be set zero (0). That means AI cannot execute attacks. Only then AI starts performing techniques from this maneuver branch.

The idea was probably to make the AI execute a certain number of attacks (each attack "eats" a cookie), then make the AI maneuver a bit and so on and so on. But somehow this setup was abandoned (question is whether MELE was really planned that way ^_^ ) and techniques from this branch are de-facto never used. That means all maneouvring is done via Attack branch.

Structure of a melee technique:

• Name (debugging purposes only)
• Flags - possibilities are:

• Interruptible - This technique can "home" to some extent and if enemy gets away from its reach, technique is ended prematurely.
• GenerousDir - This technique is enlisted for possible execution even when facing of the AI does not match position move of this technique (technique uses CloseLeft, enemy is directly in front). If technique is used, AI character positions itself in order to perform the techique (in our example case, AI chracter turns left side towards enemy and perform the technique).
• Fearless - does this flag actually do something?

• Weight - Basic weight of the technique. Techniques are chosen randomly but with "weight" of the technique taken into account. Techniques with higher "weight" are used more often than those with lower "weight".

Also, there are more factors which affect final weight of the technique. Basic weight of the technique is according to combat situation (position of the enemy, effect of moves in the technique) multiplied by one of MELE profile setup multipliers (NotBlocked, BlockedButHasStagger etc.), then it is also multiplied by some dimnishing value which decreases weight of the technique if it is used consencutively. And finally, weight of the technique is multiplied by some special "orange tiles" mutiplier, which downweights techniques that would make the AI "fall over the edge", aka dive into orange tiled area.

The equation is PROBABLY very roughy something like this:

Final weight = Basic weight * corresponding MELE profile setup multiplier * dimnish multiplier * "orange tiles" multiplier

• "Importance" - documented by Neo. Does it have any effect?
• RepeatDelay - in frames, how long should be the technique unavailable after its use (to prevent from predictability). For this time the technique is not enlisted in a list of performable techniques.
• Moves, possible types of moves are:

• Position - usually takes three parameters: minimal distance, maximal distance, tolerance range. Meaning of Minimal/Maximal distances is clear, tolerance range specifies extra distance (beyond chosen TRAM attack's extents) where AI chases the enemy till the enemy gets inside the extent range of the TRAM attack this AI charater wants to use. Then AI uses the TRAM attack ^_^.

Some position moves don't have any parameters (Crouch, StartToCrouch) and are used strictly for stance purposes - to make AI perform crouched or special attacks. Position moves are used to give the AI general sorting of available attacks, so based on the melee zone the enemy is in (see picture at the beginning of this section) only corresponding techniques are taken into account as "possible to be used" and the rest is ignored. HERE is a list of all available position melee moves.

• Attack - no parameter, simply some kind of attack action. HERE is a list of all available attack melee moves.

Attack move can be the only move of a techique (no position move). If that is the case, then this techique is put into a list of possibly used techniques only when its prerequisities (positioning and stance) are met via other means. For example Kick_forward can be used without a Position move, but then it is evaluated only when the AI character gets within the extent range of its Kick_forward TRAM move. Then the AI chracter has to somehow get into correct position within extent range of the Kick_forward's TRAM (maybe via other melee techniques), otherwise the technique with Kick_forward is labeled as MISSBOUNDS. When all that is OK, this a melee technique is listed for possible use.

• Throw - no parameter, simply some throw. HERE is a list of all available throw melee moves. Again can be standalone, under circuumstances described above.
• Evade - no parameter, simply some evasive action. HERE is a list of all available evasion melee moves.
• Maneouver - up to three parameters, these moves are used to make AI character move around somehow (advance, retreat, circle left/right) or perform various movements (crouch, jump, taunt, use uncommon getup moves etc.) HERE is a list of all available maneuver melee moves. Almost all maneouver moves have a Duration (in seconds) as a first parameter.

In melee techniques there can be a mixture of melee moves. Very first move (shuold be position or maneouver) is evaluated to make sure if the technique can be performed under current positioning of the AI character and its enemy. However, throws and maneuvers are checked as well even if they are not the first tehnique, so if technique contains Throw_punch_behind, it will be listed for use only if the AI is in theback of its enemy. Surprisingly enough, pairing Kick_forward and Kick_back makes AI character kick forward when position is correct for kick forward move, then it kicks back even tough there is nothing to hit ^_^. Same with other directional attacks.

Also there is one special condition to executing melee techniques. When there is an edge of a platform nearby it is usually covered in pathfinding grid as a seires of special tiles from blue (border) to orange (danger). Engine seems to check if TRAM attack's extent extends into orange pathfinding tiles and according to it it decreases weight of such techniques which would make AI character end in orange field (i.e. going over the edge and falling down). Techniques which utilize jump position moves are excluded from weight decrease, so there is some very limited and random possibility for AI characters to jump aross gaps in order to reach the enemy.

Code behind all this must be pretty complex, hands down before Oni developers who managed to pull this off.

Modding hints: Creating custom MELE profiles can be fun, but beware of a few pitfalls:

• Position moves can be followed by some certain other position moves, but generally after position move an attack or throw move is expected. If attack or throw is not present, this melee technique will be albeled as NOATTACKNOTHROW and will be unused.

• Jump position moves can be used to make AI at least "somehow" jump across gaps. Oni registers special pathfinding grid tiles (edge tiles and danger tiles) which are registered by AI character even she/he is in melee mode. And orange tiles upweight jumping moves a lot. Just don't forget to follow jump position move with some jump attack move.

• Special attack (Rising fury, Devil spin kick) use StartToCrouch position move as a starter.

• Any combo techique (for example three punch combo) without Interruptible flag makes AI character too vulnerable.

• Rear throw techniques and side attack techniques should have high weight to ensure they will be chosen and used the moment there is a chance.

• Set distances in position moves reasonably so AI character doesn't attempt to perform jump attack techniques or run attack techniques at close distance.

• Always try to utilize given class's strength - Fury is fast, so upweight combos. Tanker is slower, upweight throws and run attacks. Ninja is a beast, set whatever you want and it will be annoying to deal with anyway.

THE END...