Skip to content

Update ufunction.yml - Added clarification on CallInEditor #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jeremyabel wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update ufunction.yml - Added clarification on CallInEditor #44

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions yaml/ufunction.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,11 +242,13 @@ specifiers:
utility: 2
position: main
comment: |
Causes a `UFUNCTION` with _no parameters_ and _no return value_ to be shown in the details panel of **object instances**.
Allows a `UFUNCTION` to be callable via editor C++ or editor utility blueprint code.

If the `UFUNCTION` has _no parameters_ and _no return value_, it will be shown as a button in the details panel of **object instances**.

Could be useful for adding helper functions to change the values on the selected instance. For example increasing the level of an enemy by changing their stats, or filling out default values using C++.

To reiterate, only works with functions that have no parameters, and return `void`. `BlueprintCallable` is not required. Only works on instances of the class. So Actors placed in a level or data assets, **not on Blueprint classes**.
To reiterate, only functions that have no parameters, and return `void` will be shown as a button in the details panel. `BlueprintCallable` is not required. Only works on instances of the class. So Actors placed in a level or data assets, **not on Blueprint classes**.

This works as a flag in the main position, or as a boolean in the meta position. I would stick to the Main position just because there are more examples of this in the Unreal codebase.
samples:
Expand Down