-
Notifications
You must be signed in to change notification settings - Fork 147
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.
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
Clarify Lua metamethod usage for some classes; Minor docs edits #376
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have requested a bunch of changes where the syntax is wrong but the casing is also wrong in most places.
In general, I believe we're using PascalCase for variable names in the docs and UECase for UE types, and where appropriate the UE type without the type.
Meaning that if the UE type is UFunction
and if you're referring to the type then put use UFunction
never ufunction
, but if you're referring perhaps to the general concept of a function then Function
would be fine.
I know we're a bit inconsistent with this, the UObject docs for example has this: CallFunction(UFunction function, auto Params...)
and ideally "f" should've been "F" for the first param.
As for the indexing syntax changes, I originally intended for it to show passing in a string variable as the index (as opposed to passing in a string literal, hence the different casing and name, e.g. structMemberVarName variable vs. StructMemberName literal on the second usage). Although on second thought, a string literal would be less confusing and better overall as it also implies that the index is a string value in general. I will make changes to those usages. I will also make changes to the casing of the variables, e.g. |
All your proposed changes look good. |
bf3fb5e
to
612fe44
Compare
|
Resolves #374
__index
,__newindex
,__call
in multiple classes, placing them in a separate Metamethods category.__len
metamethod description for TArray.__call
: mention return val and specify the need for a context parameter if not part of an object instance.__index
: added example of a UFunction call.type()
: clarify thattype(object)
is not equivalent.For initial review.