OniGalore

XML:BINA/OBJC/PATR: Difference between revisions

XML Discussion

XML:BINA/OBJC/PATR (view source)

Revision as of 01:21, 3 April 2021

583 bytes added ,  3 April 2021
m
copy-edit
m (the frames were indeed patrolscripts whereby the patrolscript 7 in tctf_ii is missing)
m (copy-edit)
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
=[[OBD:BINA/OBJC/PATR|BINA/OBCJ/PATR]]: patrol paths=
{{XML_OBJC_Header | prev=PART | type=PATR | next=PWRU | name=Patrol Path}}


'''general information'''
==General information==
* '''BINACJBOPatrol Path.oni''' is level specific. (It can be found in edition/GameDataFolder/level''XX''_... )
* The XML on this page is based on OniSplit '''v0.9.61.0'''.
* See [[XML basic tutorial|HERE]] if you don't know how to convert an oni file into XML and vice versa.
* "BINACJBOPatrol Path" is level-specific (level''x''_Final.dat).
* See [[OBD_talk:BINA/OBJC|HERE]] if you are searching for more general information such as how to handle object coordinates.
* A path can have at most 64 points.


;Corrupting BSL code in patrol scripts
:I ([[User:Paradox-01|Paradox]]) suspect that ''instantly'' played BSL code breaks patrol paths. Example: patrolscript0001 contains a sleep command and patrolscript0002 will be played. If you remove the sleep command, the patrol path will break. (This was tested in level 1 SP1 with A_t48 and his patrol_48.)


'''BSL support'''
XML code - patrolscript points:
 
<Points>
    <ScriptId ScriptId="1" />
    <ScriptId ScriptId="2" />
    <ScriptId ScriptId="3" />
</Points>
 
BSL code:
func patrolscript0001
{
dmsg "1"
chr_animate 0 KONOKOpowerup
sleep 1
}
func patrolscript0002
{
dmsg "2"
}
func patrolscript0003
{
dmsg "3"
}
 
==BSL support==
* <font color="#777777">ai2_showpaths = 1</font>
* <font color="#777777">ai2_showpaths = 1</font>
* ai2_dopath ''ai_name path_name''
* ai2_dopath ''ai_name path_name''


 
==File structure==
'''XML structure'''
 
  <?xml version="1.0" encoding="utf-8"?>
  <?xml version="1.0" encoding="utf-8"?>
  <Oni Version="0.9.30.0">
  <Oni>
     <ObjectCollection>
     <Objects>
             '''''[...]'''''
             '''''[...]'''''
     </ObjectCollection>
     </Objects>
  </Oni>
  </Oni>


'''''[...]''''' means at least one patrol block. Paste all your patrol data in there (this includes the <PATR Id="..."> and </PATR> tag).


'''''[...]''''' means at least one patrol block. Paste all a patrol data into there (this includes <Object ...> and </Object> tag).
'''Example'''
 
 
'''example'''


         <Object Id="8283" Type="PATR">
         <PATR Id="8283">
             <Header>
             <Header>
                 <Flags>0</Flags>
                 <Flags></Flags>
                 <Position>-408.598755 60.1162872 -1402.20361</Position>
                 <Position>-408.598755 60.1162872 -1402.20361</Position>
                 <Rotation>0 0 0</Rotation>
                 <Rotation>0 0 0</Rotation>
Line 52: Line 74:
                 </Points>
                 </Points>
             </OSD>
             </OSD>
         </Object>
         </PATR>




'''tags'''
{| class="wikitable" width="100%"
* <Flags> .. unknown -- appears to be always 0
!width=400px| XML tag
* <Position> .. needed ?
!width=100px| Content type
* <Rotation> .. needed ?
! Description
* <Name> .. for BSL command "ai2_dopath"
|-
* <PatrolId> .. used in [[OBD:BINA/OBJC/CHAR|BINA/OBJC/CHAR]]
| <PATR Id="...">
* <ReturnToNearest> .. 1 and 0 possible
| integer
* <Points> .. holds actual patrol content
| ID doesn't matter
:: <MoveToFlag FlagId="..." />
|-
:: <Stop /> (never used in Oni)
| <Flags>
:: <Pause Frames="..." />
| flag
:: <LookAtFlag FlagId="..." />
| Unknown
:: <LookAtPoint X="..." Y="..." Z="..." /> (never used in Oni)
|-
:: <MoveAndFaceFlag FlagId="..." />
| <Position>
:: <Loop>...</Loop>
| float x3
:: <MovementMode Mode="Walk" />
| XYZ position, unused
:: <MovementMode Mode="Creep" />
|-
:: <MovementMode Mode="WalkNoAim" />
| <Rotation>
:: <MovementMode Mode="ByAlertLevel" />
| float x3
:: <MovementMode Mode="RunNoAim" />
| XYZ rotation, unused
:: <MovementMode Mode="Run" />
|-
:: <MoveToPoint X="..." Y="..." Z="..." /> (never used in Oni)
| <Name>
:: <LockFacing Facing="..." /> (not used in Oni)
| string
:: <MoveThroughFlag FlagId="..." Distance="..." />
| Used by BSL command "ai2_dopath"
:: <MoveThroughPoint X="..." Y="..." Z="..." Distance="..." /> (not used in Oni)
|-
:: <StopLooking />
| <PatrolId>
:: <FreeFacing />
| integer
:: <GlanceAtFlagFor FlagId="..." Frames="..." />
| Used in [[XML:BINA/OBJC/CHAR|BINA/OBJC/CHAR]]
:: <MoveNearFlag FlagId="..." Distance="..." />
|-
:: <LookFor Frames="..." Rotation="..." />
|valign=top| <ReturnToNearest>
:: <Unknown18 />
|valign=top| flag
:: <MoveToFlagLookAndWait Frames="..." FlagId="..." Rotation="..." />
|
:: <Unknown20 Frames="..." />
: 1 (Yes)
:: <ScriptId ScriptId="..." />
: 0 (No)
:: <IgnorePlayer Value="No" /> <IgnorePlayer Value="Yes" />
|-
:: <FaceToFlagAndFire FlagId="..." Frames="..." Spread="..." />
| <Points>
| -
| Holds the actual path data (up to 64 points).
|-
| <MoveToFlag FlagId="..." />
| integer
|
|-
| <Stop />
| -
|
|-
| <Pause Frames="..." />
| integer
|
|-
| <LookAtFlag FlagId="..." />
| integer
|
|-
| <LookAtPoint X="..." Y="..." Z="..." />
| float x3
|
|-
| <MoveAndFaceFlag FlagId="..." />
| integer
|
|-
| <Loop>...</Loop>
|
| Patrol path tags can be enclosed by this loop tag.
|-
|valign=top| <MovementMode Mode="..." />
|valign=top| flag
|
: ByAlertLevel
: Stop
: Crouch
: Creep
: WalkNoAim
: Walk
: RunNoAim
: Run
|-
| <MoveToPoint X="..." Y="..." Z="..." />
| float x3
|
|-
|valign=top| <LockFacing Facing="..." />
|valign=top| flag
|
: Forward
: Backward
: Left
: Right
: Stopped
|-
| <MoveThroughFlag FlagId="..." Distance="..." />
| integer, float
|
|-
|valign=top| <MoveThroughPoint X="..." Y="..." Z="..." Distance="..." />
| float x4
|
|-
| <StopLooking />
| -
|
|-
| <FreeFacing />
| -
|
|-
| <GlanceAtFlagFor FlagId="..." Frames="..." />
| integer x2
|
|-
| <MoveNearFlag FlagId="..." Distance="..." />
|  integer, float
|
|-
| <Scan Frames="..." Rotation="..." />
| integer, float
|
|-
| <StopScanning />
| -
|
|-
| <MoveToFlagLookAndWait Frames="..." FlagId="..." Rotation="..." />
| integer x2, float
|
|-
|valign=top| <CallScript ScriptId="..." />
| integer
|Calls a BSL function by ID. For example if the ID is 1 then the BSL function is named "patrolscript0001".
|-
|valign=top| <ForkScript ScriptId="..." />
| integer
|Forks a BSL function by ID. For example if the ID is 2 then the BSL function is named "patrolscript0002".
|-
|valign=top| <IgnorePlayer Value="..." />
|valign=top| flag
|
: No
: Yes
|-
| <FaceToFlagAndFire FlagId="..." Frames="..." Spread="..." />
| integer x2, float
|
|}


    <font color="#777777">'''(listing found stuff for research)''' <Unknown18 />
{{XML}}
<Name>p_sh_tank1</Name><PatrolId>39</PatrolId> lvl 8
<Name>p_sh_s2</Name><PatrolId>42</PatrolId> lvl 8
<Name>p_sh_s4</Name><PatrolId>43</PatrolId> lvl 8
<Name>p_sh_s5</Name><PatrolId>44</PatrolId> lvl 8
<Name>p_sh_s7</Name><PatrolId>46</PatrolId> lvl 8
<Name>p_sh_red2</Name><PatrolId>47</PatrolId> lvl 8
<Name>patrol_25_red21</Name><PatrolId>25</PatrolId> lvl 9
<Name>patrol_38</Name><PatrolId>38</PatrolId> lvl 9
<Name>Pod1_OpeningGuard_1</Name><PatrolId>27</PatrolId> lvl 14
<Name>Lab3_Sci_2</Name><PatrolId>34</PatrolId> lvl 14</font>
Retrieved from "https://wiki.oni2.net/Special:MobileDiff/17784...32999"