Skip to content

Document target:is_arch64() #253

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
merged 1 commit into from
Nov 4, 2025
Merged

Document target:is_arch64() #253

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
24 changes: 24 additions & 0 deletions docs/api/scripts/target-instance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,30 @@ target:is_arch("x86")
target:is_arch("x64", "x86_64")
```

## target:is_arch64

- Is the current architecture a 64-bit one

#### Function Prototype

::: tip API
```lua
target:is_arch64()
```
:::

#### Parameter Description

No parameters required for this function.

#### Usage


Comment on lines +229 to +231
Copy link

@gemini-code-assist gemini-code-assist bot Nov 4, 2025

Choose a reason for hiding this comment

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

medium

The Usage section should have an explanation, similar to other functions in this file like target:is_arch. This helps users understand when and why to use this function. The extra newline can also be removed to improve consistency.

Suggested change
#### Usage
#### Usage
This is a helper function to check for 64-bit architectures. It is recommended over the global `is_arch64` function for target-specific scripts, as a target can have its own architecture set via `set_arch`.

```lua
- Is the current architecture 64-bit?
Copy link

@gemini-code-assist gemini-code-assist bot Nov 4, 2025

Choose a reason for hiding this comment

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

medium

The comment syntax is incorrect for Lua. Lua comments start with --. Also, for consistency with other code examples in this document, the comment should be a statement, not a question.

Suggested change
- Is the current architecture 64-bit?
-- Is the current architecture 64-bit

target:is_arch64()
```

## target:targetfile

- Get the target file path
Expand Down