Skip to content

Docs for AvatarAbilities library#1489

Open
whoamimaybeme wants to merge 6 commits intoRoblox:mainfrom
whoamimaybeme:avatar-abilities
Open

Docs for AvatarAbilities library#1489
whoamimaybeme wants to merge 6 commits intoRoblox:mainfrom
whoamimaybeme:avatar-abilities

Conversation

@whoamimaybeme
Copy link
Copy Markdown

Changes

  • Adds documentation for the AvatarAbilities platform library and the functions and properties it has under the Character Controller Library category in the Character documentation. Hopefully there will be some other proper place to put documentation for the AvatarAbilities library along with any other platform library, unless there already is.
  • Adds documentation for require("@rbx/")
  • If there is any mistakes that I made, please point it out. I know the wording for the stuff on the require page might be a bit stupid.
  • I really hope those Merge branch 'Roblox:main' into avatar-abilities things dont mess anything up.

Checks

By submitting your pull request for review, you agree to the following:

  • This contribution was created in whole or in part by me, and I have the right to submit it under the terms of this repository's open source licenses.
  • I understand and agree that this contribution and a record of it are public, maintained indefinitely, and may be redistributed under the terms of this repository's open source licenses.
  • To the best of my knowledge, all proposed changes are accurate.

@whoamimaybeme whoamimaybeme requested a review from a team as a code owner April 10, 2026 19:45
@github-actions github-actions bot added engine guides Changes the Engine guides engine reference Changes the Engine API Reference documentation labels Apr 10, 2026
initializeCharacter(character: `Class.Model`)
</figcaption>

Sets up the CCL for the character that the function is ran on. This function automatically runs on both the server and the client using scripts in the AbilityManagerActor if the CCL is enabled in Studio's [Avatar Settings](../../studio/avatar-settings.md) window. Note that this function currently doesn't return anything, but it will in the future. <!--this is inferred from the fact it says abilityManager at the bottom of the script example-->
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The content quality check says: Unexpected character ! (U+0021) before name, expected a character that can start a name, such as a letter, $, or _ (note: to create a comment in MDX, use {/* text */})

⛔️ This change is a requirement. Please fix it before merging.
🤖 The feedback in this comment is automated and might be incorrect.

initializeClient()
</figcaption>

Initializes the client-side system and automatically initializes . Note this is currently unused, but in the future, this will likely be used.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The content quality library markdownlint says:

  • Trailing spaces (MD009/no-trailing-spaces)
  • Expected: 0 or 2; Actual: 1.

For more information, see the Markdownlint docs for MD009/no-trailing-spaces. You might be able to fix this by using markdownlint for VS Code or by running npm ci && npm run markdownlint.

⛔️ This change is a requirement. Please fix it before merging.


#### sAuthBetaEnabled

Exposed for external queries. A bool value that is equal to `mode ~= "None"` No newline at end of file
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The content quality library markdownlint says:

  • Files should end with a single newline character (MD047/single-trailing-newline)

For more information, see the Markdownlint docs for MD047/single-trailing-newline. You might be able to fix this by using markdownlint for VS Code or by running npm ci && npm run markdownlint.

⛔️ This change is a requirement. Please fix it before merging.

@github-actions github-actions bot added the changes requested This pull request has changes requested prior to merging label Apr 10, 2026
Copy link
Copy Markdown

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @whoamimaybeme, thanks so much for helping improve the Roblox creator documentation! Our technical writing team will review your pull request soon. In the meantime, please ensure you've read through the README.md, contribution guidelines, and style recommendations.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changes requested This pull request has changes requested prior to merging engine guides Changes the Engine guides engine reference Changes the Engine API Reference documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant