Truxton Top Level Object - Revision history

Sam at 22:07, 12 January 2023

2023-01-12T22:07:20Z

Sam at 07:22, 16 September 2022

2022-09-16T07:22:31Z

Sam at 09:13, 14 September 2022

2022-09-14T09:13:33Z

Sam at 08:58, 14 September 2022

2022-09-14T08:58:19Z

Sam at 09:44, 29 July 2022

2022-07-29T09:44:40Z

Sam: /* Methods */

2020-06-28T08:57:25Z

Methods

Sam: Created page with "This is the object that is created when you `import truxton` =Methods= ==`create()`== It will return a Truxton Object which is basic..."

2020-06-12T17:18:03Z

Created page with "This is the object that is created when you <code>import truxton</code> =Methods= ==<code>create()</code>== It will return a Truxton Object which is basic..."

New page

This is the object that is created when you <code>import truxton</code>

=Methods=
==<code>create()</code>==
It will return a [[TruxtonObject | Truxton Object]] which is basically a connection to Truxton.

==<code>etl()</code>==
This creates an [[TruxtonETL | ETL]] object to participate in exploitation.

=Attributes=
There are hundreds of attributes to the object.

==<code>version</code>==
A string containing the version of Truxton this supports.

==Defined Constants==
The same constants used for [[File Types Supported | file types]] and [[Developer's Guide#Data Types | other purposes]] are present in the Truxton top level object.

@@ Line 15: / Line 15: @@
 ==<code>create() -> [[TruxtonObject]]</code>==
 It will return a [[TruxtonObject|Truxton Object]] which is basically a connection to Truxton.
 ==<code>dumpblackbox(process_id: int) -> None</code>==
@@ Line 23: / Line 26: @@
 ==<code>etl() -> [[TruxtonETL]]</code>==
 This creates an [[TruxtonETL|ETL]] object to participate in exploitation.
 ==<code>options() -> [[TruxtonOptions]]</code>==

@@ Line 26: / Line 26: @@
 ==<code>options() -> [[TruxtonOptions]]</code>==
 This creates an [[TruxtonOptions|Options]] object to retrieve configuration variables.
 =Attributes=

@@ Line 3: / Line 3: @@
 =Methods=
 ==<code>blackboxlocation(source_code_file_id: int, source_code_line_number: int) -> None</code>==
-Sets a debugging location in the black box.
+Sets a debugging location in the [[Black Box|black box]].
 You must create a value to represent the name of your source code file.
 When parsing the <code>DebugDump.xml</code>, you can translate that value back to the filename.
 ==<code>blackboxvalue(slot: int, value: int, source_code_file_id: int, source_code_line_number: int) -> None</code>==
-Sets a debugging value in the black box.
+Sets a debugging value in the [[Black Box|black box]].
 You have 20 debugging slots to store values.
 <code>slot</code> can have a value between 0 and 19.
@@ Line 17: / Line 17: @@
 ==<code>dumpblackbox(process_id: int) -> None</code>==
-Dumps the black box of the given process.
+Dumps the [[Black Box|black box]] of the given process.
 If the process has a black box, it will be written as XML to a file in the log file folder.
 The name of the file will be a timestamp followed by the process id then 'DebugDump.xml' example: 20221231_145509_Process_1234_DebugDump.xml

@@ Line 2: / Line 2: @@
 =Methods=
 ==<code>create() -> [[TruxtonObject]]</code>==
 It will return a [[TruxtonObject|Truxton Object]] which is basically a connection to Truxton.
 ==<code>etl() -> [[TruxtonETL]]</code>==

@@ Line 2: / Line 2: @@
 =Methods=
-==<code>create()</code>==
+==<code>create() -> [[TruxtonObject]]</code>==
-It will return a [[TruxtonObject | Truxton Object]] which is basically a connection to Truxton.
+It will return a [[TruxtonObject|Truxton Object]] which is basically a connection to Truxton.
-==<code>etl()</code>==
+==<code>etl() -> [[TruxtonETL]]</code>==
-This creates an [[TruxtonETL | ETL]] object to participate in exploitation.
+This creates an [[TruxtonETL|ETL]] object to participate in exploitation.
-==<code>options()</code>==
+==<code>options() -> [[TruxtonOptions]]</code>==
-This creates an [[TruxtonOptions | Options]] object to retrieve configuration variables.
+This creates an [[TruxtonOptions|Options]] object to retrieve configuration variables.
 =Attributes=
 There are hundreds of attributes to the object.
-==<code>version</code>==
+==<code>version: str</code>==
 A string containing the version of Truxton this supports.
 ==Defined Constants==
-The same constants used for [[File Types Supported | file types]] and [[Developer's Guide#Data Types | other purposes]] are present in the Truxton top level object.
+The same constants used for [[File Types Supported|file types]] and [[Developer's Guide#Data Types|other purposes]] are present in the Truxton top level object.