1
0
EQ2Emu/docs/lua_functions/GetInfoStructString.md

18 lines
693 B
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

### Function: GetInfoStructString(spawn, field)
**Description:**
Retrieves a string field from the spawns info data structure. The info struct contains various attributes of a spawn (like name, last name, guild, etc.). FieldName is the identifier of the string field. See https://github.com/emagi/eq2emu/blob/main/docs/data_types/info_struct.md for a full list of options.
**Parameters:**
- `spawn` (Spawn) - Spawn object representing `spawn`.
- `field` (string) - String `field`.
**Returns:** String The value of that field, or an empty string if not set.
**Example:**
```lua
-- Example usage (get a player's surname)
local surname = GetInfoStructString(Player, "last_name")
```