isledecomp/isle
1
0
Fork 0
mirror of https://github.com/isledecomp/isle.git synced 2026-01-17 05:21:15 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Florian Kaiser 2025-04-29 14:22:56 +02:00
parent 799b43594a
commit 51dec022cc
1 changed files with 27 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
DOCUMENTATION.md
View File

@ -4,6 +4,12 @@
- **Script**: SI File (it appears they wanted to use SI much more as actual scripts, but ended up hard-coding almost everything) - **Script**: SI File (it appears they wanted to use SI much more as actual scripts, but ended up hard-coding almost everything)
- **Action**: Mostly media file inside SI - **Action**: Mostly media file inside SI
## Core Concepts
### Tickling
MxCore objects can be registered to be tickled by the MxTickleManager. This is used to update them in a set interval. This is used for loading the next frame of a video, update 3D sound positions and more.
## Classes ## Classes
### MxAtom ### MxAtom
@ -15,7 +21,7 @@ Dec()
### MxAtomId ### MxAtomId
String with lookup method (upper case/lower case/exact). Used for IDs. String with lookup method (upper case/lower case/exact). Used for IDs.
MxOmni holds an AtomSet that contains MxAtoms for every MxAtom ID created + a counter of how many instances exists. MxOmni holds an AtomSet that contains MxAtoms for every MxAtomId created + a counter of how many instances exists (purpose unclear).
### MxString ### MxString
Typical string class with utility functions. Typical string class with utility functions.
@ -24,13 +30,19 @@ Typical string class with utility functions.
Virtual base class. Virtual base class.
Tickle() Tickle()
Notifiy(MyParam) Notify(MyParam)
GetId() GetId()
ClassName() ClassName()
IsA() IsA()
Checks ALL parents. Checks ALL parents.
### MxTickleManager : MxCore
Holds a list of MxTickleClient*. Goes though the on Tickle() and calls Tickle() if interval time has passed.
### MxTickleClient
Holds a MxCore*, Interval, LastUpdateTime and Flags (only used for TICKLE_MANAGER_FLAG_DESTROY?).
### MxDSObject : MxCore ### MxDSObject : MxCore
Base Object for extracted objects from SI files. Base Object for extracted objects from SI files.
@ -139,7 +151,7 @@ PlaceActor(LegoNamedPlane&)
Parses a string like ""ATTACH_CAMERA: location direction up", "SPEED speed", "SOUND sound" , "MUTE" and "VISIBILITY". Saves it into the corresponding member. Parses a string like ""ATTACH_CAMERA: location direction up", "SPEED speed", "SOUND sound" , "MUTE" and "VISIBILITY". Saves it into the corresponding member.
### LegoPathController : MxCore ### LegoPathController : MxCore
Has PathBoundary (LegoPathBoundary*) Has PathBoundary (LegoPathBoundary*) a set of actors and many other things. Presumably it controls the movement of actors along paths.
#### PlaceActor(LegoPathActor*) #### PlaceActor(LegoPathActor*)
Removes actor from current controller, and set it to this. Removes actor from current controller, and set it to this.
@ -147,6 +159,10 @@ Removes actor from current controller, and set it to this.
#### PlaceActor(LegoPathActor*, LegoAnimPresenter*, ...) #### PlaceActor(LegoPathActor*, LegoAnimPresenter*, ...)
Removes actor from current controller, does through all boundaries, goes through all presenters of them Removes actor from current controller, does through all boundaries, goes through all presenters of them
### LegoPathActor : LegoActor
### LegoEdge ### LegoEdge
Has FaceA (LegoWEEdge*), FaceB (LegoWEEdge*), PointA (Vector3), PointB (Vector3). Also utility functions like CWVertex (LegoWEEdge&), CCWVertex (LegoWEEdge&), GetClockwiseEdge(LegoWEEdge&) and GetCounterclockwiseEdge(LegoWEEdge&). Has FaceA (LegoWEEdge*), FaceB (LegoWEEdge*), PointA (Vector3), PointB (Vector3). Also utility functions like CWVertex (LegoWEEdge&), CCWVertex (LegoWEEdge&), GetClockwiseEdge(LegoWEEdge&) and GetCounterclockwiseEdge(LegoWEEdge&).
@ -165,7 +181,14 @@ Has actors and presenters.
### LegoNamedPlane ### LegoNamedPlane
Has Name (char*), Position, Direction and Up. Can be serialized. Has Name (char*), Position, Direction and Up. Can be serialized.
### LegoPathActor : LegoActor ### LegoStorage
Abstract base class for a file-file object with positioning, reading/writing basic data types etc.
### LegoMemory : LegoStorage
LegoStorage operating on a U8 pointer.
### LegoFile : LegoStorage
LegoStorage operating on a File.
### Mx3DPointFloat : Vector3 ### Mx3DPointFloat : Vector3
Just a Vector3, doesn't add much. Just a Vector3, doesn't add much.