OniGalore

XML:BINA/OBJC/CONS: Difference between revisions

XML Discussion

XML:BINA/OBJC/CONS (view source)

Revision as of 15:52, 12 May 2024

4,043 bytes added ,  12 May 2024
m
no edit summary
(Created page with '=BINA/OBCJ/CONS: consols= '''general information''' * (Well, this is pretty much useless unless you can create the rest of the console. See screenshot why...')
 
mNo edit summary
 
(24 intermediate revisions by 2 users not shown)
Line 1: Line 1:
=[[OBD:BINA/OBJC/CONS|BINA/OBCJ/CONS]]: consols=
{{XML_OBJC_Header | prev=CMBT| type=CONS | next=DOOR | name=Console}}


'''general information'''
==General information==
* (Well, this is pretty much useless unless you can create the rest of the console. See screenshot why.)
* The XML on this page was tested with OniSplit version 0.9.61.0 and 0.9.82.0.
* '''BINACJBOConsole.oni''' is level specific. (It can be found in edition/GameDataFolder/level''XX''_... )
* This console spawning doesn't include console geometry unless it's done via [[XML:ONLV|ONLV]] level import.
* See [[XML basic tutorial|HERE]] if you don't know how to convert an oni file into XML and vice versa.
* The BINACJBOConsole file 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.
* All consoles can be seen [http://ssg.oni2.net/subfold/consoles/ HERE].
* All consoles can be seen [http://ssg.oni2.net/subfold/consoles/ HERE.]
* Activation tolerances: the player must fulfill the following requirements before he can use a console:
** A distance of 10 or less world units.
** A distance of -2 WU or less (e.g. you can't activate console while standing inside or behind it).
** A facing of 1.22173 radians (ca. 70°) or less.
** A sideways shift of 8 WU or less.
** A difference of 8 WU or less between pelvis height and console height.


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


'''''[...]''''' means at least one console. Paste all console data into there (this includes '''<font color="#0A0"><Object ...></font>''' and '''<font color="#0A0"></Object></font>''' tag).
'''''[...]''''' is where at least one console is defined. Paste all your console data into there (this includes '''<font color="#0A0"><CONS Id="..."></font>''' and '''<font color="#0A0"></CONS></font>''' tag).
 
==Example==
For level import via [[XML:ONLV|XML master file]], use a pre-compiled (*.oni) file as part of a relative file path, e.g. '''consoles/console0.oni'''.
'''<font color="#0A0"><CONS Id="8179"></font>'''
    <Header>
        <Flags>Locked Gunk</Flags>
        <Position>-1354.927 45 860.053</Position>
        <Rotation>180.000015 0 180.000015</Rotation>
    </Header>
    <OSD>
        '''<Class>console0</Class>'''
        <ConsoleId>2</ConsoleId>
        <Flags>InitialActive</Flags>
        <InactiveTexture>_con_INACTIVE</InactiveTexture>
        <ActiveTexture>_con_MTCOM_DISH</ActiveTexture>
        <TriggeredTexture>_con_MTC_DISHFLASH</TriggeredTexture>
        <Events>
            <Script Function="fconsole_ok" />
        </Events>
    </OSD>
'''<font color="#0A0"></CONS></font>'''
 
==Tags==
{| class="wikitable" width=100%
!width=280px| Tag
!width=60px| Type
! Description
|-
| <Objects>
| -
|
|-
| <CONS Id="...">
| int32
| Any number; no need to be unique. — For [[XML:ONLV|level importing]], use <CONS>.
|-
| <Header>
| -
|
|-
| <Flags>
| flag
| Object flags. Used during development, ignore them.
|-
| <Position>
| float x3
| XYZ position. When creating a new console, use a Y of 0 if the ground plane is 0. The height of the console and the character are both stemming from the ground plane.
|-
| <Rotation>
| float x3
| XYZ rotation. "chr_debug_characters = 1" shows the player's position, so you could face your (imaginary) console and then use a 180-degree flip of your facing for the console's Y rotation. X and Z should be 0.
|-
| <OSD>
| -
|
|-
|valign="top"| <Class>
|valign="top"| link
| Original consoles:
: console_alarm
: console_data
: console0
: console_small_wu_roof
 
For level import via [[XML:ONLV|XML master file]], use a pre-compiled (*.oni) file as part of a relative file path, e.g. '''consoles/console_data.oni'''.
|-
| <ConsoleId>
| int16
| Can be used with BSL commands like "console_deactivate ''ID''".
|-
|valign="top"| <Flags>
|valign="top"| flag
|
: None
:: <Flags></Flags> also works; console will appear disabled.
: InitialActive
:: Console will appear enabled.
: Punch
:: Was used for TRAMKONOKOconsole_punch.
: IsAlarm
:: Alarm console. Used with alarm groups in CHAR.
|-
|valign="top"| <InactiveTexture>
|valign="top"| char[63]
| <font color="#777777">TXMP</font>file<font color="#777777">.oni</font> <font color="#777777">(don't use file prefix/suffix)</font> Image for disabled console. Examples:
 
_con_ALARM_SLEEP / _con_USED / _con_used / _con_INACTIVE
 
'''Use a capitalized file name for this TXMP.'''
|-
|valign="top"| <ActiveTexture>
|valign="top"| char[63]
| <font color="#777777">TXMP</font>file<font color="#777777">.oni</font> <font color="#777777">(don't use file prefix/suffix)</font> Image for an enabled console. Examples:
 
_con_ALARM_SLEEP / _con_INFO / _con_MTC_2 / _con_mtc_stairs / _con_MTCOM_DISH / _con_MTCOM_DISH
 
'''Use a capitalized file name for this TXMP.'''
|-
|valign="top"| <TriggeredTexture>
|valign="top"| char[63]
| <font color="#777777">TXMP</font>file<font color="#777777">.oni</font> <font color="#777777">(don't use file prefix/suffix)</font> Image for a used console. Examples:


_con_ALARM_ON / _con_USED / _con_used / _con_MTC_DISHFLASH


'''example'''
'''Use a capitalized file name for this TXMP.'''
{| border=0 cellspacing=20 cellpadding=0 align=right
|-
| <Events>
| int16
| You can use multiple events.
|-
|valign="top"| <Script Function="call_this_BSL_function" />
|valign="top"| char[32]
| Name of BSL function. For example if you use "call_this_BSL_function" here, then write in your BSL script:
''func call_this_BSL_function
{
      dmsg "hi"
}''
|-
| <ActivateTurret TargetId="''Id''" />
| int16
|
|-
| <DeactivateTurret TargetId="''Id''" />
| int16
|
|-
| <ActivateConsole TargetId="''Id''" />
| int16
|
|-
| <DeactivateConsole TargetId="''Id''" />
| int16
|
|-
| <ActivateAlarm TargetId="''Id''" />
| int16
|
|-
| <DeactivateAlaram TargetId="''Id''" />
| int16
|
|-
| <ActivateTrigger TargetId="''Id''" />
| int16
|
|-
| <DeactivateTrigger TargetId="''Id''" />
| int16
|
|-
| <LockDoor TargetId="''Id''" />
| int16
|
|-
| <UnlockDoor TargetId="''Id''" />
| int16
|
|
[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/console.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/console_preview.png]
|}
|}
        '''<font color="#0A0"><Object Id="8179" Type="CONS"></font>'''
            <Header>
                <Flags>9</Flags>
                <Position>-1354.927 45 860.053</Position>
                <Rotation>180.000015 0 180.000015</Rotation>
            </Header>
            <OSD>
                <Class>console0</Class>
                <ConsoleId>2</ConsoleId>
                <Flags>Active</Flags>
                <DisabledTexture>_con_INACTIVE</DisabledTexture>
                <EnabledTexture>_con_MTCOM_DISH</EnabledTexture>
                <UsedTexture>_con_MTC_DISHFLASH</UsedTexture>
                <Events>
                    <Script Function="fconsole_ok" />
                </Events>
            </OSD>
        '''<font color="#0A0"></Object></font>'''


==Mod Tool-aided import==
'''Limitation:''' This method was created for info consoles only.


'''tags'''
VBS code:
* <Flags> : (9 and 8 are used in compound)
[[Image:ModTool_layers.png|thumb|200px|right|How to access scene layers.]]
* <Position> : (console is spawned at this xyz-position)
' make a new layer ("CONS_layer" or whatever)
* <Rotation> : (console is spawned with this xyz-rotation (in degrees))
' make it the current layer (by setting the >> sign)
* <Class>: console0 / console_alarm / console_data / [[Consoles|?]]
' in shared\consoles folder
* <ConsoleId> : (used by BSL commands like "console_deactivate ''ID''")
' extract console_data.oni as dae
* <Flags> :
' import only console_data_11.dae
:HEX=Dec/Flag
' duplicate, translate, rotate as you need
:00 = 0 (not active)
' right-click your CONS_layer > "Select All Objects in Layer"
:01 = 1 (unknown)
' run VBS code to create XML file (script editor: Alt+4, Run code: F5)
:02 = 2 (unknown)
' it will appear on your desktop
:04 = 4 (unknown)
' edit ConsoleId and Script Function
:08 = Active
' import by registering consoles in your level's XML master file
:<font color="#777">09 = 9 (*)</font>
' (<Objects><Import>BINACJBOConsole.xml)
:10 = 16 (unknown)
:20 = UsePunchAnimation (KONOKOconsole_punch.TRAM .. WTF O_o Seems to be a KONCOMcomb_p copy but slightly slower; I think it was used in a beta to crash the console via character-environment collision, shall we try to get it back?)
:28 = Active UsePunchAnimation
FolderName = CreateObject("WScript.Shell").SpecialFolders("Desktop")
:40 = AlarmConsole
FileName = "BINACJBOConsole"
:80 = 128 (unknown)
FilePath = FolderName & "\" & FileName & ".xml"
:<font color="#777">C0 = 192 (*)</font>
:<font color="#777">EE = 238 (*)</font>
: * not tested, might screw everything, was only set to test the XML export
Set oFS = CreateObject("Scripting.FileSystemObject")
:Multible flags:
Set objXMLFile = oFS.OpenTextFile(FilePath, 2, True, 0)
::known flag and unknown flag are extracted as decimal number added together (see 9)
' quote sign in a string needs two quote signs
::known flags are extracted as readable flags, separated by a space sign (see 28)
objXMLFile.WriteLine "<?xml version=""1.0"" encoding=""utf-8""?>"
objXMLFile.WriteLine "<Oni>"
objXMLFile.WriteLine "   <Objects>"
for each obj in selection
px = obj.posx.value
py = obj.posy.value
pz = obj.posz.value
rx = obj.rotx.value
ry = obj.roty.value
rz = obj.rotz.value
position = replace(px & " " & py & " " & pz, ",", ".")
rotation = replace(rx & " " & ry & " " & rz, ",", ".")
logmessage position
logmessage rotation
console = "consoles/console_data.oni"
objXMLFile.WriteLine "      <CONS>"
objXMLFile.WriteLine "          <Header>"
objXMLFile.WriteLine "              <Flags></Flags>"
objXMLFile.WriteLine "               <Position>" & position & "</Position>"
objXMLFile.WriteLine "              <Rotation>" & rotation & "</Rotation>"
objXMLFile.WriteLine "          </Header>"
objXMLFile.WriteLine "          <OSD>"
objXMLFile.WriteLine "              <Class>" & console & "</Class>"
objXMLFile.WriteLine "              <ConsoleId>1</ConsoleId>"
objXMLFile.WriteLine "              <Flags>InitialActive</Flags>"
objXMLFile.WriteLine "              <InactiveTexture>_CON_INFO</InactiveTexture>"
objXMLFile.WriteLine "              <ActiveTexture>_CON_INFO</ActiveTexture>"
objXMLFile.WriteLine "               <TriggeredTexture>_CON_INFO</TriggeredTexture>"
objXMLFile.WriteLine "              <Events>"
objXMLFile.WriteLine "                  <Script Function=""[[XML:TxtC|show_console_text]]"" />"
objXMLFile.WriteLine "              </Events>"
objXMLFile.WriteLine "           </OSD>"
objXMLFile.WriteLine "      </CONS>"
next
objXMLFile.WriteLine "  </Objects>"
objXMLFile.WriteLine "</Oni>"
objXMLFile.Close
logmessage "done"


* <DisabledTexture> : _con_ALARM_SLEEP / _con_USED / _con_used / _con_INACTIVE / <font color="#777">(etc.)</font>
{{XML}}
* <EnabledTexture> : _con_ALARM_SLEEP / _con_INFO / _con_MTC_2 / _con_mtc_stairs / _con_MTCOM_DISH / _con_MTCOM_DISH / <font color="#777">(etc.)</font>
* <UsedTexture> : _con_ALARM_ON / _con_USED / _con_used / _con_MTC_DISHFLASH / <font color="#777">(etc.)</font> (custom textures should be possible)
* <Events>
: <Script Function="calling_this_BSL_function" />
: <ActivateTurret TargetId="''Id''" />
: <DeactivateTurret TargetId="''Id''" />
: <ActivateConsole TargetId="''Id''" />
: <DeactivateConsole TargetId="''Id''" />
: <ActivateAlarm TargetId="''Id''" />
: <DeactivateAlaram TargetId="''Id''" />
: <ActivateTrigger TargetId="''Id''" />
: <DeactivateTrigger TargetId="''Id''" />
: <LockDoor TargetId="''Id''" />
: <UnlockDoor TargetId="''Id''" />
: (multible events are possible)
Paradox-01
8,141

edits

Retrieved from "https://wiki.oni2.net/Special:MobileDiff/14169...42729"