Interacting with Particle Auth within applications made using Unreal Engine.
particle-unreal
GitHub repository.
To install:
.uproject
file here).Plugins
, or skip this step if Plugins
already exists.Plugins/ParticleSDK
within particle-unreal
and copy it to your Plugins
directory.projectId
, clientKey
, and appId
filled in.
Init
function to complete the initialization. The Init
function accepts the following parameters:
W_ExecuteWebBrowser
. If you prefer to use a custom WebBrowser
blueprint, you can do so if it follows the structure of W_ExecuteWebBrowser
.projectId
, clientKey
, and appId
.en
, zh-cn
, zh-tw
, ja
, or ko
.chainId
and chainName
configurations, refer to EVM Chains Structure.Login
function is the core method for onboarding and account creation/sign-in within Particle Auth on Unreal Engine. It supports social logins and includes the following parameters:
phone
for phone-based logins (sends a verification text and links the account to a phone number).email
for email-based logins (sends a verification email and links the account to an email address).jwt
for custom authentication using JWTs.SignMessage
blueprint.
This blueprint displays a signature request for the end user to confirm. The SignMessage
function includes the following parameter:
Message
: The message to be signed by the user. For EVM chains, this should be a standard UTF-8 string. For Solana, it should be a base58 string.OnSignMessageEvent
.
SignAndSendTransaction
is the core method for sending transactions on EVM and Solana.
When called, it prompts the user with a transaction, allowing them to either confirm and push it to the network or reject and cancel the operation. The SignAndSendTransaction
blueprint includes the following parameter:
Transaction
: A string representing the transaction object/structure to be sent. For EVM, this should be a standard UTF-8 string; for Solana, it should be a base58 string (it can be a stringified object).MakeEvmTransaction
helper method to generate an EVM transaction, which can then be attached to the Transaction
parameter in SignAndSendTransaction
for no-code transaction creation.
Upon a successful signature, the event data, including the signature, is returned via OnSignAndSendTransactionEvent
.
SignTypedData
as an alternative to SignMessage
for signing structured (typed) data.
The SignTypedData
blueprint includes the following parameters:
Message:
The data to be signed is provided as a standard JSON string containing the data structure.Version
: Particle Auth supports all three versions of eth_signTypedData
: v1
, v3
, and v4
. By default, v4
is used.OnSignTypedDataEvent
.
SignTransaction
is a Solana-specific method for signing a transaction without pushing it to the network. The SignTransaction
blueprint includes the following parameters:
Transaction
: A base58 string representing a valid transaction structure to be signed.OnSignTransactionEvent
.
SignAllTransactions
, is another Solana-specific method for signing multiple transactions collectively without pushing them to the network.
The SignAllTransactions
blueprint includes the following parameters:
Transactions
: An array of base58 strings, each representing a valid transaction to be signed.OnSignAllTransactionsEvent
.
.