Skip to content

Commit

Permalink
Merge branch '2.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
macmillan333 committed Nov 21, 2023
2 parents 5dc3593 + a750973 commit 1ea1a19
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 1 deletion.
2 changes: 2 additions & 0 deletions English/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@

[Scripting reference](Theme/Scripting_reference.md)

[API update history](Theme/API_update_history.md)

# TECHMANIA Converter Documentation

[.bms support](Converter/bms_support.md)
Expand Down
13 changes: 13 additions & 0 deletions English/Theme/API_update_history.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# API version 2

TECHMANIA version: 2.1
Unity version: ???

* Deprecated `Paths.EscapeBackslash`, which now does nothing. Added `Paths.ForceEscapeBackslash` in case escaping is still necessary. `EscapeBackslash` was added in an age when visual elements parsed escape sequences by default; that is no longer the case.

# API version 1

TECHMANIA version: 2.0
Unity version: 2022.3.2f1

Initial version.
10 changes: 9 additions & 1 deletion English/Theme/Scripting_reference.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# TECHMANIA Theme API scripting reference

Applies to API version: 1
Applies to API version: 2

When reading on Github, you can click the menu button to the top right to reveal a table of contents.

Expand Down Expand Up @@ -1020,8 +1020,16 @@ Converts `absolutePath` to a relative path in reference to `reference`.
string EscapeBackslash(string path)
```

Deprecated. This method returns `path` unmodified. If you are sure you need to escape backslashes, call `ForceEscapeBackslash`.

```
string ForceEscapeBackslash(string path)
```

Replaces `\` with `\\`, so that paths on Windows do not form escape sequences when displayed on a visual element.

Please note that visual elements by default do not parse escape sequences. In that case, calling this before displaying a string would result in double backslashes.

```
string GoUpFrom(string path)
```
Expand Down

0 comments on commit 1ea1a19

Please sign in to comment.