Differences

This shows you the differences between two versions of the page.

--- misc_func [2022/03/22 21:39] – external edit 127.0.0.1
+++ misc_func [2025/02/25 22:20] (current) – external edit 127.0.0.1
@@ Line 67: / Line 67: @@
 |}
+===== File =====
+The file operations are limited, because I am paranoid of bad actors.
+The file to be written to MUST be in the RE directory tree, or if your running CUO it can be in the CUO directory tree. Further, the file suffix has to be one of {data, xml, map, csv}. The file suffixes list could be extended, but the main thing I didn't want someone to do damage to files needed for execution.
+{|style="font-size:85%; border:solid 2px; width: 50%;"
+|style="font-size:150%;  padding: 2px" colspan="2" | **Append a line to a file**
+|- style="background-color:#f0f0f0;"
+|**Syntax**
+|style="width: 90%" | Misc.AppendToFile(string FileName, string LineToAppend)
+|-
+|colspan="2" |**Description:**
+|-
+|colspan="2" |Appends a single line to a file.
+|- style="background-color:#f0f0f0;"
+|**Returns**
+|bool True - success False - Fail
+|-
+|**In Object:**
+|Misc
+|- style="background-color:#f0f0f0;"
+|**Parameters:**
+|string FileName, string LineToInsert
+|}
+{|style="font-size:85%; border:solid 2px; width: 50%;"
+|style="font-size:150%;  padding: 2px" colspan="2" | **Append a line to a file IF it doesn't already exist**
+|- style="background-color:#f0f0f0;"
+|**Syntax**
+|style="width: 90%" | Misc.AppendNotDupToFile(string FileName, string LineToAppend)
+|-
+|colspan="2" |**Description:**
+|-
+|colspan="2" | Appends a single line to a file if that line does not already exist in the file.
+use in your code like:
+<code>
+#
+result = Misc.AppendNotDupToFile("C:/CUO/Data/Client/TreasureMaps.csv", "1111, 2222, map,desc,I forget")
+#
+</code>
+|- style="background-color:#f0f0f0;"
+|**Returns**
+|bool
+|-
+|**In Object:**
+|Misc
+|- style="background-color:#f0f0f0;"
+|**Parameters:**
+|string FileName, string LineToInsert
+|}
+{|style="font-size:85%; border:solid 2px; width: 50%;"
+|style="font-size:150%;  padding: 2px" colspan="2" | **Remove a line from a file**
+|- style="background-color:#f0f0f0;"
+|**Syntax**
+|style="width: 90%" | Misc.DeleteFile(string FileName)
+|-
+|colspan="2" |**Description:**
+|-
+|colspan="2" |Deletes a file
+|- style="background-color:#f0f0f0;"
+|**Returns**
+|bool True - success False - Fail
+|-
+|**In Object:**
+|Misc
+|- style="background-color:#f0f0f0;"
+|**Parameters:**
+|string FileName
+|}
+{|style="font-size:85%; border:solid 2px; width: 50%;"
+|style="font-size:150%;  padding: 2px" colspan="2" | **Remove a line from a file**
+|- style="background-color:#f0f0f0;"
+|**Syntax**
+|style="width: 90%" | Misc.RemoveLineInFile(string FileName, string LineToAppend)
+|-
+|colspan="2" |**Description:**
+|-
+|colspan="2" |Removes a single line from a file if it exists
+|- style="background-color:#f0f0f0;"
+|**Returns**
+|bool True - success False - Fail
+|-
+|**In Object:**
+|Misc
+|- style="background-color:#f0f0f0;"
+|**Parameters:**
+|string FileName, string LineToInsert
+|}
 ===== System =====
@@ Line 739: / Line 838: @@
 |**Parameters:**
 |scriptfilename
+|}
+===== Maps =====
+{|style="font-size:85%; border:solid 2px; width: 50%;"
+|style="font-size:150%;  padding: 2px" colspan="2" | **Co-Ordinates of a Decoded Map**
+|- style="background-color:#f0f0f0;"
+|**Syntax**
+|style="width: 90%" | Misc.GetMapInfo(serial)
+|-
+|colspan="2" |**Description:**
+|-
+|colspan="2" | Retrieve the co-ordinates of a decoded t-map. Your code would look like:
+<code>
+#
+mapInfo = Misc.GetMapInfo(0x400BFD6C)
+print("Treasure at ({}, {}), Origin ({}, {}), pin at ({}, {})"
+    .format(mapInfo.MapOrigin.X+mapInfo.PinPosition.X, mapInfo.MapOrigin.Y+mapInfo.PinPosition.Y,
+            mapInfo.MapOrigin.X, mapInfo.MapOrigin.Y, mapInfo.PinPosition.X, mapInfo.PinPosition.Y))
+#
+</code>
+|- style="background-color:#f0f0f0;"
+|**Note:**
+|The pin position is an offset from the origin, so you have to add them to get absolute location
+|- style="background-color:#f0f0f0;"
+|**Returns**
+|MapInfo{ PinPosition, MapOrigin, MapEnd }
+|-
+|**In Object:**
+|Misc
+|- style="background-color:#f0f0f0;"
+|**Parameters:**
+|serial - Serial of the t-map
 |}
@@ Line 984: / Line 1118: @@
 |}
+{|style="font-size:85%; border:solid 2px; width: 50%;"
+|style="font-size:150%;  padding: 2px" colspan="2" | **Distance between 2 places using UO algorithm**
+|- style="background-color:#f0f0f0;"
+|**Syntax**
+|style="width: 90%" | Misc.Distance(X1, Y1, X2, Y2)
+|-
+|colspan="2" |**Description:**
+|-
+|colspan="2" | Compute the distance between 2 places using UO algorithm for distance
+use in your code like:
+<code>
+#
+d = Misc.Distance(10, 10, 20, 20)
+#
+</code>
+|- style="background-color:#f0f0f0;"
+|**Returns**
+|int
+|-
+|**In Object:**
+|Misc
+|- style="background-color:#f0f0f0;"
+|**Parameters:**
+|X1 - x origin
+|Y1 - y origin
+|X2 - x dest
+|Y2 - y dest
+|}