Aliases - Reetus/ClassicAssist GitHub Wiki

ClassicAssist Macro Commands

Generated on 12/15/2024 3:30:41 AM
Version: 4.425.22+b9a337759d26b9d39ae8ccaac75a36c4255be94a

Aliases

FindAlias

Method Signature:

Boolean FindAlias(System.String)

Parameters

  • aliasname: Alias name.

Description:

Returns true if alias serial can be found on screen, false if not.

Example:

if FindAlias("mount"):  

GetAlias

Method Signature:

Int32 GetAlias(System.String)

Parameters

  • aliasname: Alias name.

Description:

Gets the value of the given alias name.

Example:

GetAlias("mount")  

GetPlayerAlias

Method Signature:

Int32 GetPlayerAlias(System.String)

Parameters

  • aliasname: Alias name.

Description:

Gets the value of the given alias name, for the current player.

Example:

GetPlayerAlias("mount")  

PromptAlias

Method Signature:

Int32 PromptAlias(System.String)

Parameters

  • aliasname: Alias name.

Description:

Prompt with an in-game target cursor to supply value for given alias name.

Example:

PromptAlias("mount")  

PromptMacroAlias

Method Signature:

Int32 PromptMacroAlias(System.String)

Parameters

  • aliasname: Alias name.

Description:

Prompt with an in-game target cursor to supply value for given alias name, alias is valid only in the current macro.

Example:

PromptMacroAlias("mount")  

PromptPlayerAlias

Method Signature:

Int32 PromptPlayerAlias(System.String)

Parameters

  • aliasname: Alias name.

Description:

Prompt with an in-game target cursor to supply value for given alias name, for the current player.

Example:

PromptPlayerAlias("mount")  

SetAlias

Method Signature:

Void SetAlias(System.String, System.Object)

Parameters

  • aliasname: Alias name.
  • obj: An entity serial in integer or hex format, or an alias string such as "self".

Description:

Sets the value of the given alias name.

Example:

SetAlias("mount", 0x40000001)  

SetMacroAlias

Method Signature:

Void SetMacroAlias(System.String, System.Object)

Parameters

  • aliasname: Alias name.
  • obj: An entity serial in integer or hex format, or an alias string such as "self".

Description:

Sets the value of the given alias name, alias is valid only in the current macro.

Example:

SetMacroAlias("mount", 0x40000001)  

SetPlayerAlias

Method Signature:

Void SetPlayerAlias(System.String, System.Object)

Parameters

  • aliasname: Alias name.
  • obj: An entity serial in integer or hex format, or an alias string such as "self".

Description:

Sets the value of the given alias name, for the current player.

Example:

SetPlayerAlias("mount", 0x40000001)  

UnsetAlias

Method Signature:

Void UnsetAlias(System.String)

Parameters

  • aliasname: Alias name.

Description:

Removes the alias name given.

Example:

UnsetAlias("mount")  

UnsetPlayerAlias

Method Signature:

Void UnsetPlayerAlias(System.String)

Parameters

  • aliasname: Alias name.

Description:

Removes the alias name given, for the current player.

Example:

UnsetPlayerAlias("mount")