XML:BINA/PAR3: Difference between revisions

==file structure==  

             <DisableDetailLevel>[... see '''[[#options|HERE]]''' for a possible flag]</DisableDetailLevel>

             <DisplayType>[... see '''[[#appearance|HERE]]''' for a possible flag]</DisplayType>

             <Target>[... see '''[[#attractor|HERE]]''' for a possible flag]</Target>

             <Selector>[... see '''[[#attractor|HERE]]''' for a possible flag]</Selector>

                 [... see '''[[#emitter|HERE]]''' for emitter data]

             [... see '''[[#event types|HERE]]''' for '''''<event_type_tag>''''']

  [... see '''[[#action types and parameters|HERE]]''' for '''<action_type_tag>''']

                     [... see '''[[#action types and parameters|HERE]]''' for '''''<parameter_tag>[[#parameter value types|value]]</parameter_tag>''''']

==options==

!width=100px| content type

! description

| Particle exist for X seconds.

: X is float value, so you could write 1.5 if 1 second is too less and 2 too many.

| Might not always be updated by the engine.

| Hides the particle on creation.

| Particle will not detect attractors if there is a wall between it and the potential attractor.

| Sound used when the particle passes by you. Check: does the engine apply the Doppler effect or is it in the sound file itself?

==properties==

!width=100px| content type

! description

| Needed if the particle is to be able to turn around?

| Used with animated particles. (Documentation Needed).

| Used with animated particles. (Documentation Needed).

: B. Credit a character with damage\kills

For this to work properly, the parent of the character must have this set, and the parent of said parent, etc, up to the original particle.

==appearance==

!width=100px| content type

! description

| How the particle is displayed. (Please Document)

| Degrees. Decal isn't cut off when the next plane piece has an angle difference equal or less to this value.

==attractor==

!width=100px| content type

! description

| Name of a paritcle that this particle is attracted to.

==variable storage types==

!description

|A Float.

|A float from 0.0-1.0, describes where in the ping pong state the event is. (If my memory is correct)

==parameter value types==

8 - color; random; 2 color follow (min, max)

9 - color; bell curve; 2 color follow (mean, stddev)

==emitter==

!width=100px| content type

! description

recherche notes - files with Unknown0020 flag:

| Tag contains the number (threshold) of particle which must be reached before emitter becomes turned off. Threshold needs two flags to be set: IncreaseParticleCount and TurnOffAtTreshold.

Let's say threshold was set to 10 and probability to 0.5 then you might get 5 particle emitted, sometimes less, sometime more, it's an average. (threshold * probability = emitted particle)  

| It's actually a multiplier, set it to 0 and no particle will be emitted. Copies doesn't effects the treshold counting. The copies become emitted at the same place as the original particle so you might not see any difference (because they overlay each other) until they have a random movement.

==event types==

==action types and parameters==

!width=120px| content type

! description

| particle becomes killed after X seconds, it fades out during that time

| has action X as target in Update event section

| Lifetime of the particle MINUS the value stored in this field yields the moment from particle's spawn when the targeted action (action from the "Action" tag) starts operating. Till that moment, the targeted action is held inactive.<BR><font size=1>Example:<BR>Particle's lifetime ticks in a decreasing manner. If the lifetime of the particle is set to be 3.0, then it ticks from 3.0 down to 0.0 (at 0.0, Lifetime event is called).<BR>Now, if lifetime of the particle is set to be 3.0 and value here in this tag is 1.0, then from the moment the particle is spawned, this EnableAtTime's targeted action (the action inside "Action" tag) will be disabled and will activate only after the particle' lifetime crosses value (3.0-1.0) = 2.0 seconds. That means the targeted action will activate 2 seconds after the particle was spawned.<BR>This mechanism is quite counter-intuitive, hence the detailed description.</font>

| has action X as target in Update event section

| Lifetime of the particle MINUS the value stored in this field yields the moment from particle's spawn when the targeted action (action from the "Action" tag) stops operating. Till that moment, the targeted action is kept active.<BR><font size=1>Example:<BR>Particle's lifetime ticks in a decreasing manner. If the lifetime of the particle is set to be 3.0, then it ticks from 3.0 down to 0.0 (at 0.0, Lifetime event is called).<BR>Now, if lifetime of the particle is set to be 3.0 and value here in this tag is 1.0, then from the moment the particle is spawned, this EnableAtTime's targeted action (the action inside "Action" tag) will be working and will deactivate only after the particle' lifetime crosses value (3.0-1.0) = 2.0 seconds. That means the targeted action will deactivate 2 seconds after the particle was spawned.<BR>This mechanism is quite counter-intuitive, hence the detailed description.</font>

|  this action triggers Die event

| particle becomes killed after X seconds

| <font color="#AAAAAA">OSBD</font>''file_name''<font color="#AAAAAA">.amb.oni</font> (file prefix OSBD and suffix .amb.oni not used)

| <font color="#AAAAAA">OSBD</font>''file_name''<font color="#AAAAAA">.imp.oni</font> (file prefix OSBD and suffix .imp.oni not used)

| Character gets moved from its current position by "knockback value" game world units with 0.1 precision.<BR><font size=1>(Example: If value here is 100, char gets moved cca 99,9 units)</font>

Negative values work as well, they reverse the direction. <font size=1>(Instead of being "knocked back", the character is "drawn in")</font>

| tag is missing if value is 0

: 0 - can be applied multiple times on the target character

: 1 - can be applied only once on the character, then is ignored (hurts the target character strictly only once)

| Same as the DamageChar's StunDamage

| Same as the DamageChar's Knockback

| Radius of the damaging sphere.<BR><font size=1>(Example: If value here is 100, character gets damaged if its distance from the position of the damaging particle is less then or equal to 100 game world units.</font>

| <font color="#777777">This tag is not exported if the data field in the oni file is "00". It is exported when "0A" was set.</font>

| this action triggers Explode event

| this action triggers Stop event

| this action kills the particle without triggering the Die event

| Name of impact, registered in ONIE. The looked up material is known from collided particle. Impt and Mtrl file must exist

| unhide particle

| hide particle, cannot collide with characters anymore, emitters stay active

| enables action X in Update event section

| disables action X in Update event section

==glass-piercing bullets==

In the original game, w1_tap goes through normal glass and loses its dangerousness while a bullet of w8_mbo stays dangerous.

Particle can perform ''actions'' if a ''hit wall event'' occurs (<CollideWithWalls> must be true). If the particle hits a breakable material (glass) then <StopIfBreakable /> stops the actions that comes after StopIfBreakable. The particle continue to fly. If it hits now a non-breakable material, all actions are executed.

=notes on locklights=

Locklights are particle which indicate whether a door is locked or not.

They are presented in [[OBD:ONLV|ONLV]] (ENVP section) with different names but are all called from "BINA3RAPlocklight.xml" and "BINA3RAPlocklight2.xml".

 

 

 

The Update event has three action: '''<u>first one has ID 0</u>''', second has '''<u><font color="#AA0000">ID 1</font></u>''', and third action has '''<u><font color="#00AA00">ID 2</font></u>'''.

'''The BINA3RAPlocklight.xml original file doesn't allow new events because of its buggy behavior.''' Gumby solved the problem by putting the "SetVariable" code into the start and stop event. During a final test additional code showed accidentally that particles identifies doors as characters. A small vid can be seen [http://www.youtube.com/watch?v=kY8uH5vRt3Q here.]

=how to set up decorative decals=

: The following steps will show you how to set up a piece of design (poster/warning sign/whatever) into a level.

==step 1 - extending the particle collection==

: '''The maximal tolerance distance counts 10 units.''' Let's say the ground height (y) is 45 and the particle is spawned at 55 then this is the maximal tolerance; 56 wouldn't work.

: '''"chr_debug_characters = 1"''' helps you. But note that the y value is not the head's or pelvis' height, it is at the deepest point of your feet.

* <XScale> .. Scaling of decal's X dimension on ''individual level'' (you can use the 3RAP's own scaling (<Scale>) for accumulative scaling (this would affect all decals in the collection))

===decal facing===

: Place yourself towards the point where you want to have the decal, face it. It's important that your body stands accurate, not your head. Then type "chr_debug_characters = 1" into the developer console and you will know the facing. Write it down, compare with the right table and chose your xyz rotation.

: '''PS:''' In matter of spawning/displaing, the exact rotation is not needed. Oni has a 66 degree tolerance.

==step 2 - creating BINA3RAP file==

* <Version> .. '''<font color="#FF0000">has to be the same version as your own onisplit, change it if necessary</font>

==step 3 - creating TXMP file==

: Of cause the particle file doesn't has to contain an animated image. It's just meant to remind you that this possibility exist.

* <Version> .. '''<font color="#FF0000">has to be the same version as your own onisplit, change it if necessary</font>  

==step 4 - show or hide decals via BSL==

fork respawnable_decals in your main function

  ### decal is already presented so we begin with stop function

=how to set up decorative character items=

Marks, bags, goggles, decorative LSI, flash lights and other equipment could individualize characters by using a (BSL-triggered) particle workaround.

==step 1: ONCC modifications==

First we need to create a connection to the character. For this, we use the Daodan particle system to some degree.  

Now it's enabled for this character. Next we register our item (hold by particle) in the ONCP section.

==step 2: creating the item files==

==step 3: preparing the BSL stuff==

[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/silly_shades.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/silly_shades_TN.png]<br>Karen: "Ready for Matrix. HAR-HAR"

: Only AI would need chr_lock_active.

: chr_super becomes disabled again to prevent other Daodan effects (in case our character would had a chenille or other visuals). We don't have to worry about the item, its live time was set to 0 (infinity). (chr_super 0 only hides the particle, it doesn't kill it.)

This can ''switch on and off'' the item. Other effects could be triggered by the free remaining numbers. A collection of events and their numbers can be seen [[XML:BINA/OBJC/PART|HERE]].

 

==extra demo==

Nah, the texture of such object cannot become replaced by another. But by using three different shades, we can create this illusion. There are blue shades. A ''pair'' that uses an animated texture. And a red pair. The animated pair is only temporary used. [http://www.youtube.com/watch?v=XbOb0i5StDk Here's a vid.]

  ### all three shades particle created