Skip to content

Commit

Permalink
docs: update docs for print and add to changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
Lyrth authored and Buckminsterfullerene02 committed Mar 5, 2024
1 parent e536605 commit d07a6ea
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 8 deletions.
3 changes: 2 additions & 1 deletion assets/Changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ TBD
### UHT Dumper

### Lua API
`print` now behaves like vanilla Lua (can now accept zero, one, or multiple arguments of any type).

### C++ API

Expand Down Expand Up @@ -526,7 +527,7 @@ v2.3.0

## New

### Lua
### Lua

* Added 'ModRef.SetSharedVariable' and 'ModRef.GetSharedVariable'
* Added UObject.HasAnyInternalFlags
Expand Down
4 changes: 2 additions & 2 deletions docs/lua-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ This is an overall list of API definitions available in UE4SS. For more readable

### Global Functions
```
print(string Message)
print(any... Message)
- Does not have the capability to format. Use 'string.format' if you require formatting.
StaticFindObject(string ObjectName) -> { UObject | AActor | nil }
Expand Down Expand Up @@ -656,4 +656,4 @@ This is an overall list of API definitions available in UE4SS. For more readable
Methods
Get() -> UObjectDerivative
- Returns the pointed to UObject or UObject derivative (can be invalid, so call UObject:IsValid after calling Get).
```
```
10 changes: 5 additions & 5 deletions docs/lua-api/global-functions/print.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ The `print` function is used for debugging and outputs a string to the debug con

This function cannot be used to format strings, please use `string.format` for string formatting purposes.

> New lines are not automatically appended so make sure to use `\n` whenever you want a new line.
> New lines are not automatically appended, so make sure to use `\n` whenever you want a new line.
## Parameters

| # | Type | Information |
|---|---------|------------------|
| 1 | string | String to output |
| # | Type | Information |
|-----|-------|------------------|
| ... | any | String or variable to output |

## Example
```lua
print("Hello Debug Console\n")
```
```

0 comments on commit d07a6ea

Please sign in to comment.