Skip to content

Added more info on using Access Transformers for struct properties #394

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

Merged
budak7273 merged 2 commits into from
Aug 16, 2025
Merged

Added more info on using Access Transformers for struct properties #394

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ab928f3
Added more info on using Access Transformers for struct properties
mklierman Aug 16, 2025
b3b7c83
Add comment explaining why `Class=` is used to select the struct
budak7273 Aug 16, 2025
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
5 changes: 5 additions & 0 deletions modules/ROOT/pages/Development/ModLoader/AccessTransformers.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ In order to use Access Transformers, create a file in `YourPluginModReference\Co
; You can use semicolons for comments if you want to leave notes about the purpose of an access transformer
Friend=(Class="AFGSomeClass", FriendClass="UMyClass")
Accessor=(Class="AFGSomeClass", Property="mSomeProperty")
BlueprintType=(Struct="/Script/FactoryGame.SomeStruct")
BlueprintReadWrite=(Class="/Script/FactoryGame.FGSomeClass", Property="mSomeProperty")
BlueprintCallable=(Class="/Script/FactoryGame.FGSomeClass", Function="SomeFunction")
----
Expand Down Expand Up @@ -80,6 +81,8 @@ It cannot be added to a non-`UPROPERTY` field.
It also bypasses the private BPRW conflict check (which is compile time only, it does not affect the editor, or the game),
so that no changes to the game headers are required.

This is also used for properties within structs, provided they are a UPROPERTY and the struct is BlueprintType (which can be added with an Access Transformer).

=== BlueprintCallable

Adds `BlueprintCallable` to the specified UFUNCTION, allowing you to call that function from blueprints.
Expand Down Expand Up @@ -154,7 +157,9 @@ Accessor=(Class="AFGBuildableFactory", Property="mInventoryPotential")
BlueprintReadWrite=(Class="/Script/FactoryGame.FGSchematicManager", Property="mPurchasedSchematics")
BlueprintCallable=(Class="/Script/FactoryGame.FGDismantleInterface", Function="Dismantle")
EditAnywhere=(Class="/Script/FactoryGame.IconData", Property="ID")
; Note that even though WorldScannableData is a struct, BlueprintReadWrite still uses Class to select it
BlueprintType=(Struct="/Script/FactoryGame.WorldScannableData")
BlueprintReadWrite=(Class="/Script/FactoryGame.WorldScannableData", Property="Actor")
----

=== Blueprint Asset Property Tracing Example
Expand Down