Skip to content

Commit

Permalink
AutoDoc Testing
Browse files Browse the repository at this point in the history
Changing path

mk Im moving docs outside unity since the meta files are killing me

html tables

mds

garbage

ital

Removed table width styling as it was not being applied

massivecommit

nothingsketchy

br

newline stuff and trying styling on table

Modify

"README.md"

Updated docs, and files should go in the correct folder now

Update updateSummary.py

no cmd bs

Updated logging

Update autodoc.yml

Update autodoc.yml

path

these .meta files are killing me

Repopulated docs

clean slate

removed tolower

tolower

sync

Clearing

e

Update GenerateCLDocs.cs

test

Update autodoc.yml

Update autodoc.yml

Update autodoc.yml

Update autodoc.yml

Update autodoc.yml

Update autodoc.yml

Update autodoc.yml

Update autodoc.yml

Update autodoc.yml

Update autodoc.yml

Update autodoc.yml
  • Loading branch information
AutumnThyme committed Feb 9, 2025
1 parent 3d07b99 commit 3e9ff09
Show file tree
Hide file tree
Showing 88 changed files with 791 additions and 1,405 deletions.
58 changes: 44 additions & 14 deletions .github/workflows/autodoc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,47 +3,77 @@ name: Sync Files to Another Repo
on:
push:
branches:
- Thyme-TestBranch # Source branch
- Thyme-DocTestBranch

jobs:
sync:
runs-on: ubuntu-latest

steps:
- name: Checkout source repository
uses: actions/checkout@v2
with:
repository: AoTTG-2/Aottg2-Unity
ref: Thyme-TestBranch
uses: actions/checkout@v4

- name: Filter and copy .md files
run: |
mkdir -p temp-dir/objects temp-dir/static
find Assets/Docs/object -name '*.md' -exec cp {} temp-dir/objects/ \;
find Assets/Docs/objects -name '*.md' -exec cp {} temp-dir/objects/ \;
find Assets/Docs/static -name '*.md' -exec cp {} temp-dir/static/ \;
echo "Copied .md files to temp-dir/objects:"
ls temp-dir/objects
echo "Copied .md files to temp-dir/static:"
ls temp-dir/static
- name: Checkout target repository
uses: actions/checkout@v2
uses: actions/checkout@v4
with:
repository: AoTTG-2/CustomLogicDocumentation
token: ${{ secrets.GITHUB_TOKEN }}
token: ${{ secrets.CLDOC }}
ref: integration
path: target-repo

- name: Delete existing files in target folders
run: |
rm -rf reference/objects/*
rm -rf reference/static/*
rm -rf target-repo/reference/objects/*
rm -rf target-repo/reference/static/*
- name: Ensure target directories exist
run: |
mkdir -p target-repo/reference/objects
mkdir -p target-repo/reference/static
- name: Check target directories
run: |
echo "Contents of target-repo/reference/objects before copy:"
ls target-repo/reference/objects
echo "Contents of target-repo/reference/static before copy:"
ls target-repo/reference/static
- name: Copy files to target repository
run: |
cp -R temp-dir/objects/* reference/objects/
cp -R temp-dir/static/* reference/static/
cp -R temp-dir/objects/* target-repo/reference/objects/
cp -R temp-dir/static/* target-repo/reference/static/
- name: Check target directories after copy
run: |
echo "Contents of target-repo/reference/objects after copy:"
ls target-repo/reference/objects
echo "Contents of target-repo/reference/static after copy:"
ls target-repo/reference/static
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.x'

- name: Update summary.md
run: |
python .github/workflows/updateSummary.py target-repo/SUMMARY.md target-repo/reference/objects/ target-repo/reference/static/
- name: Commit and push changes
run: |
cd reference
cd target-repo
git config --global user.name 'github-actions[bot]'
git config --global user.email 'github-actions[bot]@users.noreply.github.com'
git add .
git commit -m "Sync .md files from source repo"
git push origin integration
git push origin integration
193 changes: 193 additions & 0 deletions .github/workflows/sugggest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,193 @@
# Character API Reference

The **Character** type represents an in-game entity with properties and methods that control its behavior, appearance, and interactions in a Unity environment.

---

## Properties

**Name**
*Type:* `String`
*Description:* The character’s name.

**Guild**
*Type:* `String`
*Description:* The character’s guild.

**Player**
*Type:* `Player`
*Description:* The player who owns this character.

**IsAI**
*Type:* `bool`
*Description:* Indicates whether the character is controlled by AI.

**ViewID**
*Type:* `int`
*Description:* The network view ID of the character.

**IsMine**
*Type:* `bool`
*Description:* Indicates if the character is controlled by the local player.

**IsMainCharacter**
*Type:* `bool`
*Description:* *(No description provided.)*

**Transform**
*Type:* `Transform`
*Description:* The Unity transform of the character.

**Position**
*Type:* `Vector3`
*Description:* The position of the character in the game world.

**Rotation**
*Type:* `Vector3`
*Description:* The rotation of the character expressed in Euler angles.

**QuaternionRotation**
*Type:* `Quaternion`
*Description:* The rotation of the character expressed as a quaternion.

**Velocity**
*Type:* `Vector3`
*Description:* The current velocity of the character.

**Forward**
*Type:* `Vector3`
*Description:* The forward direction vector of the character.

**Right**
*Type:* `Vector3`
*Description:* The right direction vector of the character.

**Up**
*Type:* `Vector3`
*Description:* The upward direction vector of the character.

**HasTargetDirection**
*Type:* `bool`
*Description:* Indicates whether the character is turning towards a target direction.

**TargetDirection**
*Type:* `Vector3`
*Description:* The target direction the character is aiming for.

**Team**
*Type:* `String`
*Description:* The team to which the character belongs.

**Health**
*Type:* `float`
*Description:* The current health of the character.

**MaxHealth**
*Type:* `float`
*Description:* The maximum health of the character.

**CustomDamageEnabled**
*Type:* `bool`
*Description:* Determines if custom damage dealing is enabled.

**CustomDamage**
*Type:* `int`
*Description:* The amount of custom damage to deal per attack.

**CurrentAnimation**
*Type:* `String`
*Description:* The currently playing animation of the character.

**Grounded**
*Type:* `bool`
*Description:* Indicates whether the character is grounded.

---

## Methods

### GetKilled(killer: String)
- **Returns:** `none`
- **Description:** Instantly kills the character.
- **Notes:** This method is callable by non-owners.

---

### GetDamaged(killer: String, damage: int)
- **Returns:** `none`
- **Description:** Applies damage to the character and kills it if the health drops to 0.
- **Notes:** This method is callable by non-owners.

---

### Emote(emote: String)
- **Returns:** `none`
- **Description:** Causes the character to perform an emote.
- **Notes:** The available emotes correspond to those shown in the in-game emote menu.

---

### PlayAnimation(animation: String, fade: float = 0.1)
- **Returns:** `none`
- **Description:** Plays the specified animation on the character.
- **Parameters:**
- `animation`: The name of the animation to play.
- `fade`: *(Optional)* The duration for crossfading to the new animation (default is 0.1 seconds).
- **Notes:** Available animations include: *Human, Titan, Annie, Eren* (use the appropriate string identifier).

---

### GetAnimationLength(animation: String)
- **Returns:** `float`
- **Description:** Retrieves the duration of the specified animation.

---

### PlaySound(sound: String)
- **Returns:** `none`
- **Description:** Plays a sound associated with the character.
- **Notes:** Available sound names are: *Humans, Shifters, Titans*. (Shifters also include all titan sounds.)

---

### StopSound(sound: String)
- **Returns:** `none`
- **Description:** Stops the sound currently being played on the character.

---

### LookAt(position: Vector3)
- **Returns:** `none`
- **Description:** Rotates the character to face a specified world position.

---

### AddForce(force: Vector3, mode: String = "Acceleration")
- **Returns:** `none`
- **Description:** Applies a force to the character using the provided vector.
- **Parameters:**
- `force`: The force vector to apply.
- `mode`: *(Optional)* The mode in which to apply the force.
- **Notes:** Valid force modes include: *Force, Acceleration, Impulse, VelocityChange* (default is *Acceleration*).

---

### Reveal(delay: float)
- **Returns:** `none`
- **Description:** Reveals the titan for the specified number of seconds.

---

### AddOutline(color: Color, mode: String = "OutlineAll")
- **Returns:** `none`
- **Description:** Adds an outline effect to the character.
- **Parameters:**
- `color`: The color of the outline.
- `mode`: *(Optional)* The outline mode to apply.
- **Notes:** Valid modes include: *OutlineAll, OutlineVisible, OutlineHidden, OutlineAndSilhouette, SilhouetteOnly, OutlineAndLightenColor*.

---

### RemoveOutline()
- **Returns:** `none`
- **Description:** Removes any outline effect from the character.
Loading

0 comments on commit 3e9ff09

Please sign in to comment.