From 458364c785226ff2b6500ff44537422b4ac2e081 Mon Sep 17 00:00:00 2001 From: AutumnThyme <79295722+AutumnThyme@users.noreply.github.com> Date: Tue, 4 Feb 2025 01:46:14 -0500 Subject: [PATCH] Update autodoc.yml 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 --- .github/workflows/autodoc.yml | 58 ++++-- .github/workflows/sugggest.md | 193 ++++++++++++++++++ .github/workflows/test.md | 117 +++++++++++ .github/workflows/testing.py | 184 +++++++++++++++++ .github/workflows/updateSummary.py | 127 ++++++++++++ Assets/Docs.meta | 8 - Assets/Docs/Object.meta | 8 - Assets/Docs/Object/Character.md | 44 ---- Assets/Docs/Object/Character.md.meta | 7 - Assets/Docs/Object/Collider.md | 23 --- Assets/Docs/Object/Collider.md.meta | 7 - Assets/Docs/Object/Collision.md | 13 -- Assets/Docs/Object/Collision.md.meta | 7 - Assets/Docs/Object/Dict.md | 20 -- Assets/Docs/Object/Dict.md.meta | 7 - Assets/Docs/Object/Human.md | 85 -------- Assets/Docs/Object/Human.md.meta | 7 - Assets/Docs/Object/LineCastHitResult.md | 11 - Assets/Docs/Object/LineCastHitResult.md.meta | 7 - Assets/Docs/Object/List.md | 29 --- Assets/Docs/Object/List.md.meta | 7 - Assets/Docs/Object/MapObject.md | 56 ----- Assets/Docs/Object/MapObject.md.meta | 7 - Assets/Docs/Object/MapTargetable.md | 8 - Assets/Docs/Object/MapTargetable.md.meta | 7 - Assets/Docs/Object/NetworkView.md | 15 -- Assets/Docs/Object/NetworkView.md.meta | 7 - Assets/Docs/Object/Player.md | 27 --- Assets/Docs/Object/Player.md.meta | 7 - Assets/Docs/Object/Range.md | 27 --- Assets/Docs/Object/Range.md.meta | 7 - Assets/Docs/Object/Set.md | 28 --- Assets/Docs/Object/Set.md.meta | 7 - Assets/Docs/Object/Shifter.md | 70 ------- Assets/Docs/Object/Shifter.md.meta | 7 - Assets/Docs/Object/Titan.md | 75 ------- Assets/Docs/Object/Titan.md.meta | 7 - Assets/Docs/Object/Transform.md | 36 ---- Assets/Docs/Object/Transform.md.meta | 7 - Assets/Docs/Static.meta | 8 - Assets/Docs/Static/Camera.md | 27 --- Assets/Docs/Static/Camera.md.meta | 7 - Assets/Docs/Static/Color.md | 15 -- Assets/Docs/Static/Color.md.meta | 7 - Assets/Docs/Static/Convert.md | 20 -- Assets/Docs/Static/Convert.md.meta | 7 - Assets/Docs/Static/Cutscene.md | 9 - Assets/Docs/Static/Cutscene.md.meta | 7 - Assets/Docs/Static/Game.md | 56 ----- Assets/Docs/Static/Game.md.meta | 7 - Assets/Docs/Static/Input.md | 16 -- Assets/Docs/Static/Input.md.meta | 7 - Assets/Docs/Static/Json.md | 7 - Assets/Docs/Static/Json.md.meta | 7 - Assets/Docs/Static/LineRenderer.md | 29 --- Assets/Docs/Static/LineRenderer.md.meta | 7 - Assets/Docs/Static/Map.md | 19 -- Assets/Docs/Static/Map.md.meta | 7 - Assets/Docs/Static/Math.md | 52 ----- Assets/Docs/Static/Math.md.meta | 7 - Assets/Docs/Static/Network.md | 19 -- Assets/Docs/Static/Network.md.meta | 7 - Assets/Docs/Static/PersistentData.md | 12 -- Assets/Docs/Static/PersistentData.md.meta | 7 - Assets/Docs/Static/Physics.md | 7 - Assets/Docs/Static/Physics.md.meta | 7 - Assets/Docs/Static/Quaternion.md | 33 --- Assets/Docs/Static/Quaternion.md.meta | 7 - Assets/Docs/Static/Random.md | 12 -- Assets/Docs/Static/Random.md.meta | 7 - Assets/Docs/Static/RoomData.md | 8 - Assets/Docs/Static/RoomData.md.meta | 7 - Assets/Docs/Static/String.md | 26 --- Assets/Docs/Static/String.md.meta | 7 - Assets/Docs/Static/Time.md | 9 - Assets/Docs/Static/Time.md.meta | 7 - Assets/Docs/Static/UI.md | 41 ---- Assets/Docs/Static/UI.md.meta | 7 - Assets/Docs/Static/Vector2.md | 45 ---- Assets/Docs/Static/Vector2.md.meta | 7 - Assets/Docs/Static/Vector3.md | 59 ------ Assets/Docs/Static/Vector3.md.meta | 7 - .../Attributes/CLCallbackAttribute.cs | 16 ++ .../Attributes/CLCallbackAttribute.cs.meta | 11 + .../Builtin/CustomLogicUIBuiltin.cs | 4 +- .../Component/CustomLogicComponentInstance.cs | 5 + .../CustomLogic/CustomLogicEvaluator.cs | 14 ++ Assets/Scripts/Editor/GenerateCLDocs.cs | 96 +++++++-- 88 files changed, 791 insertions(+), 1405 deletions(-) create mode 100644 .github/workflows/sugggest.md create mode 100644 .github/workflows/test.md create mode 100644 .github/workflows/testing.py create mode 100644 .github/workflows/updateSummary.py delete mode 100644 Assets/Docs.meta delete mode 100644 Assets/Docs/Object.meta delete mode 100644 Assets/Docs/Object/Character.md delete mode 100644 Assets/Docs/Object/Character.md.meta delete mode 100644 Assets/Docs/Object/Collider.md delete mode 100644 Assets/Docs/Object/Collider.md.meta delete mode 100644 Assets/Docs/Object/Collision.md delete mode 100644 Assets/Docs/Object/Collision.md.meta delete mode 100644 Assets/Docs/Object/Dict.md delete mode 100644 Assets/Docs/Object/Dict.md.meta delete mode 100644 Assets/Docs/Object/Human.md delete mode 100644 Assets/Docs/Object/Human.md.meta delete mode 100644 Assets/Docs/Object/LineCastHitResult.md delete mode 100644 Assets/Docs/Object/LineCastHitResult.md.meta delete mode 100644 Assets/Docs/Object/List.md delete mode 100644 Assets/Docs/Object/List.md.meta delete mode 100644 Assets/Docs/Object/MapObject.md delete mode 100644 Assets/Docs/Object/MapObject.md.meta delete mode 100644 Assets/Docs/Object/MapTargetable.md delete mode 100644 Assets/Docs/Object/MapTargetable.md.meta delete mode 100644 Assets/Docs/Object/NetworkView.md delete mode 100644 Assets/Docs/Object/NetworkView.md.meta delete mode 100644 Assets/Docs/Object/Player.md delete mode 100644 Assets/Docs/Object/Player.md.meta delete mode 100644 Assets/Docs/Object/Range.md delete mode 100644 Assets/Docs/Object/Range.md.meta delete mode 100644 Assets/Docs/Object/Set.md delete mode 100644 Assets/Docs/Object/Set.md.meta delete mode 100644 Assets/Docs/Object/Shifter.md delete mode 100644 Assets/Docs/Object/Shifter.md.meta delete mode 100644 Assets/Docs/Object/Titan.md delete mode 100644 Assets/Docs/Object/Titan.md.meta delete mode 100644 Assets/Docs/Object/Transform.md delete mode 100644 Assets/Docs/Object/Transform.md.meta delete mode 100644 Assets/Docs/Static.meta delete mode 100644 Assets/Docs/Static/Camera.md delete mode 100644 Assets/Docs/Static/Camera.md.meta delete mode 100644 Assets/Docs/Static/Color.md delete mode 100644 Assets/Docs/Static/Color.md.meta delete mode 100644 Assets/Docs/Static/Convert.md delete mode 100644 Assets/Docs/Static/Convert.md.meta delete mode 100644 Assets/Docs/Static/Cutscene.md delete mode 100644 Assets/Docs/Static/Cutscene.md.meta delete mode 100644 Assets/Docs/Static/Game.md delete mode 100644 Assets/Docs/Static/Game.md.meta delete mode 100644 Assets/Docs/Static/Input.md delete mode 100644 Assets/Docs/Static/Input.md.meta delete mode 100644 Assets/Docs/Static/Json.md delete mode 100644 Assets/Docs/Static/Json.md.meta delete mode 100644 Assets/Docs/Static/LineRenderer.md delete mode 100644 Assets/Docs/Static/LineRenderer.md.meta delete mode 100644 Assets/Docs/Static/Map.md delete mode 100644 Assets/Docs/Static/Map.md.meta delete mode 100644 Assets/Docs/Static/Math.md delete mode 100644 Assets/Docs/Static/Math.md.meta delete mode 100644 Assets/Docs/Static/Network.md delete mode 100644 Assets/Docs/Static/Network.md.meta delete mode 100644 Assets/Docs/Static/PersistentData.md delete mode 100644 Assets/Docs/Static/PersistentData.md.meta delete mode 100644 Assets/Docs/Static/Physics.md delete mode 100644 Assets/Docs/Static/Physics.md.meta delete mode 100644 Assets/Docs/Static/Quaternion.md delete mode 100644 Assets/Docs/Static/Quaternion.md.meta delete mode 100644 Assets/Docs/Static/Random.md delete mode 100644 Assets/Docs/Static/Random.md.meta delete mode 100644 Assets/Docs/Static/RoomData.md delete mode 100644 Assets/Docs/Static/RoomData.md.meta delete mode 100644 Assets/Docs/Static/String.md delete mode 100644 Assets/Docs/Static/String.md.meta delete mode 100644 Assets/Docs/Static/Time.md delete mode 100644 Assets/Docs/Static/Time.md.meta delete mode 100644 Assets/Docs/Static/UI.md delete mode 100644 Assets/Docs/Static/UI.md.meta delete mode 100644 Assets/Docs/Static/Vector2.md delete mode 100644 Assets/Docs/Static/Vector2.md.meta delete mode 100644 Assets/Docs/Static/Vector3.md delete mode 100644 Assets/Docs/Static/Vector3.md.meta create mode 100644 Assets/Scripts/CustomLogic/Attributes/CLCallbackAttribute.cs create mode 100644 Assets/Scripts/CustomLogic/Attributes/CLCallbackAttribute.cs.meta diff --git a/.github/workflows/autodoc.yml b/.github/workflows/autodoc.yml index 8622ef0d5..c6921003a 100644 --- a/.github/workflows/autodoc.yml +++ b/.github/workflows/autodoc.yml @@ -3,7 +3,7 @@ name: Sync Files to Another Repo on: push: branches: - - Thyme-TestBranch # Source branch + - Thyme-DocTestBranch jobs: sync: @@ -11,39 +11,69 @@ jobs: 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 \ No newline at end of file diff --git a/.github/workflows/sugggest.md b/.github/workflows/sugggest.md new file mode 100644 index 000000000..a153c2fc0 --- /dev/null +++ b/.github/workflows/sugggest.md @@ -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. \ No newline at end of file diff --git a/.github/workflows/test.md b/.github/workflows/test.md new file mode 100644 index 000000000..981e57485 --- /dev/null +++ b/.github/workflows/test.md @@ -0,0 +1,117 @@ +# Table of contents + +## Custom Map Tutorial + +* [Custom Map Introduction](README.md) +* [Your first map](custom-map-tutorial/your-first-map.md) +* [Map Navigation](custom-map-tutorial/map-navigation.md) +* [Object Selection](custom-map-tutorial/object-selection.md) +* [Object Positioning](custom-map-tutorial/object-positioning.md) +* [Object Attributes](custom-map-tutorial/object-attributes.md) +* [Shortcuts and Macros](custom-map-tutorial/shortcuts-and-macros.md) +* [Editor Settings](custom-map-tutorial/editor-settings.md) +* [Built-in Components Common Errors](custom-map-tutorial/built-in-components-common-errors.md) +* [Map Performance](custom-map-tutorial/map-performance.md) +* [Custom Assets](custom-map-tutorial/custom-assets/README.md) + * [Your first Asset Bundle](custom-map-tutorial/custom-assets/your-first-asset-bundle.md) + * [Asset Bundles in Map Editor](custom-map-tutorial/custom-assets/asset-bundles-in-map-editor.md) + * [Asset Bundles in Game](custom-map-tutorial/custom-assets/asset-bundles-in-game.md) + * [Adding to Asset Bundles](custom-map-tutorial/custom-assets/adding-to-asset-bundles.md) + * [Asset Bundle naming](custom-map-tutorial/custom-assets/asset-bundle-naming.md) + +## Custom Logic Tutorial + +* [Custom Logic Introduction](custom-logic-tutorial/custom-logic-introduction.md) +* [Your first script](custom-logic-tutorial/your-first-script.md) +* [Variables](custom-logic-tutorial/variables.md) +* [Types](custom-logic-tutorial/types.md) +* [Variable Inspector](custom-logic-tutorial/variable-inspector.md) +* [Expressions](custom-logic-tutorial/expressions.md) +* [Conditionals](custom-logic-tutorial/conditionals.md) +* [Loops](custom-logic-tutorial/loops.md) +* [Functions](custom-logic-tutorial/functions.md) +* [Coroutines](custom-logic-tutorial/coroutines.md) +* [Classes](custom-logic-tutorial/classes.md) +* [Static Classes](custom-logic-tutorial/static-classes.md) +* [Components](custom-logic-tutorial/components.md) +* [Extensions](custom-logic-tutorial/extensions.md) +* [Cutscenes](custom-logic-tutorial/cutscenes.md) +* [Static Objects](custom-logic-tutorial/static-objects.md) +* [Networking](custom-logic-tutorial/networking.md) +* [Commenting](custom-logic-tutorial/commenting.md) + +## Reference + +* [Static Classes](reference/static-classes/README.md) + * [Game](reference/static-classes/game.md) + * [Network](reference/static-classes/network.md) + * [Map](reference/static-classes/map.md) + * [UI](reference/static-classes/ui.md) + * [Time](reference/static-classes/time.md) + * [Convert](reference/static-classes/convert.md) + * [String](reference/static-classes/string.md) + * [Input](reference/static-classes/input.md) + * [Math](reference/static-classes/math.md) + * [Random](reference/static-classes/random.md) + * [Cutscene](reference/static-classes/cutscene.md) + * [Camera](reference/static-classes/camera.md) + * [RoomData](reference/static-classes/roomdata.md) + * [PersistentData](reference/static-classes/persistentdata.md) + * [Json](reference/static-classes/json.md) + * [Physics](reference/static-classes/physics.md) +* [Objects](reference/objects/README.md) + * [Component](reference/objects/component.md) + * [Object](reference/objects/object.md) + * [Character](reference/objects/character.md) + * [Human](reference/objects/human.md) + * [Titan](reference/objects/titan.md) + * [Shifter](reference/objects/shifter.md) + * [MapObject](reference/objects/mapobject.md) + * [Transform](reference/objects/transform.md) + * [Player](reference/objects/player.md) + * [NetworkView](reference/objects/networkview.md) + * [Color](reference/objects/color.md) + * [Vector3](reference/objects/vector3.md) + * [Quaternion](reference/objects/quaternion.md) + * [Dict](reference/objects/dict.md) + * [List](reference/objects/list.md) + * [Range](reference/objects/range.md) + * [LineCastHitResult](reference/objects/linecasthitresult.md) + * [MapTargetable](reference/objects/maptargetable.md) + * [Random](reference/objects/random.md) +* [Callbacks](reference/callbacks/README.md) + * [Main](reference/callbacks/main.md) + * [Components](reference/callbacks/components.md) + +## Examples + +* [Gamemodes](examples/gamemodes/README.md) + * [Survive](examples/gamemodes/survive.md) + * [Waves](examples/gamemodes/waves.md) + * [Endless](examples/gamemodes/endless.md) + * [Racing](examples/gamemodes/racing.md) + * [Blade PVP](examples/gamemodes/blade-pvp.md) + * [Thunderspear PVP](examples/gamemodes/thunderspear-pvp.md) + * [Titan Explode](examples/gamemodes/titan-explode.md) + * [Cranked](examples/gamemodes/cranked.md) + * [More Examples](examples/gamemodes/more-examples.md) +* [Components](examples/components/README.md) + * [SupplyStation](examples/components/supplystation.md) + * [Daylight](examples/components/daylight.md) + * [PointLight](examples/components/pointlight.md) + * [Rigidbody](examples/components/rigidbody.md) + * [NavMeshObstacle](examples/components/navmeshobstacle.md) + * [Cannon](examples/components/cannon.md) + * [Dummy](examples/components/dummy.md) + * [Wagon](examples/components/wagon.md) + * [Tag](examples/components/tag.md) + * [KillRegion](examples/components/killregion.md) + * [DamageRegion](examples/components/damageregion.md) + * [MovePingPong](examples/components/movepingpong.md) + * [RacingCheckpointRegion](examples/components/racingcheckpointregion.md) + * [RacingFinishRegion](examples/components/racingfinishregion.md) + * [TeleportRegion](examples/components/teleportregion.md) + * [Animal](examples/components/animal.md) + * [SignalMover](examples/components/signalmover.md) + * [SignalSender](examples/components/signalsender.md) + * [More Examples](examples/components/more-examples.md) \ No newline at end of file diff --git a/.github/workflows/testing.py b/.github/workflows/testing.py new file mode 100644 index 000000000..ab18a7bed --- /dev/null +++ b/.github/workflows/testing.py @@ -0,0 +1,184 @@ +import json +import re + +def parse_markdown(markdown): + lines = markdown.split('\n') + tree = [] + stack = [] + + for line in lines: + stripped_line = line.strip() + if re.match(r'^##\s', stripped_line): + group = { + 'group_name': stripped_line[3:].strip(), + 'pages': [] + } + tree.append(group) + stack = [group] + elif re.match(r'^\*\s', stripped_line): + page_name = re.search(r'\[(.*?)\]', stripped_line).group(1) + page_path = re.search(r'\((.*?)\)', stripped_line).group(1) + page = { + 'page_name': page_name, + 'page_path': page_path, + 'subpages': [] + } + indent_level = (len(line) - len(stripped_line)) // 2 + while len(stack) > indent_level + 1: + stack.pop() + if 'pages' in stack[-1]: + stack[-1]['pages'].append(page) + else: + stack[-1]['subpages'].append(page) + stack.append(page) + + return tree + +def serialize_to_markdown(json_content): + def serialize_group(group): + markdown = f"## {group['group_name']}\n\n" + for page in group['pages']: + markdown += serialize_page(page, 0) + return markdown + '\n' + + def serialize_page(page, indent_level): + indent = ' ' * indent_level + markdown = f"{indent}* [{page['page_name']}]({page['page_path']})\n" + for subpage in page['subpages']: + markdown += serialize_page(subpage, indent_level + 1) + return markdown + + markdown_content = "# Table of contents\n\n" + for group in json_content: + markdown_content += serialize_group(group) + + return markdown_content + +# Example markdown content +markdown_content = """ +# Table of contents + +## Custom Map Tutorial + +* [Custom Map Introduction](README.md) +* [Your first map](custom-map-tutorial/your-first-map.md) +* [Map Navigation](custom-map-tutorial/map-navigation.md) +* [Object Selection](custom-map-tutorial/object-selection.md) +* [Object Positioning](custom-map-tutorial/object-positioning.md) +* [Object Attributes](custom-map-tutorial/object-attributes.md) +* [Shortcuts and Macros](custom-map-tutorial/shortcuts-and-macros.md) +* [Editor Settings](custom-map-tutorial/editor-settings.md) +* [Built-in Components Common Errors](custom-map-tutorial/built-in-components-common-errors.md) +* [Map Performance](custom-map-tutorial/map-performance.md) +* [Custom Assets](custom-map-tutorial/custom-assets/README.md) + * [Your first Asset Bundle](custom-map-tutorial/custom-assets/your-first-asset-bundle.md) + * [Asset Bundles in Map Editor](custom-map-tutorial/custom-assets/asset-bundles-in-map-editor.md) + * [Asset Bundles in Game](custom-map-tutorial/custom-assets/asset-bundles-in-game.md) + * [Adding to Asset Bundles](custom-map-tutorial/custom-assets/adding-to-asset-bundles.md) + * [Asset Bundle naming](custom-map-tutorial/custom-assets/asset-bundle-naming.md) + +## Custom Logic Tutorial + +* [Custom Logic Introduction](custom-logic-tutorial/custom-logic-introduction.md) +* [Your first script](custom-logic-tutorial/your-first-script.md) +* [Variables](custom-logic-tutorial/variables.md) +* [Types](custom-logic-tutorial/types.md) +* [Variable Inspector](custom-logic-tutorial/variable-inspector.md) +* [Expressions](custom-logic-tutorial/expressions.md) +* [Conditionals](custom-logic-tutorial/conditionals.md) +* [Loops](custom-logic-tutorial/loops.md) +* [Functions](custom-logic-tutorial/functions.md) +* [Coroutines](custom-logic-tutorial/coroutines.md) +* [Classes](custom-logic-tutorial/classes.md) +* [Static Classes](custom-logic-tutorial/static-classes.md) +* [Components](custom-logic-tutorial/components.md) +* [Extensions](custom-logic-tutorial/extensions.md) +* [Cutscenes](custom-logic-tutorial/cutscenes.md) +* [Static Objects](custom-logic-tutorial/static-objects.md) +* [Networking](custom-logic-tutorial/networking.md) +* [Commenting](custom-logic-tutorial/commenting.md) + +## Reference + +* [Static Classes](reference/static-classes/README.md) + * [Game](reference/static-classes/game.md) + * [Network](reference/static-classes/network.md) + * [Map](reference/static-classes/map.md) + * [UI](reference/static-classes/ui.md) + * [Time](reference/static-classes/time.md) + * [Convert](reference/static-classes/convert.md) + * [String](reference/static-classes/string.md) + * [Input](reference/static-classes/input.md) + * [Math](reference/static-classes/math.md) + * [Random](reference/static-classes/random.md) + * [Cutscene](reference/static-classes/cutscene.md) + * [Camera](reference/static-classes/camera.md) + * [RoomData](reference/static-classes/roomdata.md) + * [PersistentData](reference/static-classes/persistentdata.md) + * [Json](reference/static-classes/json.md) + * [Physics](reference/static-classes/physics.md) +* [Objects](reference/objects/README.md) + * [Component](reference/objects/component.md) + * [Object](reference/objects/object.md) + * [Character](reference/objects/character.md) + * [Human](reference/objects/human.md) + * [Titan](reference/objects/titan.md) + * [Shifter](reference/objects/shifter.md) + * [MapObject](reference/objects/mapobject.md) + * [Transform](reference/objects/transform.md) + * [Player](reference/objects/player.md) + * [NetworkView](reference/objects/networkview.md) + * [Color](reference/objects/color.md) + * [Vector3](reference/objects/vector3.md) + * [Quaternion](reference/objects/quaternion.md) + * [Dict](reference/objects/dict.md) + * [List](reference/objects/list.md) + * [Range](reference/objects/range.md) + * [LineCastHitResult](reference/objects/linecasthitresult.md) + * [MapTargetable](reference/objects/maptargetable.md) + * [Random](reference/objects/random.md) +* [Callbacks](reference/callbacks/README.md) + * [Main](reference/callbacks/main.md) + * [Components](reference/callbacks/components.md) + +## Examples + +* [Gamemodes](examples/gamemodes/README.md) + * [Survive](examples/gamemodes/survive.md) + * [Waves](examples/gamemodes/waves.md) + * [Endless](examples/gamemodes/endless.md) + * [Racing](examples/gamemodes/racing.md) + * [Blade PVP](examples/gamemodes/blade-pvp.md) + * [Thunderspear PVP](examples/gamemodes/thunderspear-pvp.md) + * [Titan Explode](examples/gamemodes/titan-explode.md) + * [Cranked](examples/gamemodes/cranked.md) + * [More Examples](examples/gamemodes/more-examples.md) +* [Components](examples/components/README.md) + * [SupplyStation](examples/components/supplystation.md) + * [Daylight](examples/components/daylight.md) + * [PointLight](examples/components/pointlight.md) + * [Rigidbody](examples/components/rigidbody.md) + * [NavMeshObstacle](examples/components/navmeshobstacle.md) + * [Cannon](examples/components/cannon.md) + * [Dummy](examples/components/dummy.md) + * [Wagon](examples/components/wagon.md) + * [Tag](examples/components/tag.md) + * [KillRegion](examples/components/killregion.md) + * [DamageRegion](examples/components/damageregion.md) + * [MovePingPong](examples/components/movepingpong.md) + * [RacingCheckpointRegion](examples/components/racingcheckpointregion.md) + * [RacingFinishRegion](examples/components/racingfinishregion.md) + * [TeleportRegion](examples/components/teleportregion.md) + * [Animal](examples/components/animal.md) + * [SignalMover](examples/components/signalmover.md) + * [SignalSender](examples/components/signalsender.md) + * [More Examples](examples/components/more-examples.md) +""" + +# Parse the markdown content +parsed_content = parse_markdown(markdown_content) + +# Update the parsed content + +# Convert back to markdown +markdown_content = serialize_to_markdown(parsed_content) diff --git a/.github/workflows/updateSummary.py b/.github/workflows/updateSummary.py new file mode 100644 index 000000000..849366364 --- /dev/null +++ b/.github/workflows/updateSummary.py @@ -0,0 +1,127 @@ +import argparse +import json +import re +import os + +def parse_markdown(markdown): + lines = markdown.split('\n') + tree = [] + stack = [] + + for line in lines: + stripped_line = line.strip() + if re.match(r'^##\s', stripped_line): + group = { + 'group_name': stripped_line[3:].strip(), + 'pages': [] + } + tree.append(group) + stack = [group] + elif re.match(r'^\*\s', stripped_line): + page_name = re.search(r'\[(.*?)\]', stripped_line).group(1) + page_path = re.search(r'\((.*?)\)', stripped_line).group(1) + page = { + 'page_name': page_name, + 'page_path': page_path, + 'subpages': [] + } + indent_level = (len(line) - len(stripped_line)) // 2 + while len(stack) > indent_level + 1: + stack.pop() + if 'pages' in stack[-1]: + stack[-1]['pages'].append(page) + else: + stack[-1]['subpages'].append(page) + stack.append(page) + + return tree + +def serialize_to_markdown(json_content): + def serialize_group(group): + markdown = f"## {group['group_name']}\n\n" + for page in group['pages']: + markdown += serialize_page(page, 0) + return markdown + '\n' + + def serialize_page(page, indent_level): + indent = ' ' * indent_level + markdown = f"{indent}* [{page['page_name']}]({page['page_path']})\n" + for subpage in page['subpages']: + markdown += serialize_page(subpage, indent_level + 1) + return markdown + + markdown_content = "# Table of contents\n\n" + for group in json_content: + markdown_content += serialize_group(group) + + return markdown_content + +def create_page(file): + # Get the file name without .md + parts = file.split('/') + return { + 'page_name': parts[-1].split('.')[0], + 'page_path': file, + 'subpages': [] + } + + +def update_summary(summary, object_files, static_files): + # Parse the summary markdown content into a JSON tree structure + tree = parse_markdown(summary) + + print(tree) + + # Delete all pages under reference/object and reference/static except for the README.md pages + reference = tree.index(next(group for group in tree if group['group_name'] == 'Reference')) + refs = tree[reference]['pages'] + + for ref in refs: + if ref['page_name'] == 'Objects': + new_pages = [create_page(file) for file in object_files if file != 'reference/objects/README.md'] + ref['subpages'] = new_pages + if ref['page_name'] == 'Static Classes': + new_pages = [create_page(file) for file in static_files if file != 'reference/static/README.md'] + ref['subpages'] = new_pages + + # Serialize the JSON tree structure back to markdown content + return serialize_to_markdown(tree) + + + +if __name__ == "__main__": + # Parse command line arguments which contains a file path for the summary.md file + parser = argparse.ArgumentParser(description='Update summary.md file with dynamically synced content.') + parser.add_argument('summary', type=str, help='Path to the summary.md file.') + + # Single folder for object folder + parser.add_argument('objects', type=str, help='Path to the objects folder.') + parser.add_argument('static', type=str, help='Path to the static folder.') + + args = parser.parse_args() + + # Read the summary.md file + with open(args.summary, 'r') as file: + summary = file.read() + + # Get all file names under the object folder + object_files = [f'reference/objects/{file}' for file in os.listdir(args.objects)] + static_files = [f'reference/static/{file}' for file in os.listdir(args.static)] + + # Sort both lists alphabetically by filename + object_files.sort(key=lambda x: x.split('/')[-1]) + static_files.sort(key=lambda x: x.split('/')[-1]) + + # print object_files and static_files + print("object_files: ", object_files) + print("static_files: ", static_files) + + + # Update the summary.md file with the dynamically synced content + updated_summary = update_summary(summary, object_files, static_files) + + print(updated_summary) + + # Write the updated summary.md file + with open(args.summary, 'w') as file: + file.write(updated_summary) \ No newline at end of file diff --git a/Assets/Docs.meta b/Assets/Docs.meta deleted file mode 100644 index 9e4d32ee5..000000000 --- a/Assets/Docs.meta +++ /dev/null @@ -1,8 +0,0 @@ -fileFormatVersion: 2 -guid: a69567c6357539246987285ebd889e38 -folderAsset: yes -DefaultImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Object.meta b/Assets/Docs/Object.meta deleted file mode 100644 index 8d2d3242d..000000000 --- a/Assets/Docs/Object.meta +++ /dev/null @@ -1,8 +0,0 @@ -fileFormatVersion: 2 -guid: b89a54932ed2e1a43b487fd51f5f212b -folderAsset: yes -DefaultImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Object/Character.md b/Assets/Docs/Object/Character.md deleted file mode 100644 index c8cde0cf9..000000000 --- a/Assets/Docs/Object/Character.md +++ /dev/null @@ -1,44 +0,0 @@ -# Character -Inherits from object -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Name|[String](../Static/String.md)|False|Character's name.| -|Guild|[String](../Static/String.md)|False|Character's guild.| -|Player|[Player](../Object/Player.md)|False|Player who owns this character.| -|IsAI|bool|False|Is this character AI?| -|ViewID|int|False|Network view ID of the character.| -|IsMine|bool|False|Is this character mine?| -|IsMainCharacter|bool|False|| -|Transform|[Transform](../Object/Transform.md)|False|Unity transform of the character.| -|Position|[Vector3](../Static/Vector3.md)|False|Position of the character.| -|Rotation|[Vector3](../Static/Vector3.md)|False|Rotation of the character.| -|QuaternionRotation|[Quaternion](../Static/Quaternion.md)|False|Quaternion rotation of the character.| -|Velocity|[Vector3](../Static/Vector3.md)|False|Velocity of the character.| -|Forward|[Vector3](../Static/Vector3.md)|False|Forward direction of the character.| -|Right|[Vector3](../Static/Vector3.md)|False|Right direction of the character.| -|Up|[Vector3](../Static/Vector3.md)|False|Up direction of the character.| -|HasTargetDirection|bool|False|If the character has a target direction it is turning towards.| -|TargetDirection|[Vector3](../Static/Vector3.md)|False|The character's target direction.| -|Team|[String](../Static/String.md)|False|Team character belongs to.| -|Health|float|False|Character's current health.| -|MaxHealth|float|False|Character's maximum health.| -|CustomDamageEnabled|bool|False|Is custom damage dealing enabled.| -|CustomDamage|int|False|Amount of custom damage to deal per attack.| -|CurrentAnimation|[String](../Static/String.md)|False|Character's current playing animation.| -|Grounded|bool|False|Character's grounded status.| -## Methods -|Function|Returns|Description| -|---|---|---| -|GetKilled(killer : [String](../Static/String.md))|none|Kills the character. Callable by non-owners.| -|GetDamaged(killer : [String](../Static/String.md), damage : int)|none|Damages the character and kills it if its health reaches 0. Callable by non-owners.| -|Emote(emote : [String](../Static/String.md))|none|Causes the character to emote. The list of available emotes is the same as those shown in the in-game emote menu.| -|PlayAnimation(animation : [String](../Static/String.md), fade : float = 0.1)|none|Causes the character to play an animation. If the fade parameter is provided, will crossfade the animation by this timestep. Available animations can be found here: Human, Titan, Annie, Eren. Use the right-hand string value for the animation.| -|GetAnimationLength(animation : [String](../Static/String.md))|float|Gets the length of animation.| -|PlaySound(sound : [String](../Static/String.md))|none|Plays a sound if present in the character. Available sound names can be found here: Humans, Shifters, Titans. Note that shifters also have all titan sounds.| -|StopSound(sound : [String](../Static/String.md))|none|Stops the sound.| -|LookAt(position : [Vector3](../Static/Vector3.md))|none|Rotates the character such that it is looking towards a world position.| -|AddForce(force : [Vector3](../Static/Vector3.md), mode : [String](../Static/String.md) = Acceleration)|none|Adds a force to the character with given force vector and optional mode. Valid modes are Force, Acceleration, Impulse, VelocityChange with default being Acceleration.| -|Reveal(delay : float)|none|Reveaal the titan for a set number of seconds.| -|AddOutline(color : [Color](../Static/Color.md) = , mode : [String](../Static/String.md) = OutlineAll)|none|Adds an outline effect with the given color and mode. Valid modes are: OutlineAll, OutlineVisible, OutlineHidden, OutlineAndSilhouette, SilhouetteOnly, OutlineAndLightenColor| -|RemoveOutline()|none|Removes the outline effect from the character.| diff --git a/Assets/Docs/Object/Character.md.meta b/Assets/Docs/Object/Character.md.meta deleted file mode 100644 index a16acdf40..000000000 --- a/Assets/Docs/Object/Character.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 0a7e9eab1d4916c4bbe5f6fe02cf218d -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Object/Collider.md b/Assets/Docs/Object/Collider.md deleted file mode 100644 index 79640bfaf..000000000 --- a/Assets/Docs/Object/Collider.md +++ /dev/null @@ -1,23 +0,0 @@ -# Collider -Inherits from object -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|AttachedArticulationBody|[Transform](../Object/Transform.md)|False|| -|ContactOffset|float|False|| -|Enabled|bool|False|| -|ExludeLayers|int|False|| -|includeLayers|int|False|| -|IsTrigger|bool|False|| -|Center|[Vector3](../Static/Vector3.md)|False|| -|ProvidesContacts|bool|False|| -|MaterialName|[String](../Static/String.md)|False|| -|SharedMaterialName|[String](../Static/String.md)|False|| -|Transform|[Transform](../Object/Transform.md)|False|| -|GameObjectTransform|[Transform](../Object/Transform.md)|False|| -## Methods -|Function|Returns|Description| -|---|---|---| -|ClosestPoint(position : [Vector3](../Static/Vector3.md))|[Vector3](../Static/Vector3.md)|| -|ClosestPointOnBounds(position : [Vector3](../Static/Vector3.md))|[Vector3](../Static/Vector3.md)|| -|Raycast(start : [Vector3](../Static/Vector3.md), end : [Vector3](../Static/Vector3.md), maxDistance : float, collideWith : [String](../Static/String.md))|[LineCastHitResult](../Object/LineCastHitResult.md)|| diff --git a/Assets/Docs/Object/Collider.md.meta b/Assets/Docs/Object/Collider.md.meta deleted file mode 100644 index 908c1fd47..000000000 --- a/Assets/Docs/Object/Collider.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: a1038ec52b7f97345885935e8b851537 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Object/Collision.md b/Assets/Docs/Object/Collision.md deleted file mode 100644 index cce219091..000000000 --- a/Assets/Docs/Object/Collision.md +++ /dev/null @@ -1,13 +0,0 @@ -# Collision -Inherits from object -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Collider|[Collider](../Object/Collider.md)|False|| -|Impulse|[Vector3](../Static/Vector3.md)|False|| -|RelativeVelocity|[Vector3](../Static/Vector3.md)|False|| -## Methods -|Function|Returns|Description| -|---|---|---| -|GetContact(index : int)|none|| -|GetContacts()|none|| diff --git a/Assets/Docs/Object/Collision.md.meta b/Assets/Docs/Object/Collision.md.meta deleted file mode 100644 index 96c6110db..000000000 --- a/Assets/Docs/Object/Collision.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: b0a64dd71ee112240be3f63103524fcf -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Object/Dict.md b/Assets/Docs/Object/Dict.md deleted file mode 100644 index a3d962cfb..000000000 --- a/Assets/Docs/Object/Dict.md +++ /dev/null @@ -1,20 +0,0 @@ -# Dict -Inherits from object -## Initialization -```csharp -example = Dict() -``` -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Count|int|False|Number of elements in the dictionary| -|Keys|[List](../Object/List.md)|False|Keys in the dictionary| -|Values|[List](../Object/List.md)|False|Values in the dictionary| -## Methods -|Function|Returns|Description| -|---|---|---| -|Clear()|none|Clears the dictionary| -|Get(key : Object, defaultValue : Object = )|Object|Gets a value from the dictionary| -|Set(key : Object, value : Object)|none|Sets a value in the dictionary| -|Remove(key : Object)|none|Removes a value from the dictionary| -|Contains(key : Object)|bool|Checks if the dictionary contains a key| diff --git a/Assets/Docs/Object/Dict.md.meta b/Assets/Docs/Object/Dict.md.meta deleted file mode 100644 index 0e18e1976..000000000 --- a/Assets/Docs/Object/Dict.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 07976adeeff93cb499a566e0fa8a866b -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Object/Human.md b/Assets/Docs/Object/Human.md deleted file mode 100644 index 78fcb149e..000000000 --- a/Assets/Docs/Object/Human.md +++ /dev/null @@ -1,85 +0,0 @@ -# Human -Inherits from [Character](../Object/Character.md) -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Name|[String](../Static/String.md)|False|The human's name| -|Guild|[String](../Static/String.md)|False|The human's guild| -|Weapon|[String](../Static/String.md)|False|The weapon the human is using| -|CurrentSpecial|[String](../Static/String.md)|False|The current special the human is using| -|SpecialCooldown|float|False|The cooldown of the special| -|ShifterLiveTime|float|False|The live time of the shifter special| -|SpecialCooldownRatio|float|False|The ratio of the special cooldown| -|CurrentGas|float|False|The current gas of the human| -|MaxGas|float|False|The max gas of the human| -|Acceleration|int|False|The acceleration of the human| -|Speed|int|False|The speed of the human| -|HorseSpeed|float|False|The speed of the horse| -|CurrentBladeDurability|float|False|The current blade durability| -|MaxBladeDurability|float|False|The max blade durability| -|CurrentBlade|int|False|The current blade| -|MaxBlade|int|False|The max number of blades held| -|CurrentAmmoRound|int|False|The current ammo round| -|MaxAmmoRound|int|False|The max ammo round| -|CurrentAmmoLeft|int|False|The current ammo left| -|MaxAmmoTotal|int|False|The max total ammo| -|LeftHookEnabled|bool|False|Whether the left hook is enabled| -|RightHookEnabled|bool|False|Whether the right hook is enabled| -|IsMounted|bool|False|Whether the human is mounted| -|MountedMapObject|[MapObject](../Object/MapObject.md)|False|The map object the human is mounted on| -|MountedTransform|[Transform](../Object/Transform.md)|False|The transform the human is mounted on| -|AutoRefillGas|bool|False|Whether the human auto refills gas| -|State|[String](../Static/String.md)|False|The state of the human| -|CanDodge|bool|False|Whether the human can dodge| -|IsInvincible|bool|False|Whether the human is invincible| -|InvincibleTimeLeft|float|False|The time left for invincibility| -|IsCarried|bool|False|If the human is carried.| -|Player|[Player](../Object/Player.md)|False|Player who owns this character.| -|IsAI|bool|False|Is this character AI?| -|ViewID|int|False|Network view ID of the character.| -|IsMine|bool|False|Is this character mine?| -|IsMainCharacter|bool|False|| -|Transform|[Transform](../Object/Transform.md)|False|Unity transform of the character.| -|Position|[Vector3](../Static/Vector3.md)|False|Position of the character.| -|Rotation|[Vector3](../Static/Vector3.md)|False|Rotation of the character.| -|QuaternionRotation|[Quaternion](../Static/Quaternion.md)|False|Quaternion rotation of the character.| -|Velocity|[Vector3](../Static/Vector3.md)|False|Velocity of the character.| -|Forward|[Vector3](../Static/Vector3.md)|False|Forward direction of the character.| -|Right|[Vector3](../Static/Vector3.md)|False|Right direction of the character.| -|Up|[Vector3](../Static/Vector3.md)|False|Up direction of the character.| -|HasTargetDirection|bool|False|If the character has a target direction it is turning towards.| -|TargetDirection|[Vector3](../Static/Vector3.md)|False|The character's target direction.| -|Team|[String](../Static/String.md)|False|Team character belongs to.| -|Health|float|False|Character's current health.| -|MaxHealth|float|False|Character's maximum health.| -|CustomDamageEnabled|bool|False|Is custom damage dealing enabled.| -|CustomDamage|int|False|Amount of custom damage to deal per attack.| -|CurrentAnimation|[String](../Static/String.md)|False|Character's current playing animation.| -|Grounded|bool|False|Character's grounded status.| -## Methods -|Function|Returns|Description| -|---|---|---| -|Refill()|bool|Refills the gas of the human| -|RefillImmediate()|none|Refills the gas of the human immediately| -|ClearHooks()|none|Clears all hooks| -|ClearLeftHook()|none|Clears the left hook| -|ClearRightHook()|none|Clears the right hook| -|MountMapObject(mapObject : [MapObject](../Object/MapObject.md), positionOffset : [Vector3](../Static/Vector3.md), rotationOffset : [Vector3](../Static/Vector3.md))|none|Mounts the human on a map object| -|MountTransform(transform : [Transform](../Object/Transform.md), positionOffset : [Vector3](../Static/Vector3.md), rotationOffset : [Vector3](../Static/Vector3.md))|none|Mounts the human on a transform| -|Unmount()|none|Unmounts the human| -|SetSpecial(special : [String](../Static/String.md))|none|Sets the special of the human| -|ActivateSpecial()|none|Activates the special of the human| -|SetWeapon(weapon : [String](../Static/String.md))|none|Sets the weapon of the human| -|DisablePerks()|none|Disables all perks of the human| -|GetKilled(killer : [String](../Static/String.md))|none|Kills the character. Callable by non-owners.| -|GetDamaged(killer : [String](../Static/String.md), damage : int)|none|Damages the character and kills it if its health reaches 0. Callable by non-owners.| -|Emote(emote : [String](../Static/String.md))|none|Causes the character to emote. The list of available emotes is the same as those shown in the in-game emote menu.| -|PlayAnimation(animation : [String](../Static/String.md), fade : float = 0.1)|none|Causes the character to play an animation. If the fade parameter is provided, will crossfade the animation by this timestep. Available animations can be found here: Human, Titan, Annie, Eren. Use the right-hand string value for the animation.| -|GetAnimationLength(animation : [String](../Static/String.md))|float|Gets the length of animation.| -|PlaySound(sound : [String](../Static/String.md))|none|Plays a sound if present in the character. Available sound names can be found here: Humans, Shifters, Titans. Note that shifters also have all titan sounds.| -|StopSound(sound : [String](../Static/String.md))|none|Stops the sound.| -|LookAt(position : [Vector3](../Static/Vector3.md))|none|Rotates the character such that it is looking towards a world position.| -|AddForce(force : [Vector3](../Static/Vector3.md), mode : [String](../Static/String.md) = Acceleration)|none|Adds a force to the character with given force vector and optional mode. Valid modes are Force, Acceleration, Impulse, VelocityChange with default being Acceleration.| -|Reveal(delay : float)|none|Reveaal the titan for a set number of seconds.| -|AddOutline(color : [Color](../Static/Color.md) = , mode : [String](../Static/String.md) = OutlineAll)|none|Adds an outline effect with the given color and mode. Valid modes are: OutlineAll, OutlineVisible, OutlineHidden, OutlineAndSilhouette, SilhouetteOnly, OutlineAndLightenColor| -|RemoveOutline()|none|Removes the outline effect from the character.| diff --git a/Assets/Docs/Object/Human.md.meta b/Assets/Docs/Object/Human.md.meta deleted file mode 100644 index 1cd3ad2db..000000000 --- a/Assets/Docs/Object/Human.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 040e080ac4e2f6d45b74d7db575c8fcc -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Object/LineCastHitResult.md b/Assets/Docs/Object/LineCastHitResult.md deleted file mode 100644 index 7c1a80dea..000000000 --- a/Assets/Docs/Object/LineCastHitResult.md +++ /dev/null @@ -1,11 +0,0 @@ -# LineCastHitResult -Inherits from object -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|IsCharacter|bool|True|true if the linecast hit a character| -|IsMapObject|bool|True|true if the linecast hit a map object| -|Distance|float|True|The distance to the hit point| -|Point|[Vector3](../Static/Vector3.md)|True|The point in world space where the linecast hit| -|Normal|[Vector3](../Static/Vector3.md)|True|The normal of the surface the linecast hit| -|Collider|[Collider](../Object/Collider.md)|True|The collider that was hit| diff --git a/Assets/Docs/Object/LineCastHitResult.md.meta b/Assets/Docs/Object/LineCastHitResult.md.meta deleted file mode 100644 index 9914b28ca..000000000 --- a/Assets/Docs/Object/LineCastHitResult.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: cb981ecda0e61e545972c943bfc81191 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Object/List.md b/Assets/Docs/Object/List.md deleted file mode 100644 index a152917e7..000000000 --- a/Assets/Docs/Object/List.md +++ /dev/null @@ -1,29 +0,0 @@ -# List -Inherits from object -## Initialization -```csharp -example = List() -example = List((CustomLogicSetBuiltin)) -``` -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Count|int|True|The number of elements in the list| -## Methods -|Function|Returns|Description| -|---|---|---| -|Clear()|none|Clear all list elements| -|Get(index : int)|Object|Get the element at the specified index| -|Set(index : int, value : Object)|none|Set the element at the specified index| -|Add(value : Object)|none|Add an element to the end of the list| -|InsertAt(index : int, value : Object)|none|Insert an element at the specified index| -|RemoveAt(index : int)|none|Remove the element at the specified index| -|Remove(value : Object)|none|Remove the first occurrence of the specified element| -|Contains(value : Object)|bool|Check if the list contains the specified element| -|Sort()|none|Sort the list| -|SortCustom(method : UserMethod)|none|Sort the list using a custom method, expects a method with the signature int method(a,b)| -|Filter(method : UserMethod)|[List](../Object/List.md)|Filter the list using a custom method, expects a method with the signature bool method(element)| -|Map(method : UserMethod)|[List](../Object/List.md)|Map the list using a custom method, expects a method with the signature object method(element)| -|Reduce(method : UserMethod, initialValue : Object)|Object|Reduce the list using a custom method, expects a method with the signature object method(acc, element)| -|Randomize()|none|Randomize the list| -|ToSet()|[Set](../Object/Set.md)|Convert the list to a set| diff --git a/Assets/Docs/Object/List.md.meta b/Assets/Docs/Object/List.md.meta deleted file mode 100644 index ab30db710..000000000 --- a/Assets/Docs/Object/List.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 3c2d91db152519b4fab36071a2e1f447 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Object/MapObject.md b/Assets/Docs/Object/MapObject.md deleted file mode 100644 index 18095e3e9..000000000 --- a/Assets/Docs/Object/MapObject.md +++ /dev/null @@ -1,56 +0,0 @@ -# MapObject -Inherits from object -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Static|bool|False|Object does not move| -|Position|[Vector3](../Static/Vector3.md)|False|The position of the object| -|LocalPosition|[Vector3](../Static/Vector3.md)|False|The local position of the object| -|Rotation|[Vector3](../Static/Vector3.md)|False|The rotation of the object| -|LocalRotation|[Vector3](../Static/Vector3.md)|False|The local rotation of the object| -|QuaternionRotation|[Quaternion](../Static/Quaternion.md)|False|The rotation of the object as a quaternion| -|QuaternionLocalRotation|[Quaternion](../Static/Quaternion.md)|False|The local rotation of the object as a quaternion| -|Forward|[Vector3](../Static/Vector3.md)|False|The forward direction of the object| -|Up|[Vector3](../Static/Vector3.md)|False|The up direction of the object| -|Right|[Vector3](../Static/Vector3.md)|False|The right direction of the object| -|Scale|[Vector3](../Static/Vector3.md)|False|The scale of the object| -|Name|[String](../Static/String.md)|False|The name of the object| -|Parent|Object|False|The parent of the object| -|Active|bool|False|Whether the object is active| -|Transform|[Transform](../Object/Transform.md)|False|The transform of the object| -|HasRenderer|bool|False|Whether the object has a renderer| -|Color|[Color](../Static/Color.md)|False|The color of the object| -|TextureTilingX|float|False|The x tiling of the object's texture| -|TextureTilingY|float|False|The y tiling of the object's texture| -|TextureOffsetX|float|False|The x offset of the object's texture| -|TextureOffsetY|float|False|The y offset of the object's texture| -|ID|int|False|The ID of the object| -|Tag|[String](../Static/String.md)|False|The tag of the object| -|Layer|int|False|The layer of the object| -## Methods -|Function|Returns|Description| -|---|---|---| -|AddComponent(name : [String](../Static/String.md))|CustomLogicComponentInstance|Add a component to the object| -|RemoveComponent(name : [String](../Static/String.md))|none|Remove a component from the object| -|GetComponent(name : [String](../Static/String.md))|CustomLogicComponentInstance|Get a component from the object| -|SetComponentEnabled(name : [String](../Static/String.md), enabled : bool)|none|Set whether a component is enabled| -|SetComponentsEnabled(enabled : bool)|none|Set whether all components are enabled| -|AddSphereCollider(collideMode : [String](../Static/String.md), collideWith : [String](../Static/String.md), center : [Vector3](../Static/Vector3.md), radius : float)|none|Add a sphere collider to the object| -|AddBoxCollider(collideMode : [String](../Static/String.md), collideWith : [String](../Static/String.md), center : [Vector3](../Static/Vector3.md) = , size : [Vector3](../Static/Vector3.md) = )|none|Add a box collider to the object| -|AddSphereTarget(team : [String](../Static/String.md), center : [Vector3](../Static/Vector3.md), radius : float)|[MapTargetable](../Object/MapTargetable.md)|Add a sphere target to the object| -|AddBoxTarget(team : [String](../Static/String.md), center : [Vector3](../Static/Vector3.md), size : [Vector3](../Static/Vector3.md))|[MapTargetable](../Object/MapTargetable.md)|Add a box target to the object| -|GetChild(name : [String](../Static/String.md))|[MapObject](../Object/MapObject.md)|Get a child object by name| -|GetChildren()|[List](../Object/List.md)|Get all child objects| -|GetTransform(name : [String](../Static/String.md))|[Transform](../Object/Transform.md)|Get a child transform by name| -|SetColorAll(color : [Color](../Static/Color.md))|none|Set the color of all renderers on the object| -|InBounds(position : [Vector3](../Static/Vector3.md))|bool|Check if a position is within the object's bounds| -|GetBoundsAverageCenter()|[Vector3](../Static/Vector3.md)|Get the bounds average center| -|GetBoundsCenter()|[Vector3](../Static/Vector3.md)|Get the bounds center| -|GetBoundsSize()|[Vector3](../Static/Vector3.md)|Get the bounds size| -|GetBoundsMin()|[Vector3](../Static/Vector3.md)|Get the bounds min| -|GetBoundsMax()|[Vector3](../Static/Vector3.md)|Get the bounds max| -|GetBoundsExtents()|[Vector3](../Static/Vector3.md)|Get the bounds extents| -|GetCorners()|[List](../Object/List.md)|Get the corners of the bounds| -|AddBuiltinComponent(parameter0 : Object = , parameter1 : Object = , parameter2 : Object = , parameter3 : Object = , parameter4 : Object = )|none|[OBSELETE] Add builtin component| -|ReadBuiltinComponent(name : [String](../Static/String.md), param : [String](../Static/String.md))|Object|[OBSELETE] Read a builtin component| -|UpdateBuiltinComponent(parameter0 : Object = , parameter1 : Object = , parameter2 : Object = , parameter3 : Object = , parameter4 : Object = )|none|[OBSELETE] Update a builtin component| diff --git a/Assets/Docs/Object/MapObject.md.meta b/Assets/Docs/Object/MapObject.md.meta deleted file mode 100644 index c69be311c..000000000 --- a/Assets/Docs/Object/MapObject.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: f5a3151dd1e1fdb4b8a587263a531912 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Object/MapTargetable.md b/Assets/Docs/Object/MapTargetable.md deleted file mode 100644 index 5a5255797..000000000 --- a/Assets/Docs/Object/MapTargetable.md +++ /dev/null @@ -1,8 +0,0 @@ -# MapTargetable -Inherits from object -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Team|[String](../Static/String.md)|False|The team of the targetable| -|Position|[Vector3](../Static/Vector3.md)|False|The position of the targetable| -|Enabled|bool|False|Is the targetable enabled| diff --git a/Assets/Docs/Object/MapTargetable.md.meta b/Assets/Docs/Object/MapTargetable.md.meta deleted file mode 100644 index 640c15cf2..000000000 --- a/Assets/Docs/Object/MapTargetable.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 00c0e83660637164f978730b4871922a -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Object/NetworkView.md b/Assets/Docs/Object/NetworkView.md deleted file mode 100644 index add4d5241..000000000 --- a/Assets/Docs/Object/NetworkView.md +++ /dev/null @@ -1,15 +0,0 @@ -# NetworkView -Inherits from object -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Owner|[Player](../Object/Player.md)|False|The network view's owner.| -## Methods -|Function|Returns|Description| -|---|---|---| -|Transfer(player : [Player](../Object/Player.md))|none|Owner only. Transfer ownership of this NetworkView to another player.| -|SendMessage(target : [Player](../Object/Player.md), msg : [String](../Static/String.md))|none|Send a message to a target player. This will be received in any of the MapObject attached components through the OnNetworkMessage callback.| -|SendMessageAll(msg : [String](../Static/String.md))|none|Send a message to all players including myself.| -|SendMessageOthers(msg : [String](../Static/String.md))|none|Send a message to players excluding myself.| -|SendStream(obj : Object)|none|Send an object to the network sync stream. This represents sending data from the object owner to all non-owner observers, and should only be called in the SendNetworkStream callback in the attached component. It only works with some object types: primitives and Vector3.| -|ReceiveStream()|Object|Receive an object through the network sync stream. This represents receiving data from the object owner as a non-owner observer, and should only be called in the OnNetworkStream callback.| diff --git a/Assets/Docs/Object/NetworkView.md.meta b/Assets/Docs/Object/NetworkView.md.meta deleted file mode 100644 index 41e2fe16a..000000000 --- a/Assets/Docs/Object/NetworkView.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 325bb3ec20f5a4c428ffd4a8c0ae8277 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Object/Player.md b/Assets/Docs/Object/Player.md deleted file mode 100644 index 312e4b53c..000000000 --- a/Assets/Docs/Object/Player.md +++ /dev/null @@ -1,27 +0,0 @@ -# Player -Inherits from object -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Character|[Character](../Object/Character.md)|False|Player's current character, if alive.| -|Connected|bool|False|Player is still connected to the room.| -|ID|int|False|Player unique ID.| -|Name|[String](../Static/String.md)|False|Player name.| -|Guild|[String](../Static/String.md)|False|Player guild.| -|Team|[String](../Static/String.md)|False|Player's chosen team ("None", "Blue", "Red", "Titan", "Human"). Note that this may be different from the character's final team (Character.Team field) if the character's team field is modified.| -|Status|[String](../Static/String.md)|False|Player's spawn status ("Alive", "Dead", "Spectating").| -|CharacterType|[String](../Static/String.md)|False|Player's chosen character ("Human", "Titan", "Shifter")| -|Loadout|[String](../Static/String.md)|False|Player's chosen loadout ("Blades", "AHSS", "APG", "Thunderspears").| -|Kills|int|False|Player's kills.| -|Deaths|int|False|Player's deaths.| -|HighestDamage|int|False|Player's highest damage.| -|TotalDamage|int|False|Player's total damage.| -|Ping|int|False|The player's connection ping.| -|SpectateID|int|False|The player's spectating ID. If not spectating anyone, returns -1.| -|SpawnPoint|[Vector3](../Static/Vector3.md)|False|Player's respawn point. Is initially null and can be set back to null, at which point map spawn points are used.| -## Methods -|Function|Returns|Description| -|---|---|---| -|GetCustomProperty(property : [String](../Static/String.md))|Object|Get a custom property at given key. Must be a primitive type. This is synced to all clients.| -|SetCustomProperty(property : [String](../Static/String.md), value : Object)|none|Sets a custom property at given key. Must be a primitive type. This is synced to all clients.| -|ClearKDR()|none|Clears kills, deaths, highestdamage, and totaldamage properties.| diff --git a/Assets/Docs/Object/Player.md.meta b/Assets/Docs/Object/Player.md.meta deleted file mode 100644 index d3c7a4120..000000000 --- a/Assets/Docs/Object/Player.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 99fb869609fdf8b40bfd8ba452893657 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Object/Range.md b/Assets/Docs/Object/Range.md deleted file mode 100644 index f4ac578bf..000000000 --- a/Assets/Docs/Object/Range.md +++ /dev/null @@ -1,27 +0,0 @@ -# Range -## Initialization -```csharp -example = Range((Object[])) -``` -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Count|int|True|The number of elements in the list| -## Methods -|Function|Returns|Description| -|---|---|---| -|Clear()|none|Clear all list elements| -|Get(index : int)|Object|Get the element at the specified index| -|Set(index : int, value : Object)|none|Set the element at the specified index| -|Add(value : Object)|none|Add an element to the end of the list| -|InsertAt(index : int, value : Object)|none|Insert an element at the specified index| -|RemoveAt(index : int)|none|Remove the element at the specified index| -|Remove(value : Object)|none|Remove the first occurrence of the specified element| -|Contains(value : Object)|bool|Check if the list contains the specified element| -|Sort()|none|Sort the list| -|SortCustom(method : UserMethod)|none|Sort the list using a custom method, expects a method with the signature int method(a,b)| -|Filter(method : UserMethod)|[List](../Object/List.md)|Filter the list using a custom method, expects a method with the signature bool method(element)| -|Map(method : UserMethod)|[List](../Object/List.md)|Map the list using a custom method, expects a method with the signature object method(element)| -|Reduce(method : UserMethod, initialValue : Object)|Object|Reduce the list using a custom method, expects a method with the signature object method(acc, element)| -|Randomize()|none|Randomize the list| -|ToSet()|[Set](../Object/Set.md)|Convert the list to a set| diff --git a/Assets/Docs/Object/Range.md.meta b/Assets/Docs/Object/Range.md.meta deleted file mode 100644 index ac20f84f7..000000000 --- a/Assets/Docs/Object/Range.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 417536745313167478d3ae211147ea94 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Object/Set.md b/Assets/Docs/Object/Set.md deleted file mode 100644 index 83b86e343..000000000 --- a/Assets/Docs/Object/Set.md +++ /dev/null @@ -1,28 +0,0 @@ -# Set -Inherits from object -## Initialization -```csharp -example = Set() -example = Set((CustomLogicListBuiltin)) -``` -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Count|int|True|The number of elements in the set| -## Methods -|Function|Returns|Description| -|---|---|---| -|Clear()|none|Clear all set elements| -|Contains(value : Object)|bool|Check if the set contains the specified element| -|Add(value : Object)|none|Add an element to the set| -|Remove(value : Object)|none|Remove the element from the set| -|Union(set : [Set](../Object/Set.md))|none|Union with another set| -|Intersect(set : [Set](../Object/Set.md))|none|Intersect with another set| -|Difference(set : [Set](../Object/Set.md))|none|Difference with another set| -|IsSubsetOf(set : [Set](../Object/Set.md))|bool|Check if the set is a subset of another set| -|IsSupersetOf(set : [Set](../Object/Set.md))|bool|Check if the set is a superset of another set| -|IsProperSubsetOf(set : [Set](../Object/Set.md))|bool|Check if the set is a proper subset of another set| -|IsProperSupersetOf(set : [Set](../Object/Set.md))|bool|Check if the set is a proper superset of another set| -|Overlaps(set : [Set](../Object/Set.md))|bool|Check if the set overlaps with another set| -|SetEquals(set : [Set](../Object/Set.md))|bool|Check if the set has the same elements as another set| -|ToList()|[List](../Object/List.md)|Convert the set to a list| diff --git a/Assets/Docs/Object/Set.md.meta b/Assets/Docs/Object/Set.md.meta deleted file mode 100644 index bbdf99366..000000000 --- a/Assets/Docs/Object/Set.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 01cfacd57a4ffd846a92fc8e7430af3c -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Object/Shifter.md b/Assets/Docs/Object/Shifter.md deleted file mode 100644 index 640dbb54e..000000000 --- a/Assets/Docs/Object/Shifter.md +++ /dev/null @@ -1,70 +0,0 @@ -# Shifter -Inherits from [Character](../Object/Character.md) -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Name|[String](../Static/String.md)|False|Shifter's name.| -|Guild|[String](../Static/String.md)|False|Shifter's guild.| -|Size|float|False|Shifter's size.| -|RunSpeedBase|float|False|Shifter's base run speed. Final run speed is RunSpeedBase + Size * RunSpeedPerLevel.| -|WalkSpeedBase|float|False|Shifter's base walk speed. Final walk speed is WalkSpeedBase + Size * WalkSpeedPerLevel.| -|WalkSpeedPerLevel|float|False|Shifter's walk speed added per level.| -|RunSpeedPerLevel|float|False|Shifter's run speed added per level.| -|TurnSpeed|float|False|Shifter's turn speed when running turn animation.| -|RotateSpeed|float|False|Shifter's rotate speed when rotating body.| -|JumpForce|float|False|Shifter's jump force when jumping.| -|ActionPause|float|False|Shifter's pause delay after performing an action.| -|AttackPause|float|False|Shifter's pause delay after performing an attack.| -|TurnPause|float|False|Shifter's pause delay after performing a turn.| -|DetectRange|float|False|(AI) shifter's detect range.| -|FocusRange|float|False|(AI) shifter's focus range.| -|FocusTime|float|False|(AI) shifter's focus time before switching targets.| -|FarAttackCooldown|float|False|(AI) Shifter's cooldown after performing a ranged attack.| -|AttackWait|float|False|(AI) Shifter's wait time between being in range to attack and performing the attack.| -|AttackSpeedMultiplier|float|False|Shifter's attack animation speed.| -|UsePathfinding|bool|False|(AI) Shifter uses pathfinding.| -|NapePosition|[Vector3](../Static/Vector3.md)|False|The shifter's nape position.| -|DeathAnimLength|float|False|The length of the death animation.| -|Player|[Player](../Object/Player.md)|False|Player who owns this character.| -|IsAI|bool|False|Is this character AI?| -|ViewID|int|False|Network view ID of the character.| -|IsMine|bool|False|Is this character mine?| -|IsMainCharacter|bool|False|| -|Transform|[Transform](../Object/Transform.md)|False|Unity transform of the character.| -|Position|[Vector3](../Static/Vector3.md)|False|Position of the character.| -|Rotation|[Vector3](../Static/Vector3.md)|False|Rotation of the character.| -|QuaternionRotation|[Quaternion](../Static/Quaternion.md)|False|Quaternion rotation of the character.| -|Velocity|[Vector3](../Static/Vector3.md)|False|Velocity of the character.| -|Forward|[Vector3](../Static/Vector3.md)|False|Forward direction of the character.| -|Right|[Vector3](../Static/Vector3.md)|False|Right direction of the character.| -|Up|[Vector3](../Static/Vector3.md)|False|Up direction of the character.| -|HasTargetDirection|bool|False|If the character has a target direction it is turning towards.| -|TargetDirection|[Vector3](../Static/Vector3.md)|False|The character's target direction.| -|Team|[String](../Static/String.md)|False|Team character belongs to.| -|Health|float|False|Character's current health.| -|MaxHealth|float|False|Character's maximum health.| -|CustomDamageEnabled|bool|False|Is custom damage dealing enabled.| -|CustomDamage|int|False|Amount of custom damage to deal per attack.| -|CurrentAnimation|[String](../Static/String.md)|False|Character's current playing animation.| -|Grounded|bool|False|Character's grounded status.| -## Methods -|Function|Returns|Description| -|---|---|---| -|MoveTo(position : [Vector3](../Static/Vector3.md), range : float, ignoreEnemies : bool)|none|Causes the (AI) shifter to move towards a position. If ignoreEnemies is true, will not engage enemies along the way.| -|Target(enemyObj : Object, focus : float)|none|Causes the (AI) shifter to target an enemy character or MapTargetable for focusTime seconds. If focusTime is 0 it will use the default focus time.| -|Idle(time : float)|none|Causes the (AI) shifter to idle for time seconds before beginning to wander. During idle the titan will not react or move at all.| -|Wander()|none|Causes the (AI) shifter to cancel any move commands and begin wandering randomly.| -|Blind()|none|Causes the shifter to enter the blind state.| -|Cripple(time : float)|none|Causes the shifter to enter the cripple state.| -|GetKilled(killer : [String](../Static/String.md))|none|Kills the character. Callable by non-owners.| -|GetDamaged(killer : [String](../Static/String.md), damage : int)|none|Damages the character and kills it if its health reaches 0. Callable by non-owners.| -|Emote(emote : [String](../Static/String.md))|none|Causes the character to emote. The list of available emotes is the same as those shown in the in-game emote menu.| -|PlayAnimation(animation : [String](../Static/String.md), fade : float = 0.1)|none|Causes the character to play an animation. If the fade parameter is provided, will crossfade the animation by this timestep. Available animations can be found here: Human, Titan, Annie, Eren. Use the right-hand string value for the animation.| -|GetAnimationLength(animation : [String](../Static/String.md))|float|Gets the length of animation.| -|PlaySound(sound : [String](../Static/String.md))|none|Plays a sound if present in the character. Available sound names can be found here: Humans, Shifters, Titans. Note that shifters also have all titan sounds.| -|StopSound(sound : [String](../Static/String.md))|none|Stops the sound.| -|LookAt(position : [Vector3](../Static/Vector3.md))|none|Rotates the character such that it is looking towards a world position.| -|AddForce(force : [Vector3](../Static/Vector3.md), mode : [String](../Static/String.md) = Acceleration)|none|Adds a force to the character with given force vector and optional mode. Valid modes are Force, Acceleration, Impulse, VelocityChange with default being Acceleration.| -|Reveal(delay : float)|none|Reveaal the titan for a set number of seconds.| -|AddOutline(color : [Color](../Static/Color.md) = , mode : [String](../Static/String.md) = OutlineAll)|none|Adds an outline effect with the given color and mode. Valid modes are: OutlineAll, OutlineVisible, OutlineHidden, OutlineAndSilhouette, SilhouetteOnly, OutlineAndLightenColor| -|RemoveOutline()|none|Removes the outline effect from the character.| diff --git a/Assets/Docs/Object/Shifter.md.meta b/Assets/Docs/Object/Shifter.md.meta deleted file mode 100644 index c2101afad..000000000 --- a/Assets/Docs/Object/Shifter.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 13758726b492f9e4bb3b64cfbc184aef -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Object/Titan.md b/Assets/Docs/Object/Titan.md deleted file mode 100644 index 0075c08c3..000000000 --- a/Assets/Docs/Object/Titan.md +++ /dev/null @@ -1,75 +0,0 @@ -# Titan -Inherits from [Character](../Object/Character.md) -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Name|[String](../Static/String.md)|False|Titans's name.| -|Guild|[String](../Static/String.md)|False|Titans's guild.| -|Size|float|False|Titan's size.| -|RunSpeedBase|float|False|Titan's base run speed. Final run speed is RunSpeedBase + Size * RunSpeedPerLevel.| -|WalkSpeedBase|float|False|Titan's base walk speed. Final walk speed is WalkSpeedBase + Size * WalkSpeedPerLevel.| -|WalkSpeedPerLevel|float|False|Titan's walk speed added per size.| -|RunSpeedPerLevel|float|False|Titan's run speed added per size.| -|TurnSpeed|float|False|Titan's turn animation speed.| -|RotateSpeed|float|False|Titan's rotate speed.| -|JumpForce|float|False|Titan's jump force.| -|ActionPause|float|False|Titan's pause delay after performing an action.| -|AttackPause|float|False|Titan's pause delay after performing an attack.| -|TurnPause|float|False|Titan's pause delay after performing a turn.| -|Stamina|float|False|PT stamina.| -|MaxStamina|float|False|PT max stamina.| -|NapePosition|[Vector3](../Static/Vector3.md)|False|The titan's nape position.| -|IsCrawler|bool|False|Is titan a crawler.| -|DetectRange|float|False|(AI) titan's detect range.| -|FocusRange|float|False|(AI) titan's focus range.| -|FocusTime|float|False|(AI) titan's focus time.| -|FarAttackCooldown|float|False|(AI) Titan's cooldown after performing a ranged attack.| -|AttackWait|float|False|(AI) Titan's wait time between being in range and performing an attack.| -|CanRun|bool|False|(AI) Titan can run or only walk.| -|AttackSpeedMultiplier|float|False|Titan's attack animation speed.| -|UsePathfinding|bool|False|Determines whether the (AI) titan uses pathfinding. (Smart Movement in titan settings)| -|HeadMount|[Transform](../Object/Transform.md)|False|Titan's head transform.| -|NeckMount|[Transform](../Object/Transform.md)|False|Titan's neck transform.| -|Player|[Player](../Object/Player.md)|False|Player who owns this character.| -|IsAI|bool|False|Is this character AI?| -|ViewID|int|False|Network view ID of the character.| -|IsMine|bool|False|Is this character mine?| -|IsMainCharacter|bool|False|| -|Transform|[Transform](../Object/Transform.md)|False|Unity transform of the character.| -|Position|[Vector3](../Static/Vector3.md)|False|Position of the character.| -|Rotation|[Vector3](../Static/Vector3.md)|False|Rotation of the character.| -|QuaternionRotation|[Quaternion](../Static/Quaternion.md)|False|Quaternion rotation of the character.| -|Velocity|[Vector3](../Static/Vector3.md)|False|Velocity of the character.| -|Forward|[Vector3](../Static/Vector3.md)|False|Forward direction of the character.| -|Right|[Vector3](../Static/Vector3.md)|False|Right direction of the character.| -|Up|[Vector3](../Static/Vector3.md)|False|Up direction of the character.| -|HasTargetDirection|bool|False|If the character has a target direction it is turning towards.| -|TargetDirection|[Vector3](../Static/Vector3.md)|False|The character's target direction.| -|Team|[String](../Static/String.md)|False|Team character belongs to.| -|Health|float|False|Character's current health.| -|MaxHealth|float|False|Character's maximum health.| -|CustomDamageEnabled|bool|False|Is custom damage dealing enabled.| -|CustomDamage|int|False|Amount of custom damage to deal per attack.| -|CurrentAnimation|[String](../Static/String.md)|False|Character's current playing animation.| -|Grounded|bool|False|Character's grounded status.| -## Methods -|Function|Returns|Description| -|---|---|---| -|MoveTo(position : [Vector3](../Static/Vector3.md), range : float, ignoreEnemies : bool)|none|Causes the (AI) titan to move towards a position and stopping when within specified range. If ignoreEnemies is true, will not engage enemies along the way.| -|Target(enemyObj : Object, focus : float)|none|Causes the (AI) titan to target an enemy character or MapTargetable for focusTime seconds. If focusTime is 0 it will use the default focus time| -|Idle(time : float)|none|Causes the (AI) titan to idle for time seconds before beginning to wander. During idle the titan will not react or move at all.| -|Wander()|none|Causes the (AI) titan to cancel any move commands and begin wandering randomly.| -|Blind()|none|Causes the titan to enter the blind state.| -|Cripple(time : float)|none|Causes the titan to enter the cripple state for time seconds. Using 0 will use the default cripple time.| -|GetKilled(killer : [String](../Static/String.md))|none|Kills the character. Callable by non-owners.| -|GetDamaged(killer : [String](../Static/String.md), damage : int)|none|Damages the character and kills it if its health reaches 0. Callable by non-owners.| -|Emote(emote : [String](../Static/String.md))|none|Causes the character to emote. The list of available emotes is the same as those shown in the in-game emote menu.| -|PlayAnimation(animation : [String](../Static/String.md), fade : float = 0.1)|none|Causes the character to play an animation. If the fade parameter is provided, will crossfade the animation by this timestep. Available animations can be found here: Human, Titan, Annie, Eren. Use the right-hand string value for the animation.| -|GetAnimationLength(animation : [String](../Static/String.md))|float|Gets the length of animation.| -|PlaySound(sound : [String](../Static/String.md))|none|Plays a sound if present in the character. Available sound names can be found here: Humans, Shifters, Titans. Note that shifters also have all titan sounds.| -|StopSound(sound : [String](../Static/String.md))|none|Stops the sound.| -|LookAt(position : [Vector3](../Static/Vector3.md))|none|Rotates the character such that it is looking towards a world position.| -|AddForce(force : [Vector3](../Static/Vector3.md), mode : [String](../Static/String.md) = Acceleration)|none|Adds a force to the character with given force vector and optional mode. Valid modes are Force, Acceleration, Impulse, VelocityChange with default being Acceleration.| -|Reveal(delay : float)|none|Reveaal the titan for a set number of seconds.| -|AddOutline(color : [Color](../Static/Color.md) = , mode : [String](../Static/String.md) = OutlineAll)|none|Adds an outline effect with the given color and mode. Valid modes are: OutlineAll, OutlineVisible, OutlineHidden, OutlineAndSilhouette, SilhouetteOnly, OutlineAndLightenColor| -|RemoveOutline()|none|Removes the outline effect from the character.| diff --git a/Assets/Docs/Object/Titan.md.meta b/Assets/Docs/Object/Titan.md.meta deleted file mode 100644 index 346fc0119..000000000 --- a/Assets/Docs/Object/Titan.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 49e2484a54a82e04bbb20fe574bd7900 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Object/Transform.md b/Assets/Docs/Object/Transform.md deleted file mode 100644 index 7502cf236..000000000 --- a/Assets/Docs/Object/Transform.md +++ /dev/null @@ -1,36 +0,0 @@ -# Transform -Inherits from object -## Initialization -```csharp -``` -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Position|[Vector3](../Static/Vector3.md)|False|Gets or sets the position of the transform.| -|LocalPosition|[Vector3](../Static/Vector3.md)|False|Gets or sets the local position of the transform.| -|Rotation|[Vector3](../Static/Vector3.md)|False|Gets or sets the rotation of the transform.| -|LocalRotation|[Vector3](../Static/Vector3.md)|False|Gets or sets the local rotation of the transform.| -|QuaternionRotation|[Quaternion](../Static/Quaternion.md)|False|Gets or sets the quaternion rotation of the transform.| -|QuaternionLocalRotation|[Quaternion](../Static/Quaternion.md)|False|Gets or sets the quaternion local rotation of the transform.| -|Scale|[Vector3](../Static/Vector3.md)|False|Gets or sets the scale of the transform.| -|Forward|[Vector3](../Static/Vector3.md)|False|Gets the forward vector of the transform.| -|Up|[Vector3](../Static/Vector3.md)|False|Gets the up vector of the transform.| -|Right|[Vector3](../Static/Vector3.md)|False|Gets the right vector of the transform.| -## Methods -|Function|Returns|Description| -|---|---|---| -|GetTransform(name : [String](../Static/String.md))|[Transform](../Object/Transform.md)|Gets the transform of the specified child.| -|GetTransforms()|[List](../Object/List.md)|Gets all child transforms.| -|PlayAnimation(anim : [String](../Static/String.md), fade : float = 0.1)|none|Plays the specified animation.| -|GetAnimationLength(anim : [String](../Static/String.md))|float|Gets the length of the specified animation.| -|PlaySound()|none|Plays the sound.| -|StopSound()|none|Stops the sound.| -|ToggleParticle(enabled : bool)|none|Toggles the particle system.| -|InverseTransformDirection(direction : [Vector3](../Static/Vector3.md))|[Vector3](../Static/Vector3.md)|Transforms a direction from world space to local space. The opposite of Transform.TransformDirection.| -|InverseTransformPoint(point : [Vector3](../Static/Vector3.md))|[Vector3](../Static/Vector3.md)|Transforms position from world space to local space.| -|TransformDirection(direction : [Vector3](../Static/Vector3.md))|[Vector3](../Static/Vector3.md)|Transforms direction from local space to world space.| -|TransformPoint(point : [Vector3](../Static/Vector3.md))|[Vector3](../Static/Vector3.md)|Transforms position from local space to world space.| -|Rotate(rotation : [Vector3](../Static/Vector3.md))|none|Applies a rotation of eulerAngles.z degrees around the z-axis, eulerAngles.x degrees around the x-axis, and eulerAngles.y degrees around the y-axis (in that order).| -|RotateAround(point : [Vector3](../Static/Vector3.md), axis : [Vector3](../Static/Vector3.md), angle : float)|none|Rotates the transform about axis passing through point in world coordinates by angle degrees.| -|LookAt(target : [Vector3](../Static/Vector3.md))|none|Rotates the transform so the forward vector points at worldPosition.| -|SetRenderersEnabled(enabled : bool)|none|Sets the enabled state of all child renderers.| diff --git a/Assets/Docs/Object/Transform.md.meta b/Assets/Docs/Object/Transform.md.meta deleted file mode 100644 index 6e14342aa..000000000 --- a/Assets/Docs/Object/Transform.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 4643727eca70ce847a05b8ac509e69ed -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Static.meta b/Assets/Docs/Static.meta deleted file mode 100644 index 698d4b0f6..000000000 --- a/Assets/Docs/Static.meta +++ /dev/null @@ -1,8 +0,0 @@ -fileFormatVersion: 2 -guid: 6194475bea13abf4da1256a58415af1d -folderAsset: yes -DefaultImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Static/Camera.md b/Assets/Docs/Static/Camera.md deleted file mode 100644 index 8f41cad5c..000000000 --- a/Assets/Docs/Static/Camera.md +++ /dev/null @@ -1,27 +0,0 @@ -# Camera -Inherits from object -## Static Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|IsManual|bool|False|Is camera in manual mode.| -|Position|[Vector3](../Static/Vector3.md)|False|Position of the camera.| -|Rotation|[Vector3](../Static/Vector3.md)|False|Rotation of the camera.| -|Velocity|[Vector3](../Static/Vector3.md)|False|Velocity of the camera.| -|FOV|float|False|Field of view of the camera.| -|CameraMode|[String](../Static/String.md)|False|Current camera mode.| -|Forward|[Vector3](../Static/Vector3.md)|False|Forward vector of the camera.| -|Right|[Vector3](../Static/Vector3.md)|False|Right vector of the camera.| -|Up|[Vector3](../Static/Vector3.md)|False|Up vector of the camera.| -|FollowDistance|float|False|Distance from the camera to the character.| -## Methods -|Function|Returns|Description| -|---|---|---| -|SetManual(manual : bool)|none|Sets the camera manual mode. If true, camera will only be controlled by custom logic. If false, camera will follow the spawned or spectated player and read input.| -|SetPosition(position : [Vector3](../Static/Vector3.md))|none|Sets camera position.| -|SetRotation(rotation : [Vector3](../Static/Vector3.md))|none|Sets camera rotation.| -|SetVelocity(velocity : [Vector3](../Static/Vector3.md))|none|Sets camera velocity.| -|LookAt(position : [Vector3](../Static/Vector3.md))|none|Sets the camera forward direction such that it is looking at a world position.| -|SetFOV(fov : float)|none|Sets the camera field of view. Use 0 to use the default field of view.| -|SetCameraMode(mode : [String](../Static/String.md))|none|Forces the player to use a certain camera mode, taking priority over their camera setting. Accepted values are TPS, Original, FPS.| -|ResetDistance()|none|Resets the follow distance to player's settings.| -|ResetCameraMode()|none|Resets the camera mode to player's settings.| diff --git a/Assets/Docs/Static/Camera.md.meta b/Assets/Docs/Static/Camera.md.meta deleted file mode 100644 index 33582db36..000000000 --- a/Assets/Docs/Static/Camera.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 9b0a821a3702dbc4b95a0194d9f1d18e -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Static/Color.md b/Assets/Docs/Static/Color.md deleted file mode 100644 index 9af9db0c5..000000000 --- a/Assets/Docs/Static/Color.md +++ /dev/null @@ -1,15 +0,0 @@ -# Color -Inherits from object -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|R|int|False|Red component of the color| -|G|int|False|Green component of the color| -|B|int|False|Blue component of the color| -|A|int|False|Alpha component of the color| -## Methods -|Function|Returns|Description| -|---|---|---| -|ToHexString()|[String](../Static/String.md)|Converts the color to a hex string| -|Lerp(a : [Color](../Static/Color.md), b : [Color](../Static/Color.md), t : float)|[Color](../Static/Color.md)|Linearly interpolates between colors a and b by t| -|Gradient(a : [Color](../Static/Color.md), b : [Color](../Static/Color.md), t : float)|[Color](../Static/Color.md)|Creates a gradient color from two colors| diff --git a/Assets/Docs/Static/Color.md.meta b/Assets/Docs/Static/Color.md.meta deleted file mode 100644 index a9026e67d..000000000 --- a/Assets/Docs/Static/Color.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: f57f9372521b5c349a561a175ba05117 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Static/Convert.md b/Assets/Docs/Static/Convert.md deleted file mode 100644 index 085f5e3ca..000000000 --- a/Assets/Docs/Static/Convert.md +++ /dev/null @@ -1,20 +0,0 @@ -# Convert -Inherits from object -## Methods -|Function|Returns|Description| -|---|---|---| -|ToFloat(value : Object)|float|Converts a value to a float| -|ToInt(value : Object)|int|Converts a value to an int| -|ToBool(value : Object)|bool|Converts a value to a bool| -|ToString(value : Object)|[String](../Static/String.md)|Converts a value to a string| -|IsFloat(value : Object)|bool|Checks if the value is a float| -|IsInt(value : Object)|bool|Checks if the value is an int| -|IsBool(value : Object)|bool|Checks if the value is a bool| -|IsString(value : Object)|bool|Checks if the value is a string| -|IsObject(value : Object)|bool|Checks if the value is an object| -|IsList(value : Object)|bool|Checks if the value is a list| -|IsDict(value : Object)|bool|Checks if the value is a dictionary| -|HasVariable(cInstance : CustomLogicClassInstance, variableName : [String](../Static/String.md))|bool|Checks if the class instance has a variable| -|DefineVariable(cInstance : CustomLogicClassInstance, variableName : [String](../Static/String.md), value : Object)|none|Defines a variable for the class instance| -|RemoveVariable(cInstance : CustomLogicClassInstance, variableName : [String](../Static/String.md))|none|Removes a variable from the class instance| -|GetType(cInstance : CustomLogicClassInstance)|[String](../Static/String.md)|Gets the type of the class instance| diff --git a/Assets/Docs/Static/Convert.md.meta b/Assets/Docs/Static/Convert.md.meta deleted file mode 100644 index 039d4c9f2..000000000 --- a/Assets/Docs/Static/Convert.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: b435cd0cd75560c45860c58b9062d60a -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Static/Cutscene.md b/Assets/Docs/Static/Cutscene.md deleted file mode 100644 index 2ad13b192..000000000 --- a/Assets/Docs/Static/Cutscene.md +++ /dev/null @@ -1,9 +0,0 @@ -# Cutscene -Inherits from object -## Methods -|Function|Returns|Description| -|---|---|---| -|Start(name : [String](../Static/String.md), full : bool)|none|Start a cutscene| -|ShowDialogue(icon : [String](../Static/String.md), title : [String](../Static/String.md), content : [String](../Static/String.md))|none|Show a dialogue box| -|ShowDialogueForTime(icon : [String](../Static/String.md), title : [String](../Static/String.md), content : [String](../Static/String.md), time : float)|none|Show a dialogue box for a certain amount of time| -|HideDialogue()|none|Hide the dialogue box| diff --git a/Assets/Docs/Static/Cutscene.md.meta b/Assets/Docs/Static/Cutscene.md.meta deleted file mode 100644 index d2dba34cc..000000000 --- a/Assets/Docs/Static/Cutscene.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 071a2ae3c1eaf024cb77aa683ce0b498 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Static/Game.md b/Assets/Docs/Static/Game.md deleted file mode 100644 index a908d4fd7..000000000 --- a/Assets/Docs/Static/Game.md +++ /dev/null @@ -1,56 +0,0 @@ -# Game -Inherits from object -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|IsEnding|bool|False|Is the game ending?| -|EndTimeLeft|float|False|Time left until the game ends| -|Titans|[List](../Object/List.md)|False|List of all titans| -|AITitans|[List](../Object/List.md)|False|List of all AI titans| -|PlayerTitans|[List](../Object/List.md)|False|List of all player titans| -|Shifters|[List](../Object/List.md)|False|List of all shifters| -|AIShifters|[List](../Object/List.md)|False|List of all AI shifters| -|PlayerShifters|[List](../Object/List.md)|False|List of all player shifters| -|Humans|[List](../Object/List.md)|False|List of all humans| -|AIHumans|[List](../Object/List.md)|False|List of all AI humans| -|PlayerHumans|[List](../Object/List.md)|False|List of all player humans| -|Loadouts|[List](../Object/List.md)|False|List of all loadouts| -|DefaultShowKillScore|bool|False|Is the kill score shown by default?| -|DefaultHideKillScore|bool|False|Is the kill feed shown by default?| -|DefaultAddKillScore|bool|False|Is the kill score added by default?| -|ShowScoreboardLoadout|bool|False|Is the loadout shown in the scoreboard?| -|ShowScoreboardStatus|bool|False|Is the status shown in the scoreboard?| -|ForcedCharacterType|[String](../Static/String.md)|False|Forced character type| -|ForcedLoadout|[String](../Static/String.md)|False|Forced loadout| -## Methods -|Function|Returns|Description| -|---|---|---| -|Debug(message : Object)|none|Print a debug statement to the console| -|Print(message : Object)|none|Print a message to the chat| -|PrintAll(message : Object)|none|Print a message to all players| -|GetGeneralSetting(settingName : [String](../Static/String.md))|Object|Get a general setting| -|GetTitanSetting(settingName : [String](../Static/String.md))|Object|Get a titan setting| -|GetMiscSetting(settingName : [String](../Static/String.md))|Object|Get a misc setting| -|End(delay : float)|none|End the game| -|FindCharacterByViewID(viewID : int)|[Character](../Object/Character.md)|Find a character by view ID| -|SpawnTitan(type : [String](../Static/String.md))|[Titan](../Object/Titan.md)|Spawn a titan| -|SpawnTitanAt(type : [String](../Static/String.md), position : [Vector3](../Static/Vector3.md), rotationY : float = 0)|[Titan](../Object/Titan.md)|Spawn a titan at a position| -|SpawnTitans(type : [String](../Static/String.md), count : int)|[List](../Object/List.md)|Spawn titans| -|SpawnTitansAsync(type : [String](../Static/String.md), count : int)|none|Spawn titans asynchronously| -|SpawnTitansAt(type : [String](../Static/String.md), count : int, position : [Vector3](../Static/Vector3.md), rotationY : float = 0)|[List](../Object/List.md)|Spawn titans at a position| -|SpawnTitansAtAsync(type : [String](../Static/String.md), count : int, position : [Vector3](../Static/Vector3.md), rotationY : float = 0)|none|Spawn titans at a position asynchronously| -|SpawnShifter(type : [String](../Static/String.md))|[Shifter](../Object/Shifter.md)|Spawn a shifter| -|SpawnShifterAt(type : [String](../Static/String.md), position : [Vector3](../Static/Vector3.md), rotationY : float = 0)|[Shifter](../Object/Shifter.md)|Spawn a shifter at a position| -|SpawnProjectile(parameters : Object[])|none|Spawn a projectile| -|SpawnProjectileWithOwner(parameters : Object[])|none|Spawn a projectile with an owner| -|SpawnEffect(parameters : Object[])|none|Spawn an effect| -|SpawnPlayer(player : [Player](../Object/Player.md), force : bool)|none|Spawn a player| -|SpawnPlayerAll(force : bool)|none|Spawn a player for all players| -|SpawnPlayerAt(player : [Player](../Object/Player.md), force : bool, position : [Vector3](../Static/Vector3.md), rotationY : float = 0)|none|Spawn a player at a position| -|SpawnPlayerAtAll(force : bool, position : [Vector3](../Static/Vector3.md), rotationY : float = 0)|none|Spawn a player at a position for all players| -|SetPlaylist(playlist : [String](../Static/String.md))|none|Set the music playlist| -|SetSong(song : [String](../Static/String.md))|none|Set the music song| -|DrawRay(start : [Vector3](../Static/Vector3.md), dir : [Vector3](../Static/Vector3.md), color : [Color](../Static/Color.md), duration : float)|none|Draw a ray| -|ShowKillScore(damage : int)|none|Show the kill score| -|ShowKillFeed(killer : [String](../Static/String.md), victim : [String](../Static/String.md), score : int, weapon : [String](../Static/String.md))|none|Show the kill feed| -|ShowKillFeedAll(killer : [String](../Static/String.md), victim : [String](../Static/String.md), score : int, weapon : [String](../Static/String.md))|none|Show the kill feed for all players| diff --git a/Assets/Docs/Static/Game.md.meta b/Assets/Docs/Static/Game.md.meta deleted file mode 100644 index 8c2e493b3..000000000 --- a/Assets/Docs/Static/Game.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: fcf2dbe3662c0364e8ccef7b48ddab18 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Static/Input.md b/Assets/Docs/Static/Input.md deleted file mode 100644 index 2f24dff1e..000000000 --- a/Assets/Docs/Static/Input.md +++ /dev/null @@ -1,16 +0,0 @@ -# Input -Inherits from object -## Methods -|Function|Returns|Description| -|---|---|---| -|GetKeyName(key : [String](../Static/String.md))|[String](../Static/String.md)|Gets the key name the player assigned to the key setting| -|GetKeyHold(key : [String](../Static/String.md))|bool|Returns true if the key is being held down| -|GetKeyDown(key : [String](../Static/String.md))|bool|Returns true if the key was pressed down this frame| -|GetKeyUp(key : [String](../Static/String.md))|bool|Returns true if the key was released this frame| -|GetMouseAim()|[Vector3](../Static/Vector3.md)|Returns the position the player is aiming at| -|GetCursorAimDirection()|[Vector3](../Static/Vector3.md)|Returns the ray the player is aiming at| -|GetMouseSpeed()|[Vector3](../Static/Vector3.md)|Returns the speed of the mouse| -|GetMousePosition()|[Vector3](../Static/Vector3.md)|Returns the position of the mouse| -|GetScreenDimensions()|[Vector3](../Static/Vector3.md)|Returns the dimensions of the screen| -|SetKeyDefaultEnabled(key : [String](../Static/String.md), enabled : bool)|none|Sets whether the key is enabled by default| -|SetKeyHold(key : [String](../Static/String.md), enabled : bool)|none|Sets whether the key is being held down| diff --git a/Assets/Docs/Static/Input.md.meta b/Assets/Docs/Static/Input.md.meta deleted file mode 100644 index 1f83e3ca2..000000000 --- a/Assets/Docs/Static/Input.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: d60bd27d07f9bb149b74e65e2c0fa1a4 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Static/Json.md b/Assets/Docs/Static/Json.md deleted file mode 100644 index 881235928..000000000 --- a/Assets/Docs/Static/Json.md +++ /dev/null @@ -1,7 +0,0 @@ -# Json -Inherits from object -## Methods -|Function|Returns|Description| -|---|---|---| -|LoadFromString(json : [String](../Static/String.md))|Object|Loads a json string into a custom logic object| -|SaveToString(obj : Object)|[String](../Static/String.md)|Saves a custom logic object into a json string| diff --git a/Assets/Docs/Static/Json.md.meta b/Assets/Docs/Static/Json.md.meta deleted file mode 100644 index 604bd7521..000000000 --- a/Assets/Docs/Static/Json.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 7767b6f84e6225547a5319b11f266636 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Static/LineRenderer.md b/Assets/Docs/Static/LineRenderer.md deleted file mode 100644 index 21800d440..000000000 --- a/Assets/Docs/Static/LineRenderer.md +++ /dev/null @@ -1,29 +0,0 @@ -# LineRenderer -Inherits from object -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|StartWidth|float|False|The width of the line at the start| -|EndWidth|float|False|The width of the line at the end| -|LineColor|[Color](../Static/Color.md)|False|The color of the line| -|PositionCount|int|False|The number of points in the line| -|Enabled|bool|False|Is the line renderer enabled| -|Loop|bool|False|Is the line renderer a loop| -|NumCornerVertices|int|False|The number of corner vertices| -|NumCapVertices|int|False|The number of end cap vertices| -|Alignment|[String](../Static/String.md)|False|The alignment of the line renderer| -|TextureMode|[String](../Static/String.md)|False|The texture mode of the line renderer| -|UseWorldSpace|bool|False|Is the line renderer in world space| -|ShadowCastingMode|[String](../Static/String.md)|False|Does the line renderer cast shadows| -|ReceiveShadows|bool|False|Does the line renderer receive shadows| -|ColorGradient|[List](../Object/List.md)|False|The gradient of the line renderer| -|AlphaGradient|[List](../Object/List.md)|False|The alpha gradient of the line renderer| -|WidthCurve|[List](../Object/List.md)|False|The width curve of the line renderer| -|WidthMultiplier|float|False|The width multiplier of the line renderer| -|ColorGradientMode|[String](../Static/String.md)|False|The color gradient mode of the line renderer| -## Methods -|Function|Returns|Description| -|---|---|---| -|CreateLineRenderer()|[LineRenderer](../Static/LineRenderer.md)|[Obselete] Create a new LineRenderer| -|GetPosition(index : int)|[Vector3](../Static/Vector3.md)|Get the position of a point in the line renderer| -|SetPosition(index : int, position : [Vector3](../Static/Vector3.md))|none|Set the position of a point in the line renderer| diff --git a/Assets/Docs/Static/LineRenderer.md.meta b/Assets/Docs/Static/LineRenderer.md.meta deleted file mode 100644 index f3d2924a8..000000000 --- a/Assets/Docs/Static/LineRenderer.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 14e87bd25f1843440911aa7d3335c91c -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Static/Map.md b/Assets/Docs/Static/Map.md deleted file mode 100644 index 4885b2271..000000000 --- a/Assets/Docs/Static/Map.md +++ /dev/null @@ -1,19 +0,0 @@ -# Map -Inherits from object -## Methods -|Function|Returns|Description| -|---|---|---| -|FindAllMapObjects()|[List](../Object/List.md)|Find all map objects| -|FindMapObjectByName(objectName : [String](../Static/String.md))|[MapObject](../Object/MapObject.md)|Find a map object by name| -|FindMapObjectsByName(objectName : [String](../Static/String.md))|[List](../Object/List.md)|Find all map objects by name| -|FindMapObjectByComponent(className : [String](../Static/String.md))|[MapObject](../Object/MapObject.md)|Find all map objects by component| -|FindMapObjectsByComponent(className : [String](../Static/String.md))|[List](../Object/List.md)|Find all map objects by component| -|FindMapObjectByID(id : int)|[MapObject](../Object/MapObject.md)|Find a map object by ID| -|FindMapObjectByTag(tag : [String](../Static/String.md))|[MapObject](../Object/MapObject.md)|Find a map object by tag| -|FindMapObjectsByTag(tag : [String](../Static/String.md))|[List](../Object/List.md)|Find all map objects by tag| -|CreateMapObjectRaw(prefab : [String](../Static/String.md))|[MapObject](../Object/MapObject.md)|Create a new map object| -|DestroyMapObject(mapObject : [MapObject](../Object/MapObject.md), includeChildren : bool)|none|Destroy a map object| -|CopyMapObject(mapObject : [MapObject](../Object/MapObject.md), includeChildren : bool)|[MapObject](../Object/MapObject.md)|Copy a map object| -|DestroyMapTargetable(targetable : [MapTargetable](../Object/MapTargetable.md))|none|Destroy a map targetable| -|UpdateNavMesh()|none|Update the nav mesh| -|UpdateNavMeshAsync()|none|Update the nav mesh asynchronously| diff --git a/Assets/Docs/Static/Map.md.meta b/Assets/Docs/Static/Map.md.meta deleted file mode 100644 index c5cdaca7e..000000000 --- a/Assets/Docs/Static/Map.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 7866b2133c935a94a876afd395426d64 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Static/Math.md b/Assets/Docs/Static/Math.md deleted file mode 100644 index b9efd6fa7..000000000 --- a/Assets/Docs/Static/Math.md +++ /dev/null @@ -1,52 +0,0 @@ -# Math -Inherits from object -## Static Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|PI|float|False|The value of PI| -|Infinity|float|False|The value of Infinity| -|NegativeInfinity|float|False|The value of Negative Infinity| -|Rad2DegConstant|float|False|The value of Rad2Deg constant| -|Deg2RadConstant|float|False|The value of Deg2Rad constant| -|Epsilon|float|False|The value of Epsilon| -## Methods -|Function|Returns|Description| -|---|---|---| -|Clamp(value : Object, min : Object, max : Object)|Object|Clamp a value between a minimum and maximum value| -|Max(a : Object, b : Object)|Object|Get the maximum of two values| -|Min(a : Object, b : Object)|Object|Get the minimum of two values| -|Pow(a : Object, b : Object)|Object|Raise a value to the power of another value| -|Abs(value : Object)|Object|Get the absolute value of a number| -|Sqrt(value : Object)|Object|Get the square root of a number| -|Mod(a : Object, b : Object)|Object|Get the remainder of a division operation| -|Sin(angle : Object)|Object|Get the sine of an angle in degrees| -|Cos(angle : Object)|Object|Get the cosine of an angle in degrees| -|Tan(angle : Object)|Object|Get the tangent of an angle in degrees| -|Asin(value : Object)|Object|Get the arcsine of a value in degrees| -|Acos(value : Object)|Object|Get the arccosine of a value in degrees| -|Atan(value : Object)|Object|Get the arctangent of a value in degrees| -|Atan2(a : Object, b : Object)|Object|Get the arctangent of a value in degrees| -|Ceil(value : Object)|Object|Get the smallest integer greater than or equal to a value| -|Floor(value : Object)|Object|Get the largest integer less than or equal to a value| -|Round(value : Object)|Object|Round a value to the nearest integer| -|Deg2Rad(angle : Object)|Object|Convert an angle from degrees to radians| -|Rad2Deg(angle : Object)|Object|Convert an angle from radians to degrees| -|Lerp(a : Object, b : Object, t : Object)|Object|Linearly interpolate between two values| -|LerpUnclamped(a : Object, b : Object, t : Object)|Object|Linearly interpolate between two values without clamping| -|Sign(value : Object)|Object|Get the sign of a value| -|InverseLerp(a : Object, b : Object, value : Object)|Object|Get the inverse lerp of two values| -|LerpAngle(a : Object, b : Object, t : Object)|Object|Linearly interpolate between two angles| -|Log(value : Object)|Object|Get the natural logarithm of a value| -|MoveTowards(current : Object, target : Object, maxDelta : Object)|Object|Move a value towards a target value| -|MoveTowardsAngle(current : Object, target : Object, maxDelta : Object)|Object|Move an angle towards a target angle| -|PingPong(t : Object, length : Object)|Object|Get the ping pong value of a time value| -|SmoothDamp(current : Object, target : Object, currentVelocity : Object, smoothTime : Object, maxSpeed : Object, deltaTime : Object)|Object|Smoothly damp a value towards a target value| -|Exp(value : Object)|Object|Get the exponential value of a number| -|SmoothDampAngle(current : Object, target : Object, currentVelocity : Object, smoothTime : Object, maxSpeed : Object, deltaTime : Object)|Object|Smoothly damp an angle towards a target angle| -|SmoothStep(a : Object, b : Object, t : Object)|Object|Smoothly step between two values| -|BitwiseAnd(a : Object, b : Object)|Object|Perform a bitwise AND operation| -|BitwiseOr(a : Object, b : Object)|Object|Perform a bitwise OR operation| -|BitwiseXor(a : Object, b : Object)|Object|Perform a bitwise XOR operation| -|BitwiseNot(value : Object)|Object|Perform a bitwise NOT operation| -|BitwiseLeftShift(value : Object, shift : Object)|Object|Shift bits to the left| -|BitwiseRightShift(value : Object, shift : Object)|Object|Shift bits to the right| diff --git a/Assets/Docs/Static/Math.md.meta b/Assets/Docs/Static/Math.md.meta deleted file mode 100644 index 99ebb0cd9..000000000 --- a/Assets/Docs/Static/Math.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 2e6c4c5837bc96448a07828ae0c6359c -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Static/Network.md b/Assets/Docs/Static/Network.md deleted file mode 100644 index b9c8692c2..000000000 --- a/Assets/Docs/Static/Network.md +++ /dev/null @@ -1,19 +0,0 @@ -# Network -Inherits from object -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|IsMasterClient|bool|False|Is the player the master client| -|Players|[List](../Object/List.md)|False|The list of players in the room| -|MasterClient|[Player](../Object/Player.md)|False|The master client| -|MyPlayer|[Player](../Object/Player.md)|False|The local player| -|NetworkTime|double|False|The network time| -|Ping|int|False|The local player's ping| -## Methods -|Function|Returns|Description| -|---|---|---| -|SendMessage(player : [Player](../Object/Player.md), message : [String](../Static/String.md))|none|Send a message to a player| -|SendMessageAll(message : [String](../Static/String.md))|none|Send a message to all players| -|SendMessageOthers(message : [String](../Static/String.md))|none|Send a message to all players except the sender| -|GetTimestampDifference(timestamp1 : double, timestamp2 : double)|double|Get the difference between two photon timestamps| -|KickPlayer(target : Object, reason : [String](../Static/String.md) = .)|none|Kick the given player by id or player reference.| diff --git a/Assets/Docs/Static/Network.md.meta b/Assets/Docs/Static/Network.md.meta deleted file mode 100644 index 5b5475846..000000000 --- a/Assets/Docs/Static/Network.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 37dc7beaa31705f43815ab92667b2ed8 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Static/PersistentData.md b/Assets/Docs/Static/PersistentData.md deleted file mode 100644 index ea31bf92c..000000000 --- a/Assets/Docs/Static/PersistentData.md +++ /dev/null @@ -1,12 +0,0 @@ -# PersistentData -Inherits from object -## Methods -|Function|Returns|Description| -|---|---|---| -|SetProperty(property : [String](../Static/String.md), value : Object)|none|Sets the property with given name to the object value. Valid value types are float, string, bool, and int.| -|GetProperty(property : [String](../Static/String.md), defaultValue : Object)|Object|Gets the property with given name. If property does not exist, returns defaultValue.| -|LoadFromFile(fileName : [String](../Static/String.md), encrypted : bool)|none|Loads persistent data from given file name. If encrypted is true, will treat the file as having been saved as encrypted.| -|SaveToFile(fileName : [String](../Static/String.md), encrypted : bool)|none|Saves current persistent data to given file name. If encrypted is true, will also encrypt the file instead of using plaintext.| -|Clear()|none|Clears current persistent data.| -|IsValidFileName(fileName : [String](../Static/String.md))|bool|Determines whether or not the given fileName will be allowed for use when saving/loading a file.| -|FileExists(fileName : [String](../Static/String.md))|bool|Determines whether the file given already exists. Throws an error if given an invalid file name.| diff --git a/Assets/Docs/Static/PersistentData.md.meta b/Assets/Docs/Static/PersistentData.md.meta deleted file mode 100644 index 0cb48c44d..000000000 --- a/Assets/Docs/Static/PersistentData.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 62c9002128c5f9e4ca20d82630ea2006 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Static/Physics.md b/Assets/Docs/Static/Physics.md deleted file mode 100644 index bc22b5c61..000000000 --- a/Assets/Docs/Static/Physics.md +++ /dev/null @@ -1,7 +0,0 @@ -# Physics -Inherits from object -## Methods -|Function|Returns|Description| -|---|---|---| -|LineCast(start : [Vector3](../Static/Vector3.md), end : [Vector3](../Static/Vector3.md), collideWith : [String](../Static/String.md))|Object|Performs a line cast between two points.| -|SphereCast(start : [Vector3](../Static/Vector3.md), end : [Vector3](../Static/Vector3.md), radius : float, collideWith : [String](../Static/String.md))|Object|Performs a sphere cast between two points.| diff --git a/Assets/Docs/Static/Physics.md.meta b/Assets/Docs/Static/Physics.md.meta deleted file mode 100644 index d4777eb56..000000000 --- a/Assets/Docs/Static/Physics.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 777b698fcb22f5c4e9128273e1c9ff5c -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Static/Quaternion.md b/Assets/Docs/Static/Quaternion.md deleted file mode 100644 index 596767673..000000000 --- a/Assets/Docs/Static/Quaternion.md +++ /dev/null @@ -1,33 +0,0 @@ -# Quaternion -Inherits from object -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|X|float|False|X component of the Quaternion. Don't modify this directly unless you know quaternions inside out.| -|Y|float|False|Y component of the Quaternion. Don't modify this directly unless you know quaternions inside out.| -|Z|float|False|Z component of the Quaternion. Don't modify this directly unless you know quaternions inside out.| -|W|float|False|W component of the Quaternion. Do not directly modify quaternions.| -|Euler|[Vector3](../Static/Vector3.md)|False|Returns or sets the euler angle representation of the rotation.| -## Static Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Identity|[Quaternion](../Static/Quaternion.md)|False|The identity rotation (Read Only).| -## Methods -|Function|Returns|Description| -|---|---|---| -|Lerp(a : [Quaternion](../Static/Quaternion.md), b : [Quaternion](../Static/Quaternion.md), t : float)|[Quaternion](../Static/Quaternion.md)|Interpolates between a and b by t and normalizes the result afterwards.| -|LerpUnclamped(a : [Quaternion](../Static/Quaternion.md), b : [Quaternion](../Static/Quaternion.md), t : float)|[Quaternion](../Static/Quaternion.md)|Interpolates between a and b by t and normalizes the result afterwards. The parameter t is not clamped.| -|Slerp(a : [Quaternion](../Static/Quaternion.md), b : [Quaternion](../Static/Quaternion.md), t : float)|[Quaternion](../Static/Quaternion.md)|Spherically linear interpolates between unit quaternions a and b by a ratio of t.| -|SlerpUnclamped(a : [Quaternion](../Static/Quaternion.md), b : [Quaternion](../Static/Quaternion.md), t : float)|[Quaternion](../Static/Quaternion.md)|Spherically linear interpolates between unit quaternions a and b by t.| -|FromEuler(euler : [Vector3](../Static/Vector3.md))|[Quaternion](../Static/Quaternion.md)|Returns the Quaternion rotation from the given euler angles.| -|LookRotation(forward : [Vector3](../Static/Vector3.md), upwards : [Vector3](../Static/Vector3.md) = )|[Quaternion](../Static/Quaternion.md)|Creates a rotation with the specified forward and upwards directions.| -|FromToRotation(a : [Vector3](../Static/Vector3.md), b : [Vector3](../Static/Vector3.md))|[Quaternion](../Static/Quaternion.md)|Creates a rotation from fromDirection to toDirection.| -|Inverse(q : [Quaternion](../Static/Quaternion.md))|[Quaternion](../Static/Quaternion.md)|Returns the Inverse of rotation.| -|RotateTowards(from : [Quaternion](../Static/Quaternion.md), to : [Quaternion](../Static/Quaternion.md), maxDegreesDelta : float)|[Quaternion](../Static/Quaternion.md)|Rotates a rotation from towards to.| -|\_\_Copy\_\_()|Object|Override to deepcopy object on assignment, used for structs. Ex: copy = original is equivalent to copy = original.\_\_Copy\_\_()| -|\_\_Add\_\_(self : Object, other : Object)|Object|Override to implement addition, used for + operator. Ex: a + b is equivalent to a.\_\_Add\_\_(a, b)| -|\_\_Sub\_\_(self : Object, other : Object)|Object|Override to implement subtraction, used for - operator. Ex: a - b is equivalent to a.\_\_Sub\_\_(a, b)| -|\_\_Mul\_\_(self : Object, other : Object)|Object|Override to implement multiplication, used for * operator. Ex: a * b is equivalent to a.\_\_Mul\_\_(a, b)| -|\_\_Div\_\_(self : Object, other : Object)|Object|Override to implement division, used for / operator. Ex: a / b is equivalent to a.\_\_Div\_\_(a, b)| -|\_\_Eq\_\_(self : Object, other : Object)|bool|Override to implement equality comparison, used for == and != operators. Ex: a == b is equivalent to a.\_\_Eq\_\_(a, b)| -|\_\_Hash\_\_()|int|Override to implement hashing, used for GetHashCode - Used for Dictionaries/Sets. Ex: hash = obj.GetHashCode() is equivalent to hash = obj.\_\_Hash\_\_()| diff --git a/Assets/Docs/Static/Quaternion.md.meta b/Assets/Docs/Static/Quaternion.md.meta deleted file mode 100644 index 327be8be5..000000000 --- a/Assets/Docs/Static/Quaternion.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: d017d389e4e4d8f45ababe87ab093305 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Static/Random.md b/Assets/Docs/Static/Random.md deleted file mode 100644 index b7c0f8f0c..000000000 --- a/Assets/Docs/Static/Random.md +++ /dev/null @@ -1,12 +0,0 @@ -# Random -Inherits from object -## Methods -|Function|Returns|Description| -|---|---|---| -|RandomInt(min : int, max : int)|int|Generates a random integer between the specified range.| -|RandomFloat(min : float, max : float)|float|Generates a random float between the specified range.| -|RandomBool()|bool|Returns random boolean.| -|RandomVector3(a : [Vector3](../Static/Vector3.md), b : [Vector3](../Static/Vector3.md))|[Vector3](../Static/Vector3.md)|Generates a random Vector3 between the specified ranges.| -|RandomDirection(flat : bool = False)|[Vector3](../Static/Vector3.md)|Generates a random normalized direction vector. If flat is true, the y component will be zero.| -|RandomSign()|int|Generates a random sign, either 1 or -1.| -|PerlinNoise(x : float, y : float)|float|Returns a point sampled from generated 2d perlin noise. (see Unity Mathf.PerlinNoise for more information)| diff --git a/Assets/Docs/Static/Random.md.meta b/Assets/Docs/Static/Random.md.meta deleted file mode 100644 index 8d1c274bc..000000000 --- a/Assets/Docs/Static/Random.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 3029902b259029c479682165353b9e35 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Static/RoomData.md b/Assets/Docs/Static/RoomData.md deleted file mode 100644 index 2c1ad4abc..000000000 --- a/Assets/Docs/Static/RoomData.md +++ /dev/null @@ -1,8 +0,0 @@ -# RoomData -Inherits from object -## Methods -|Function|Returns|Description| -|---|---|---| -|SetProperty(property : [String](../Static/String.md), value : Object)|none|Sets the property with given name to the object value. Valid value types are float, string, bool, and int.| -|GetProperty(property : [String](../Static/String.md), defaultValue : Object)|Object|Gets the property with given name. If property does not exist, returns defaultValue.| -|Clear()|none|Clears all room data.| diff --git a/Assets/Docs/Static/RoomData.md.meta b/Assets/Docs/Static/RoomData.md.meta deleted file mode 100644 index 8b2044d0e..000000000 --- a/Assets/Docs/Static/RoomData.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: c72e78ebaecf7804c85a5bc8bfe16a76 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Static/String.md b/Assets/Docs/Static/String.md deleted file mode 100644 index e90741485..000000000 --- a/Assets/Docs/Static/String.md +++ /dev/null @@ -1,26 +0,0 @@ -# String -Inherits from object -## Static Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Newline|[String](../Static/String.md)|False|Returns the newline character.| -## Methods -|Function|Returns|Description| -|---|---|---| -|FormatFloat(val : float, decimals : int)|[String](../Static/String.md)|Formats a float to a string with the specified number of decimal places.| -|FormatFromList(str : [String](../Static/String.md), list : [List](../Object/List.md))|[String](../Static/String.md)|Equivalent to C# string.format(string, List).| -|Split(toSplit : [String](../Static/String.md), splitter : Object, removeEmptyEntries : bool = False)|[List](../Object/List.md)|Split the string into a list. Can pass in either a string to split on or a list of strings to split on, the last optional param can remove all empty entries.| -|Join(list : [List](../Object/List.md), separator : [String](../Static/String.md))|[String](../Static/String.md)|Joins a list of strings into a single string with the specified separator.| -|Substring(str : [String](../Static/String.md), startIndex : int)|[String](../Static/String.md)|Returns a substring starting from the specified index.| -|SubstringWithLength(str : [String](../Static/String.md), startIndex : int, length : int)|[String](../Static/String.md)|Returns a substring of the specified length starting from the specified start index.| -|Length(str : [String](../Static/String.md))|int|Length of the string.| -|Replace(str : [String](../Static/String.md), replace : [String](../Static/String.md), with : [String](../Static/String.md))|[String](../Static/String.md)|Replaces all occurrences of a substring with another substring.| -|Contains(str : [String](../Static/String.md), match : [String](../Static/String.md))|bool|Checks if the string contains the specified substring.| -|StartsWith(str : [String](../Static/String.md), match : [String](../Static/String.md))|bool|Checks if the string starts with the specified substring.| -|EndsWith(str : [String](../Static/String.md), match : [String](../Static/String.md))|bool|Checks if the string ends with the specified substring.| -|Trim(str : [String](../Static/String.md))|[String](../Static/String.md)|Trims whitespace from the start and end of the string.| -|Insert(str : [String](../Static/String.md), insert : [String](../Static/String.md), index : int)|[String](../Static/String.md)|Inserts a substring at the specified index.| -|Capitalize(str : [String](../Static/String.md))|[String](../Static/String.md)|Capitalizes the first letter of the string.| -|ToUpper(str : [String](../Static/String.md))|[String](../Static/String.md)|Converts the string to uppercase.| -|ToLower(str : [String](../Static/String.md))|[String](../Static/String.md)|Converts the string to lowercase.| -|IndexOf(str : [String](../Static/String.md), substring : [String](../Static/String.md))|int|Returns the index of the given string.| diff --git a/Assets/Docs/Static/String.md.meta b/Assets/Docs/Static/String.md.meta deleted file mode 100644 index 081065c8e..000000000 --- a/Assets/Docs/Static/String.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 5f663793e088e85419f66dfa770fc035 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Static/Time.md b/Assets/Docs/Static/Time.md deleted file mode 100644 index 764e9a19c..000000000 --- a/Assets/Docs/Static/Time.md +++ /dev/null @@ -1,9 +0,0 @@ -# Time -Inherits from object -## Static Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|TickTime|float|False|Time between each tick (0.02 seconds)| -|FrameTime|float|False|Time between each frame.| -|GameTime|float|False|Time since start of the round.| -|TimeScale|float|False|Changes the timescale of the game.| diff --git a/Assets/Docs/Static/Time.md.meta b/Assets/Docs/Static/Time.md.meta deleted file mode 100644 index 54e1f53cf..000000000 --- a/Assets/Docs/Static/Time.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: b5c0cb264e5ab4d42bb118d66da8bfef -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Static/UI.md b/Assets/Docs/Static/UI.md deleted file mode 100644 index d168e4146..000000000 --- a/Assets/Docs/Static/UI.md +++ /dev/null @@ -1,41 +0,0 @@ -# UI -Inherits from object -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Popups|[List](../Object/List.md)|False|Returns a list of all popups| -## Static Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|TopCenter|[String](../Static/String.md)|False|"TopCenter" constant| -|TopLeft|[String](../Static/String.md)|False|"TopLeft" constant| -|TopRight|[String](../Static/String.md)|False|"TopRight" constant| -|MiddleCenter|[String](../Static/String.md)|False|"MiddleCenter" constant| -|MiddleLeft|[String](../Static/String.md)|False|"MiddleLeft" constant| -|MiddleRight|[String](../Static/String.md)|False|"MiddleRight" constant| -|BottomCenter|[String](../Static/String.md)|False|"BottomCenter" constant| -|BottomLeft|[String](../Static/String.md)|False|"BottomLeft" constant| -|BottomRight|[String](../Static/String.md)|False|"BottomRight" constant| -## Methods -|Function|Returns|Description| -|---|---|---| -|SetLabel(label : [String](../Static/String.md), message : [String](../Static/String.md))|none|Sets the label at a certain location. Valid types: "TopCenter", "TopLeft", "TopRight", "MiddleCenter", "MiddleLeft", "MiddleRight", "BottomLeft", "BottomRight", "BottomCenter".| -|SetLabelForTime(label : [String](../Static/String.md), message : [String](../Static/String.md), time : float)|none|Sets the label for a certain time, after which it will be cleared.| -|SetLabelAll(label : [String](../Static/String.md), message : [String](../Static/String.md))|none|Sets the label for all players. Master client only. Be careful not to call this often.| -|SetLabelForTimeAll(label : [String](../Static/String.md), message : [String](../Static/String.md), time : float)|none|Sets the label for all players for a certain time. Master client only.| -|CreatePopup(popupName : [String](../Static/String.md), title : [String](../Static/String.md), width : int, height : int)|[String](../Static/String.md)|Creates a new popup. This popup is hidden until shown.| -|ShowPopup(popupName : [String](../Static/String.md))|none|Shows the popup with given name.| -|HidePopup(popupName : [String](../Static/String.md))|none|Hides the popup with given name.| -|ClearPopup(popupName : [String](../Static/String.md))|none|Clears all elements in popup with given name.| -|AddPopupLabel(popupName : [String](../Static/String.md), label : [String](../Static/String.md))|none|Adds a text row to the popup with label as content.| -|AddPopupButton(popupName : [String](../Static/String.md), label : [String](../Static/String.md), callback : [String](../Static/String.md))|none|Adds a button row to the popup with given button name and display text. When button is pressed, OnButtonClick is called in Main with buttonName parameter.| -|AddPopupBottomButton(popupName : [String](../Static/String.md), label : [String](../Static/String.md), callback : [String](../Static/String.md))|none|Adds a button to the bottom bar of the popup.| -|AddPopupButtons(popupName : [String](../Static/String.md), labels : [List](../Object/List.md), callbacks : [List](../Object/List.md))|none|Adds a list of buttons in a row to the popup.| -|WrapStyleTag(text : [String](../Static/String.md), style : [String](../Static/String.md), arg : [String](../Static/String.md) = )|[String](../Static/String.md)|Returns a wrapped string given style and args.| -|GetLocale(cat : [String](../Static/String.md), sub : [String](../Static/String.md), key : [String](../Static/String.md))|[String](../Static/String.md)|Gets translated locale from the current Language.json file with given category, subcategory, and key pattern.| -|GetLanguage()|[String](../Static/String.md)|Returns the current language (e.g. "English" or "简体中文").| -|ShowChangeCharacterMenu()|none|Shows the change character menu if main character is Human.| -|SetScoreboardHeader(header : [String](../Static/String.md))|none|Sets the display of the scoreboard header (default "Kills / Deaths...")| -|SetScoreboardProperty(property : [String](../Static/String.md))|none|Sets which Player custom property to read from to display on the scoreboard. If set to empty string, will use the default "Kills / Deaths..." display.| -|GetThemeColor(panel : [String](../Static/String.md), category : [String](../Static/String.md), item : [String](../Static/String.md))|[Color](../Static/Color.md)|Gets the color of the specified item. See theme json for reference.| -|IsPopupActive(popupName : [String](../Static/String.md))|bool|Returns if the given popup is active| diff --git a/Assets/Docs/Static/UI.md.meta b/Assets/Docs/Static/UI.md.meta deleted file mode 100644 index 61f746d42..000000000 --- a/Assets/Docs/Static/UI.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: fa675e87b83b40441b54332833e890f1 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Static/Vector2.md b/Assets/Docs/Static/Vector2.md deleted file mode 100644 index 310668df1..000000000 --- a/Assets/Docs/Static/Vector2.md +++ /dev/null @@ -1,45 +0,0 @@ -# Vector2 -Inherits from object -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|X|float|False|X component of the vector.| -|Y|float|False|Y component of the vector.| -|Normalized|[Vector2](../Static/Vector2.md)|False|Returns this vector with a magnitude of 1 (Read Only).| -|Magnitude|float|False|Returns the length of this vector (Read Only).| -|SqrMagnitude|float|False|Returns the squared length of this vector (Read Only).| -## Static Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Zero|[Vector2](../Static/Vector2.md)|False|Shorthand for writing Vector2(0, 0).| -|One|[Vector2](../Static/Vector2.md)|False|Shorthand for writing Vector2(1, 1).| -|Up|[Vector2](../Static/Vector2.md)|False|Shorthand for writing Vector2(0, 1).| -|Down|[Vector2](../Static/Vector2.md)|False|Shorthand for writing Vector2(0, -1).| -|Left|[Vector2](../Static/Vector2.md)|False|Shorthand for writing Vector2(-1, 0).| -|Right|[Vector2](../Static/Vector2.md)|False|Shorthand for writing Vector2(1, 0).| -|NegativeInfinity|[Vector2](../Static/Vector2.md)|False|Shorthand for writing Vector2(float.PositiveInfinity, float.PositiveInfinity).| -|PositiveInfinity|[Vector2](../Static/Vector2.md)|False|Shorthand for writing Vector2(float.PositiveInfinity, float.PositiveInfinity).| -## Methods -|Function|Returns|Description| -|---|---|---| -|Angle(from : [Vector2](../Static/Vector2.md), to : [Vector2](../Static/Vector2.md))|float|Gets the unsigned angle in degrees between from and to.| -|ClampMagnitude(vector : [Vector2](../Static/Vector2.md), maxLength : float)|[Vector2](../Static/Vector2.md)|Returns a copy of vector with its magnitude clamped to maxLength.| -|Distance(a : [Vector2](../Static/Vector2.md), b : [Vector2](../Static/Vector2.md))|float|Returns the distance between a and b.| -|Dot(a : [Vector2](../Static/Vector2.md), b : [Vector2](../Static/Vector2.md))|float|Dot Product of two vectors.| -|Lerp(a : [Vector2](../Static/Vector2.md), b : [Vector2](../Static/Vector2.md), t : float)|[Vector2](../Static/Vector2.md)|Linearly interpolates between vectors a and b by t.| -|LerpUnclamped(a : [Vector2](../Static/Vector2.md), b : [Vector2](../Static/Vector2.md), t : float)|[Vector2](../Static/Vector2.md)|Linearly interpolates between vectors a and b by t.| -|Max(a : [Vector2](../Static/Vector2.md), b : [Vector2](../Static/Vector2.md))|[Vector2](../Static/Vector2.md)|Returns a vector that is made from the largest components of two vectors.| -|Min(a : [Vector2](../Static/Vector2.md), b : [Vector2](../Static/Vector2.md))|[Vector2](../Static/Vector2.md)|Returns a vector that is made from the smallest components of two vectors.| -|MoveTowards(current : [Vector2](../Static/Vector2.md), target : [Vector2](../Static/Vector2.md), maxDistanceDelta : float)|[Vector2](../Static/Vector2.md)|Moves a point current towards target.| -|Reflect(inDirection : [Vector2](../Static/Vector2.md), inNormal : [Vector2](../Static/Vector2.md))|[Vector2](../Static/Vector2.md)|Reflects a vector off the vector defined by a normal.| -|SignedAngle(from : [Vector2](../Static/Vector2.md), to : [Vector2](../Static/Vector2.md))|float|Gets the signed angle in degrees between from and to.| -|SmoothDamp(current : [Vector2](../Static/Vector2.md), target : [Vector2](../Static/Vector2.md), currentVelocity : [Vector2](../Static/Vector2.md), smoothTime : float, maxSpeed : float)|[Vector2](../Static/Vector2.md)|| -|Set(x : float, y : float)|none|Set x and y components of an existing Vector2.| -|Normalize()|none|Makes this vector have a magnitude of 1.| -|\_\_Copy\_\_()|Object|Override to deepcopy object on assignment, used for structs. Ex: copy = original is equivalent to copy = original.\_\_Copy\_\_()| -|\_\_Add\_\_(self : Object, other : Object)|Object|Override to implement addition, used for + operator. Ex: a + b is equivalent to a.\_\_Add\_\_(a, b)| -|\_\_Sub\_\_(self : Object, other : Object)|Object|Override to implement subtraction, used for - operator. Ex: a - b is equivalent to a.\_\_Sub\_\_(a, b)| -|\_\_Mul\_\_(self : Object, other : Object)|Object|Override to implement multiplication, used for * operator. Ex: a * b is equivalent to a.\_\_Mul\_\_(a, b)| -|\_\_Div\_\_(self : Object, other : Object)|Object|Override to implement division, used for / operator. Ex: a / b is equivalent to a.\_\_Div\_\_(a, b)| -|\_\_Eq\_\_(self : Object, other : Object)|bool|Override to implement equality comparison, used for == and != operators. Ex: a == b is equivalent to a.\_\_Eq\_\_(a, b)| -|\_\_Hash\_\_()|int|Override to implement hashing, used for GetHashCode - Used for Dictionaries/Sets. Ex: hash = obj.GetHashCode() is equivalent to hash = obj.\_\_Hash\_\_()| diff --git a/Assets/Docs/Static/Vector2.md.meta b/Assets/Docs/Static/Vector2.md.meta deleted file mode 100644 index a200ebaef..000000000 --- a/Assets/Docs/Static/Vector2.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: d8afe8e403a94bf4e997e82d062587e8 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/Static/Vector3.md b/Assets/Docs/Static/Vector3.md deleted file mode 100644 index b89b27d40..000000000 --- a/Assets/Docs/Static/Vector3.md +++ /dev/null @@ -1,59 +0,0 @@ -# Vector3 -Inherits from object -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|X|float|False|X component of the vector.| -|Y|float|False|Y component of the vector.| -|Z|float|False|Z component of the vector.| -|Normalized|[Vector3](../Static/Vector3.md)|False|Returns this vector with a magnitude of 1 (Read Only).| -|Magnitude|float|False|Returns the length of this vector (Read Only).| -|SqrMagnitude|float|False|Returns the squared length of this vector (Read Only).| -## Static Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Zero|[Vector3](../Static/Vector3.md)|False|Shorthand for writing Vector3(0, 0, 0).| -|One|[Vector3](../Static/Vector3.md)|False|Shorthand for writing Vector3(1, 1, 1).| -|Up|[Vector3](../Static/Vector3.md)|False|Shorthand for writing Vector3(0, 1, 0).| -|Down|[Vector3](../Static/Vector3.md)|False|Shorthand for writing Vector3(0, -1, 0).| -|Left|[Vector3](../Static/Vector3.md)|False|Shorthand for writing Vector3(-1, 0, 0).| -|Right|[Vector3](../Static/Vector3.md)|False|Shorthand for writing Vector3(1, 0, 0).| -|Forward|[Vector3](../Static/Vector3.md)|False|Shorthand for writing Vector3(0, 0, 1).| -|Back|[Vector3](../Static/Vector3.md)|False|Shorthand for writing Vector3(0, 0, -1).| -|NegativeInfinity|[Vector3](../Static/Vector3.md)|False|Shorthand for writing Vector3(float.PositiveInfinity, float.PositiveInfinity, float.PositiveInfinity).| -|PositiveInfinity|[Vector3](../Static/Vector3.md)|False|Shorthand for writing Vector3(float.PositiveInfinity, float.PositiveInfinity, float.PositiveInfinity).| -## Methods -|Function|Returns|Description| -|---|---|---| -|Angle(from : [Vector3](../Static/Vector3.md), to : [Vector3](../Static/Vector3.md))|float|Calculates the angle between vectors from and.| -|ClampMagnitude(vector : [Vector3](../Static/Vector3.md), maxLength : float)|[Vector3](../Static/Vector3.md)|Returns a copy of vector with its magnitude clamped to maxLength.| -|Cross(a : [Vector3](../Static/Vector3.md), b : [Vector3](../Static/Vector3.md))|[Vector3](../Static/Vector3.md)|Cross Product of two vectors.| -|Distance(a : [Vector3](../Static/Vector3.md), b : [Vector3](../Static/Vector3.md))|float|Returns the distance between a and b.| -|Dot(a : [Vector3](../Static/Vector3.md), b : [Vector3](../Static/Vector3.md))|float|Dot Product of two vectors.| -|Lerp(a : [Vector3](../Static/Vector3.md), b : [Vector3](../Static/Vector3.md), t : float)|[Vector3](../Static/Vector3.md)|Linearly interpolates between two points.| -|LerpUnclamped(a : [Vector3](../Static/Vector3.md), b : [Vector3](../Static/Vector3.md), t : float)|[Vector3](../Static/Vector3.md)|Linearly interpolates between two vectors.| -|Max(a : [Vector3](../Static/Vector3.md), b : [Vector3](../Static/Vector3.md))|[Vector3](../Static/Vector3.md)|Returns a vector that is made from the largest components of two vectors.| -|Min(a : [Vector3](../Static/Vector3.md), b : [Vector3](../Static/Vector3.md))|[Vector3](../Static/Vector3.md)|Returns a vector that is made from the smallest components of two vectors.| -|MoveTowards(current : [Vector3](../Static/Vector3.md), target : [Vector3](../Static/Vector3.md), maxDistanceDelta : float)|[Vector3](../Static/Vector3.md)|Calculate a position between the points specified by current and target, moving no farther than the distance specified by maxDistanceDelta.| -|Normalize(value : [Vector3](../Static/Vector3.md))|[Vector3](../Static/Vector3.md)|Makes this vector have a magnitude of 1.| -|OrthoNormalize(a : [Vector3](../Static/Vector3.md), b : [Vector3](../Static/Vector3.md))|none|| -|Project(a : [Vector3](../Static/Vector3.md), b : [Vector3](../Static/Vector3.md))|[Vector3](../Static/Vector3.md)|Projects a vector onto another vector.| -|ProjectOnPlane(vector : [Vector3](../Static/Vector3.md), plane : [Vector3](../Static/Vector3.md))|[Vector3](../Static/Vector3.md)|Projects a vector onto a plane defined by a normal orthogonal to the plane.| -|Reflect(inDirection : [Vector3](../Static/Vector3.md), inNormal : [Vector3](../Static/Vector3.md))|[Vector3](../Static/Vector3.md)|Reflects a vector off the plane defined by a normal.| -|RotateTowards(current : [Vector3](../Static/Vector3.md), target : [Vector3](../Static/Vector3.md), maxRadiansDelta : float, maxMagnitudeDelta : float)|[Vector3](../Static/Vector3.md)|Rotates a vector current towards target.| -|SignedAngle(from : [Vector3](../Static/Vector3.md), to : [Vector3](../Static/Vector3.md), axis : [Vector3](../Static/Vector3.md))|float|Calculates the signed angle between vectors from and to in relation to axis.| -|Slerp(a : [Vector3](../Static/Vector3.md), b : [Vector3](../Static/Vector3.md), t : float)|[Vector3](../Static/Vector3.md)|Spherically interpolates between two vectors.| -|SlerpUnclamped(a : [Vector3](../Static/Vector3.md), b : [Vector3](../Static/Vector3.md), t : float)|[Vector3](../Static/Vector3.md)|Spherically interpolates between two vectors.| -|SmoothDamp(current : [Vector3](../Static/Vector3.md), target : [Vector3](../Static/Vector3.md), currentVelocity : [Vector3](../Static/Vector3.md), smoothTime : float, maxSpeed : float)|[Vector3](../Static/Vector3.md)|| -|Set(x : float, y : float, z : float)|none|Set x, y and z components of an existing Vector3.| -|Scale(scale : Object)|[Vector3](../Static/Vector3.md)|Returns the Vector3 multiplied by scale.| -|Multiply(a : [Vector3](../Static/Vector3.md), b : [Vector3](../Static/Vector3.md))|[Vector3](../Static/Vector3.md)|Returns the multiplication of two Vector3s.| -|Divide(a : [Vector3](../Static/Vector3.md), b : [Vector3](../Static/Vector3.md))|[Vector3](../Static/Vector3.md)|Returns the division of two Vector3s.| -|GetRotationDirection(a : [Vector3](../Static/Vector3.md), b : [Vector3](../Static/Vector3.md))|[Vector3](../Static/Vector3.md)|Gets the relational Vector3 "b" using "a" as a reference. This is equivalent to setting MapObject.Forward to Vector "a", and finding the relative "b" vector.| -|\_\_Copy\_\_()|Object|Override to deepcopy object on assignment, used for structs. Ex: copy = original is equivalent to copy = original.\_\_Copy\_\_()| -|\_\_Add\_\_(self : Object, other : Object)|Object|Override to implement addition, used for + operator. Ex: a + b is equivalent to a.\_\_Add\_\_(a, b)| -|\_\_Sub\_\_(self : Object, other : Object)|Object|Override to implement subtraction, used for - operator. Ex: a - b is equivalent to a.\_\_Sub\_\_(a, b)| -|\_\_Mul\_\_(self : Object, other : Object)|Object|Override to implement multiplication, used for * operator. Ex: a * b is equivalent to a.\_\_Mul\_\_(a, b)| -|\_\_Div\_\_(self : Object, other : Object)|Object|Override to implement division, used for / operator. Ex: a / b is equivalent to a.\_\_Div\_\_(a, b)| -|\_\_Eq\_\_(self : Object, other : Object)|bool|Override to implement equality comparison, used for == and != operators. Ex: a == b is equivalent to a.\_\_Eq\_\_(a, b)| -|\_\_Hash\_\_()|int|Override to implement hashing, used for GetHashCode - Used for Dictionaries/Sets. Ex: hash = obj.GetHashCode() is equivalent to hash = obj.\_\_Hash\_\_()| diff --git a/Assets/Docs/Static/Vector3.md.meta b/Assets/Docs/Static/Vector3.md.meta deleted file mode 100644 index f22ad56bd..000000000 --- a/Assets/Docs/Static/Vector3.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 91774c52da798684ebda9e667cfcde9b -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Scripts/CustomLogic/Attributes/CLCallbackAttribute.cs b/Assets/Scripts/CustomLogic/Attributes/CLCallbackAttribute.cs new file mode 100644 index 000000000..e7d0ddf99 --- /dev/null +++ b/Assets/Scripts/CustomLogic/Attributes/CLCallbackAttribute.cs @@ -0,0 +1,16 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace CustomLogic +{ + [AttributeUsage(AttributeTargets.Method)] + internal class CLCallbackAttribute : CLBaseAttribute + { + public CLCallbackAttribute() + { + } + } +} diff --git a/Assets/Scripts/CustomLogic/Attributes/CLCallbackAttribute.cs.meta b/Assets/Scripts/CustomLogic/Attributes/CLCallbackAttribute.cs.meta new file mode 100644 index 000000000..9284884d7 --- /dev/null +++ b/Assets/Scripts/CustomLogic/Attributes/CLCallbackAttribute.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: d378f59e264a3d74b8f25f8ec76354fb +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Scripts/CustomLogic/Builtin/CustomLogicUIBuiltin.cs b/Assets/Scripts/CustomLogic/Builtin/CustomLogicUIBuiltin.cs index c780c0cf7..1ce0fcfae 100644 --- a/Assets/Scripts/CustomLogic/Builtin/CustomLogicUIBuiltin.cs +++ b/Assets/Scripts/CustomLogic/Builtin/CustomLogicUIBuiltin.cs @@ -185,10 +185,10 @@ public static CustomLogicColorBuiltin GetThemeColor(string panel, string categor } [CLMethod("Returns if the given popup is active")] - public bool IsPopupActive(string popupName) => Menu.GetCustomPopup(popupName).IsActive; + public static bool IsPopupActive(string popupName) => Menu.GetCustomPopup(popupName).IsActive; [CLProperty("Returns a list of all popups")] - public CustomLogicListBuiltin Popups + public static CustomLogicListBuiltin Popups { get { diff --git a/Assets/Scripts/CustomLogic/Component/CustomLogicComponentInstance.cs b/Assets/Scripts/CustomLogic/Component/CustomLogicComponentInstance.cs index c34dacaa7..c770ee64e 100644 --- a/Assets/Scripts/CustomLogic/Component/CustomLogicComponentInstance.cs +++ b/Assets/Scripts/CustomLogic/Component/CustomLogicComponentInstance.cs @@ -43,6 +43,7 @@ public bool UsesCollider() return eval.HasMethod(this, "OnCollisionStay") || eval.HasMethod(this, "OnCollisionEnter") || eval.HasMethod(this, "OnCollisionExit") || eval.HasMethod(this, "OnGetHit"); } + [CLCallbackAttribute] public void OnCollisionStay(BuiltinClassInstance other) { if (!Enabled) @@ -51,6 +52,7 @@ public void OnCollisionStay(BuiltinClassInstance other) CustomLogicManager.Evaluator?.EvaluateMethod(this, "OnCollisionStay", new object[] { other }); } + [CLCallbackAttribute] public void OnCollisionEnter(BuiltinClassInstance other) { if (!Enabled) @@ -59,6 +61,7 @@ public void OnCollisionEnter(BuiltinClassInstance other) CustomLogicManager.Evaluator.EvaluateMethod(this, "OnCollisionEnter", new object[] { other }); } + [CLCallbackAttribute] public void OnCollisionExit(BuiltinClassInstance other) { if (!Enabled) @@ -67,6 +70,7 @@ public void OnCollisionExit(BuiltinClassInstance other) CustomLogicManager.Evaluator.EvaluateMethod(this, "OnCollisionExit", new object[] { other }); } + [CLCallbackAttribute] public void OnGetHit(CustomLogicCharacterBuiltin character, string name, int damage, string type, Vector3 position) { if (!Enabled) @@ -75,6 +79,7 @@ public void OnGetHit(CustomLogicCharacterBuiltin character, string name, int dam CustomLogicManager.Evaluator.EvaluateMethod(this, "OnGetHit", new object[] { character, name, damage, type, position }); } + [CLCallbackAttribute] public void OnGetHooked(CustomLogicHumanBuiltin human, CustomLogicVector3Builtin position, bool left) { if (!Enabled) diff --git a/Assets/Scripts/CustomLogic/CustomLogicEvaluator.cs b/Assets/Scripts/CustomLogic/CustomLogicEvaluator.cs index abc26ce06..ef7438df7 100644 --- a/Assets/Scripts/CustomLogic/CustomLogicEvaluator.cs +++ b/Assets/Scripts/CustomLogic/CustomLogicEvaluator.cs @@ -182,22 +182,26 @@ protected void RemoveCallbacks(CustomLogicClassInstance instance) } } + [CLCallbackAttribute] public void OnTick() { EvaluateMethodForCallbacks("OnTick"); CurrentTime += Time.fixedDeltaTime; } + [CLCallbackAttribute] public void OnFrame() { EvaluateMethodForCallbacks("OnFrame"); } + [CLCallbackAttribute] public void OnLateFrame() { EvaluateMethodForCallbacks("OnLateFrame"); } + [CLCallbackAttribute] public void OnButtonClick(string name) { var parameters = ArrayPool.New(1); @@ -206,6 +210,7 @@ public void OnButtonClick(string name) ArrayPool.Free(parameters); } + [CLCallbackAttribute] public void OnPlayerSpawn(Player player, BaseCharacter character) { var playerBuiltin = new CustomLogicPlayerBuiltin(player); @@ -216,6 +221,7 @@ public void OnPlayerSpawn(Player player, BaseCharacter character) EvaluateMethodForCallbacks("OnPlayerSpawn", new object[] { playerBuiltin, characterBuiltin }); } + [CLCallbackAttribute] public void OnCharacterSpawn(BaseCharacter character) { var builtin = GetCharacterBuiltin(character); @@ -225,6 +231,7 @@ public void OnCharacterSpawn(BaseCharacter character) EvaluateMethodForCallbacks("OnCharacterSpawn", new object[] { builtin }); } + [CLCallbackAttribute] public void OnCharacterReloaded(BaseCharacter character) { var builtin = GetCharacterBuiltin(character); @@ -233,6 +240,7 @@ public void OnCharacterReloaded(BaseCharacter character) EvaluateMethodForCallbacks("OnCharacterReloaded", new object[] { builtin }); } + [CLCallbackAttribute] public void OnCharacterDie(BaseCharacter victim, BaseCharacter killer, string killerName) { var victimBuiltin = GetCharacterBuiltin(victim); @@ -241,6 +249,7 @@ public void OnCharacterDie(BaseCharacter victim, BaseCharacter killer, string ki EvaluateMethodForCallbacks("OnCharacterDie", new object[] { victimBuiltin, killerBuiltin, killerName }); } + [CLCallbackAttribute] public void OnCharacterDamaged(BaseCharacter victim, BaseCharacter killer, string killerName, int damage) { var victimBuiltin = GetCharacterBuiltin(victim); @@ -249,11 +258,13 @@ public void OnCharacterDamaged(BaseCharacter victim, BaseCharacter killer, strin EvaluateMethodForCallbacks("OnCharacterDamaged", new object[] { victimBuiltin, killerBuiltin, killerName, damage }); } + [CLCallbackAttribute] public object OnChatInput(string message) { return EvaluateMethod(_staticClasses["Main"], "OnChatInput", new object[] { message }); } + [CLCallbackAttribute] public void OnPlayerJoin(Player player) { var playerBuiltin = new CustomLogicPlayerBuiltin(player); @@ -261,6 +272,7 @@ public void OnPlayerJoin(Player player) ((CustomLogicUIBuiltin)_staticClasses["UI"]).OnPlayerJoin(player); } + [CLCallbackAttribute] public void OnPlayerLeave(Player player) { var playerBuiltin = new CustomLogicPlayerBuiltin(player); @@ -269,6 +281,7 @@ public void OnPlayerLeave(Player player) /// caching this object[] since its potentially heavily used. private object[] _networkCallback = new object[3]; + [CLCallbackAttribute] public void OnNetworkMessage(Player sender, string message, double sentServerTimestamp) { var playerBuiltin = new CustomLogicPlayerBuiltin(sender); @@ -289,6 +302,7 @@ public static CustomLogicCharacterBuiltin GetCharacterBuiltin(BaseCharacter char return null; } + [CLCallbackAttribute] private IEnumerator OnSecond() { while (true) diff --git a/Assets/Scripts/Editor/GenerateCLDocs.cs b/Assets/Scripts/Editor/GenerateCLDocs.cs index a93e13d70..e827ff041 100644 --- a/Assets/Scripts/Editor/GenerateCLDocs.cs +++ b/Assets/Scripts/Editor/GenerateCLDocs.cs @@ -57,7 +57,7 @@ public void OnGUI() if (GUILayout.Button("Generate Docs")) { // Generate docs in the project folder/Docs - GenerateDocs("Assets/Docs"); + GenerateDocs("Docs/"); } } @@ -159,8 +159,12 @@ private void GenerateDocs(string output) .ToArray(); // Clear the existing files in Object and Static folders - System.IO.Directory.Delete($"{output}/Object", true); - System.IO.Directory.Delete($"{output}/Static", true); + if (System.IO.Directory.Exists($"{output}/objects")) + System.IO.Directory.Delete($"{output}/objects", true); + if (System.IO.Directory.Exists($"{output}/static")) + System.IO.Directory.Delete($"{output}/static", true); + if (System.IO.File.Exists($"{output}/callbacks")) + System.IO.File.Delete($"{output}/callbacks"); // Update Type reference dictionary with the class names and their paths. TypeReference.Clear(); @@ -169,21 +173,20 @@ private void GenerateDocs(string output) // Map the className to the folder it will be in var clType = (CLTypeAttribute)type.GetCustomAttributes(typeof(CLTypeAttribute), false)[0]; var className = clType.Name; - var isStatic = clType.Static; - string subfolder = isStatic ? "Static" : "Object"; + bool isInStatic = clType.Static && clType.Abstract; + string subfolder = isInStatic ? "static" : "objects"; string path = $"[{className}](../{subfolder}/{className}.md)"; Debug.Log($"{type.Name}, {path}"); TypeReference.Add(type.Name, path); TypeReference.Add(className, path); } - // iterate foreach (var cl in classes) { var clType = (CLTypeAttribute)cl.GetCustomAttributes(typeof(CLTypeAttribute), false).First(); var className = clType.Name; - var isStatic = clType.Static; - string subfolder = isStatic ? "Static" : "Object"; + bool isInStatic = clType.Static && clType.Abstract; + string subfolder = isInStatic ? "static" : "objects"; string folder = $"{output}/{subfolder}"; // create folders if they dont exist @@ -191,6 +194,10 @@ private void GenerateDocs(string output) string path = $"{folder}/{className}.md"; GenerateClassDoc(path, cl, XMLdoc); } + + // Create README.md files in both Object and Static with text # Object / # Static + System.IO.File.WriteAllText($"{output}/objects/README.md", "# Objects"); + System.IO.File.WriteAllText($"{output}/static/README.md", "# Static"); } private void GenerateClassDoc(string path, System.Type type, System.Xml.XmlDocument XMLdoc) @@ -215,7 +222,8 @@ private void GenerateClassDoc(string path, System.Type type, System.Xml.XmlDocum doc += GenerateInitializers(type, className, XMLdoc); } doc += GenerateFields(type, XMLdoc); - doc += GenerateMethods(type, XMLdoc); + doc += GenerateMethods(type, XMLdoc, isStatic: false); + doc += GenerateMethods(type, XMLdoc, isStatic: true); System.IO.File.WriteAllText(path, doc); } @@ -475,25 +483,38 @@ private string GenerateFields(System.Type type, System.Xml.XmlDocument XMLdoc) return doc; } - private string GenerateMethods(System.Type type, System.Xml.XmlDocument XMLdoc) + private string GenerateMethods(System.Type type, System.Xml.XmlDocument XMLdoc, bool isStatic=false) { string doc = string.Empty; var methods = type.GetMethods() .Where(x => x.GetCustomAttributes(typeof(CLMethodAttribute), false).Length > 0) .ToArray(); + + string header = "## Methods"; + // Filter out static methods + if (isStatic) + { + methods = methods.Where(x => x.IsStatic).ToArray(); + header = "## Static Methods"; + } + else + { + methods = methods.Where(x => !x.IsStatic).ToArray(); + } + if (methods.Length > 0) { - doc += "## Methods\n"; + doc += $"{header}\n"; List headers = new List { "Function", "Returns", "Description" }; + List sizing = new List { 30, 20, 50 }; List> rows = new List>(); foreach (var method in methods) { var clMethod = (CLMethodAttribute)method.GetCustomAttributes(typeof(CLMethodAttribute), false)[0]; var methodName = DelimitStyled(method.Name); - // methodName should look like name(param1 : type1, param2 : type2) - // optional params look like name(param1: type1, param2 : type2 = defaultValue) var parameters = method.GetParameters(); string signature = $"{methodName}("; + for (int i = 0; i < parameters.Length; i++) { var param = parameters[i]; @@ -503,15 +524,15 @@ private string GenerateMethods(System.Type type, System.Xml.XmlDocument XMLdoc) else signature += $"{param.Name} : {paramType}"; if (i < parameters.Length - 1) - signature += ", "; + signature += ","; } signature += ")"; - methodName = signature; var returnType = ResolveType(method.ReturnType.Name); var description = ResolveMethodDescription(type, method, XMLdoc, clMethod.Description); - rows.Add(new List { methodName, returnType, description }); + rows.Add(new List { signature, returnType, description }); } - doc += CreateTable(headers, rows); + + doc += CreateHTMLTable(headers, rows, sizing); } return doc; } @@ -529,6 +550,44 @@ private string CreateCodeExample(List lines) return code; } + + private string CreateHTMLTable(List headers, List> rows, List columnWidths) + { + string table = string.Empty; + table += "\n"; + table += ""; + foreach (var width in columnWidths) + { + table += $"\n"; + } + table += "\n"; + + // header + table += "\n"; + table += "\n"; + foreach (var header in headers) + { + table += $"\n"; + } + table += "\n"; + table += "\n"; + + // body + table += "\n"; + foreach (var row in rows) + { + table += "\n"; + foreach (var cell in row) + { + table += $"\n"; + } + table += "\n"; + } + table += "\n"; + table += "
{header}
{cell}
\n"; + return table; + } + /// /// Create a markdown table /// @@ -537,11 +596,12 @@ private string CreateCodeExample(List lines) /// private string CreateTable(List headers, List> rows) { + string table = string.Empty; table += "|"; foreach (var header in headers) { - table += header + "|"; + table += $"{header}|"; } table += "\n"; table += "|";