adofaipy 3.2.0

A library that makes automating events in ADOFAI levels more convenient.

This is a library that makes automating events in ADOFAI levels more convenient.
List of Classes:

---

LevelDict

Initalize with LevelDict(filename, encoding).
Creates a blank LevelDict if filename is left blank.
encoding defaults to utf-8-sig.

LevelDict.filename : str

The filename of the file from which the LevelDict was obtained.

LevelDict.encoding : str

The encoding of the file from which the LevelDict was obtained.

LevelDict.nonFloorDecos : list[Decoration]

A list of all decorations in the level that are not tied to any particular tile.

LevelDict.settings : Settings

The level settings, as a Settings object.

LevelDict.tiles : list[Tile]

A list of all tiles in the level. (See Tile class)

---

LevelDict.appendTile(angle : float) -> None:

Adds a single tile to the end of the level.

LevelDict.appendTiles(angles : list[float]) -> None:

Adds a list of tiles to the end of the level.

LevelDict.insertTile(angle : float, index : int) -> None:

Adds a single tile to the level before the specified index.

LevelDict.insertTiles(angles : list[float], index : int) -> None:

Adds a list of tiles to the level before the specified index.

LevelDict.getAngles() -> list[float]:

Returns a list of angles for each tile.

LevelDict.setAngles(angles: list[float]) -> None:

Writes a list of angles to angleData. The list is truncated if it's too big, and the track is truncated if the list is too small.

LevelDict.getAnglesRelative(ignoretwirls: bool=False) -> list[float]

Gets a list of relative angles (degrees between each pair of tiles.) Twirls are taken into account by default. To disable this, set ignoretwirls to True. Midspins are always taken into account.

LevelDict.setAnglesRelative(angles: list[float]) -> None

Sets a list of relative angles (degrees between each pair of tiles.)

LevelDict.addAction(event : Action) -> int:

Adds the given action to the level. Returns the index of the event within the tile.

LevelDict.addAction(event : Action) -> int:

Adds the given action to the level. Returns the index of the event within the tile.

LevelDict.addDecoration(event : Decoration) -> int:

Adds the given decoration to the level. Returns the index of the event within the tile / within the list of non-floor decorations.

LevelDict.getActions(condition : Callable) -> list[Action]:

Returns a list of actions in the level that meet the given condition. Returns a list of all actions if condition is not specified.

LevelDict.getDecorations(condition : Callable) -> list[Decoration]:

Returns a list of decorations in the level that meet the given condition. Returns a list of all decorations if condition is not specified.

LevelDict.removeActions(condition : Callable) -> list[Action]:

Removes all actions in the level that meet the given condition. Returns a list of removed actions.

LevelDict.removeDecorations(condition : Callable) -> list[Decoration]:

Removes all decorations in the level that meet the given condition. Returns a list of removed decorations.

LevelDict.popAction(tile, index) -> Action:

Removes the action at the specified tile at the specified index. Returns the event.

LevelDict.popDecoration(tile, index) -> Decoration:

Removes the decoration at the specified tile at the specified index. Returns the event.

LevelDict.replaceFieldAction(condition : Callable, field : str, new) -> None:

Changes the value of "field" to "new" in all actions that meet the given condition.

LevelDict.replaceFieldDecoration(condition : Callable, field : str, new) -> None:

Changes the value of "field" to "new" in all decorations that meet the given condition.

LevelDict.writeDictToFile(leveldict : dict, filename : str):

Writes the given dictionary to the specified file. Overwrites the original file if filename is not specified.
Use this if you are working with LevelDict.leveldict.

LevelDict.writeToFile(filename : str=None) -> None:

Writes the level to the specified file. Overwrites the original file if filename is not specified.

---

Settings
Part of a LevelDict object. A Settings object behaves like a dict. The keys of this dictionary are equivalent to the parameters in the settings field of a .adofai file.

---

Tile
A list of Tiles is contained within a LevelDict object.

Tile.angle : float

The angle that the tile points towards (0 degrees is facing right, 90 degrees is facing upwards)

Tile.actions : list[Action]

A list of actions which are present on that particular tile.

Tile.decorations : list[Decoration]

A list of decorations which are present on that particular tile.

---

Action
An event that goes on a tile (one with a purple icon). An Action object behaves like a dict. The keys depend on the event type. Check any entry in the actions field of a .adofai file for more information on the fields used by that event type.

Action objects are found in a list of actions in a Tile object.

---

Decoration
A decoration, object decoration, or text decoration (anything found in the decorations menu on the left sidebar). A Decoration object behaves like a dict. The keys depend on the event type. Check any entry in the decorations field of a .adofai file for more information on the fields used by that event type.

Decoration objects are found in a list of decorations in a Tile object. If the decoration is not tied to any tile, it is found in the list of non-floor decos.

---

이 라이브러리는 ADOFAI 커스텀 레벨 제작 중 코딩을 통한 이벤트 자동생성을 편리하게 하기 위해 존재합니다.
클래스 소개:

---

LevelDict

LevelDict(filename, encoding)을 통해 객체를 초기화합니다.
filename(파일 이름, .adofai 형식의 JSON 파일)을 입력하지 않을 경우 비어있는 LevelDict를 생성합니다.
encoding(인코딩)의 기본값은 utf-8-sig입니다.

LevelDict.filename : str

LevelDict로부터 가져온 filename입니다.

LevelDict.encoding : str

LevelDict로부터 가져온 encoding입니다.

LevelDict.nonFloorDecos : list[Decoration]

어떤 타일에도 속하지 않는 모든 장식의 리스트입니다.

LevelDict.settings : Settings

레벨 설정을 Settings 오브젝트로서 나타냅니다.

LevelDict.tiles : list[Tile]

레벨의 모든 타일의 리스트입니다. (Tile 클래스를 확인하세요.)

---

LevelDict.appendTile(angle : float) -> None:

레벨의 끝에 타일을 하나 추가합니다.

LevelDict.appendTiles(angles : list[float]) -> None:

레벨의 끝에 리스트 형태의 타일들을 추가합니다.

LevelDict.insertTile(angle : float, index : int) -> None:

지정된 인덱스 직전에 타일을 하나 추가합니다.

LevelDict.insertTiles(angles : list[float], index : int) -> None:

지정된 인덱스 직전에 리스트 형태의 타일들을 추가합니다.

LevelDict.getAngles() -> list[float]:

각 타일의 각도를 리스트 형태로 반환합니다.

LevelDict.setAngles(angles: list[float]) -> None:

리스트 형태의 각도들을 angleData(ADOFAI 커스텀 레벨 파일에서, 타일을 저장하는 부분)에 적용합니다. LevelDict.tiles의 크기와 리스트의 크기가 다른 경우 두 값이 같아지도록 더 큰 쪽(타일 또는 각도의 리스트)의 뒷부분을 슬라이싱합니다.

LevelDict.getAnglesRelative(ignoretwirls: bool=False) -> list[float]

상대각도(근접한 두 타일 사이의 각도)의 리스트를 반환합니다. 기본적으로 소용돌이를 고려하고 계산됩니다. 소용돌이를 무시하기 위해선 ignoretwirls를 True로 세팅하세요. 미드스핀(오각형 타일)을 항상 고려하고 계산됩니다.

LevelDict.setAnglesRelative(angles: list[float]) -> None

리스트 형태의 상대각도들을 angleData에 적용합니다. LevelDict.setAngles와 동일한 적용방식을 가집니다.

LevelDict.addAction(event : Action) -> int:

주어진 Action(오브젝트)을 레벨에 추가합니다. 해당 이벤트가 있는 타일에서의 이벤트의 인덱스(.adofai 파일은 이벤트에 인덱스를 부여하지 않으며, 이 인덱스는 LevelDict에서 임의로 지정하는 인덱스입니다)를 반환합니다.

LevelDict.addDecoration(event : Decoration) -> int:

주어진 Decoration(오브젝트)을 레벨에 추가합니다. 해당 장식의 인덱스를 반환합니다.

LevelDict.getActions(condition : Callable) -> list[Action]:

조건에 맞는 모든 Action의 리스트를 반환합니다. 조건이 명시되지 않았을 경우 모든 Action의 리스트를 반환합니다.

LevelDict.getDecorations(condition : Callable) -> list[Decoration]:

조건에 맞는 모든 Decoration의 리스트를 반환합니다. 조건이 명시되지 않았을 경우 모든 장식의 리스트를 반환합니다.

LevelDict.removeActions(condition : Callable) -> list[Action]:

조건에 맞는 모든 Action을 삭제합니다. 삭제한 모든 Action의 리스트를 반환합니다.

LevelDict.removeDecorations(condition : Callable) -> list[Decoration]:

조건에 맞는 모든 Decoration을 삭제합니다. 삭제한 모든 장식의 리스트를 반환합니다.

LevelDict.popAction(tile, index) -> Action:

지정된 타일에 지정된 인덱스를 가진 Action을 삭제합니다. 삭제된 이벤트를 반환합니다.

LevelDict.popDecoration(tile, index) -> Decoration:

지정된 타일에 지정된 인덱스를 가진 Decoration을 삭제합니다. 삭제된 장식을 반환합니다.

LevelDict.replaceFieldAction(condition : Callable, field : str, new) -> None:

조건에 맞는 모든 Action의 "field"의 값을 "new"로 변환합니다.

LevelDict.replaceFieldDecoration(condition : Callable, field : str, new) -> None:

조건에 맞는 모든 Decoration의 "field"의 값을 "new"로 변환합니다.

LevelDict.writeDictToFile(leveldict : dict, filename : str):

ADOFAI 커스텀 레벨 파일에 대응되는 주어진 딕셔너리를 지정된 파일에 덮어씌웁니다. 파일명이 지정되지 않았을 경우 원래 파일을 덮어씌웁니다.
LevelDict.leveldict를 사용할 경우 해당 코드를 사용하세요.

LevelDict.writeToFile(filename : str=None) -> None:

LevelDict 오브젝트에 저장된 ADOFAI 커스텀 레벨 파일을 지정된 파일에 덮어씌웁니다. 파일명이 지정되지 않았을 경우 원래 파일을 덮어씌웁니다.

---

Settings
LevelDict 오브젝트의 일부분입니다. Settings 오브젝트는 dict와 같이 행동합니다. 이 딕셔너리의 키는 ADOFAI 커스텀 레벨 파일의 settings(설정)의 키와 동일한 값을 가집니다.

---

Tile
각 Tile을 담은 리스트가 LevelDict 오브젝트 안에 포함되어 있습니다.

Tile.angle : float

특정 타일이 보고 있는 방향입니다. (0도가 3시 방향, 90도가 12시 방향)

Tile.actions : list[Action]

특정 타일에 있는 모든 Action을 담은 리스트입니다.

Tile.decorations : list[Decoration]

특정 타일에 있는 모든 장식을 담은 리스트입니다.

---

Action
타일 위에 놓이는 이벤트가 해당됩니다(보라색 아이콘으로 확인 가능). Action 오브젝트는 dict와 같이 행동합니다. 이 딕셔너리의 키는 이벤트의 종류에 따라 달라집니다. ADOFAI 커스텀 레벨 파일을 열어 원하는 종류의 이벤트의 Actions을 찾아 각 키를 확인할 수 있습니다.

Action 오브젝트는 Tile 오브젝트 안에서 리스트의 형태로 나열되어 있습니다.

---

Decoration
왼쪽 사이드바의 장식 탭에서 확인할 수 있는 모든 오브젝트가 해당됩니다. Decoration 오브젝트는 dict와 같이 행동합니다. 이 딕셔너리의 키는 이벤트의 종류에 따라 달라집니다. ADOFAI 커스텀 레벨 파일을 열어 원하는 종류의 장식의 decorations을 찾아 각 키를 확인할 수 있습니다.

Decoration 오브젝트는 Tile 오브젝트 안에 리스트의 형태로 나열되어 있습니다. 만약 장식이 어떠한 타일에도 대응되지 않을 경우, LevelDict.nonFloorDecos 안에 리스트의 형태로 나열되어 있습니다.

---

Changelog

3.2.0 (2024/09/07)

---

• Major update and bugfixes
• Settings class now inherits from and behaves like dict in order to keep it future-proof
• Added default arguments for getActions() and getDecorations()
• Fixed bug in pathData reading
• Removed stray print() statement
• Blank LevelDict is now generated if no filename is given
• Fixed appendTile() and appendTiles() moving events between tiles
• Added KR translation to documentation (by Purple0702)

3.1.0 (2024/05/20)

---

• Major update and bugfixes
• Added getAngles() and setAngles()
• Added getAnglesRelative() and setAnglesRelative(), with options to take twirls/midspins into account
• tiles list is now type-check friendly
• Updated Settings class
• Added support for levels that use pathData
• Fixed writeToFile() no longer working (again)
• Fixed typos in _getFileString() and _getFileDict()
• Cleaned up some errors in README.md
• Version number is no longer out of sync

3.0.3 (2024/03/18)

---

• Minor bugfixes
• Fixed writeToFile() no longer working
• Replaced json.dumps() with faster json.dump() in writeToFile()
• Known issue: version number is out of sync

3.0.1 (2023/12/02)

---

• Minor bugfix
• Fixed markdown bug on README and CHANGELOG
• Removed unnessecary files

3.0.0 (2023/12/01)

---

• Major update
• Completely overhauled file structure to use a class-based system
• Too much to list! Read the docs for more info

2.0.3 (2023/09/23)

---

• Minor bugfixes
• Fixed addEvent() not detecting addObject and addText events
• Fixed removeEvents() not modifying leveldict
• Fixed typo in replaceField()
• Added logo to README

2.0.2 (2023/09/03)

---

• Minor bugfix
• Fixed markdown bug on README and CHANGELOG for real this time

2.0.1 (2023/09/03)

---

• Minor bugfix
• Fixed markdown bug on README and CHANGELOG (hopefully)

2.0.0 (2023/09/03)

---

• Major update
• Completely overhauled file reading to use dictionaries instead of strings
• Added getFileDict()
• Added 3 new utility functions: searchEvents(), removeEvents() and replaceField()
• getAngles(), setAngles() and all event functions are now deprecated
• Updated documentation
• README and CHANGELOG now uses markdown

0.1.1 (2023/07/17)

---

• Minor bugfixes
• Fixed encoding incompatibility
• Fixed output string for moveDecorations()

0.1.0 (2023/06/15)

---

• Minor update
• Added dynamic pivot offset, parallax offset, masking and blending fields to addDecoration() and moveDecorations()
• Added angleOffset to setSpeed()

0.0.3 (2023/06/14)

---

• Minor bugfix: fixed filename __init__.py

0.0.2 (2023/06/13)

---

• Minor bugfix: 're' is no longer a dependency

0.0.1 (2023/05/28)

---

• First Release