fix: lua definition generation

This commit is contained in:
Daniel Schmidt 2023-12-24 22:19:00 +01:00
parent 1e6e1899f0
commit f3a7b7e349
2 changed files with 14 additions and 37 deletions

View File

@ -44,12 +44,10 @@ Player actor id for use in functions where the guid is needed, for example: ``de
--]]
PLAYER_ID = ""
-- Functions
-- #####################################
-- Utility
-- #####################################
-- Functions
--[[
Fetches a value from the persistent store
--]]
@ -60,7 +58,6 @@ function fetch(key) end
--[[
returns a new random guid.
--]]
---@return guid
function guid() end
@ -75,7 +72,6 @@ function store(key, value) end
-- Styling
-- #####################################
-- Functions
--[[
Makes the text background colored. Takes hex values like #ff0000.
--]]
@ -117,7 +113,6 @@ function text_underline(value) end
-- Logging
-- #####################################
-- Functions
--[[
Log at **danger** level to player log.
--]]
@ -152,7 +147,6 @@ function print(value, value, value...) end
-- Audio
-- #####################################
-- Functions
--[[
Plays a sound effect. If you want to play ``button.mp3`` you call ``play_audio("button")``.
--]]
@ -169,7 +163,6 @@ function play_music(sound) end
-- Game State
-- #####################################
-- Functions
--[[
Gets the ids of all the encountered events in the order of occurrence.
--]]
@ -234,7 +227,6 @@ function set_game_state(state) end
-- Actor Operations
-- #####################################
-- Functions
--[[
Increases the hp value of a actor by a number. Can be negative value to decrease it. This won't trigger any on_damage callbacks
--]]
@ -288,7 +280,6 @@ function get_opponent_guids(guid) end
--[[
Get the player actor. Equivalent to ``get_actor(PLAYER_ID)``
--]]
---@return actor
function get_player() end
@ -302,7 +293,6 @@ function remove_actor(guid) end
-- Artifact Operations
-- #####################################
-- Functions
--[[
Returns the artifact definition. Can take either a guid or a typeId. If it's a guid it will fetch the type behind the instance.
--]]
@ -335,7 +325,6 @@ function remove_artifact(guid) end
-- Status Effect Operations
-- #####################################
-- Functions
--[[
Adds to the stack count of a status effect. Negative values are also allowed.
--]]
@ -389,7 +378,6 @@ function set_status_effect_stacks(guid, count) end
-- Card Operations
-- #####################################
-- Functions
--[[
Tries to cast a card with a guid and optional target. If the cast isn't successful returns false.
--]]
@ -451,7 +439,6 @@ function upgrade_random_card(actor_guid) end
-- Damage & Heal
-- #####################################
-- Functions
--[[
Deal damage to a enemy from one source. If flat is true the damage can't be modified by status effects or artifacts. Returns the damage that was dealt.
--]]
@ -484,11 +471,9 @@ function heal(source, target, amount) end
-- Player Operations
-- #####################################
-- Functions
--[[
Finishes the player turn.
--]]
function finish_player_turn() end
--[[
@ -527,30 +512,25 @@ function player_give_action_points(points) end
-- Merchant Operations
-- #####################################
-- Functions
--[[
Adds another random artifact to the merchant
--]]
function add_merchant_artifact() end
--[[
Adds another random card to the merchant
--]]
function add_merchant_card() end
--[[
Returns the merchant state.
--]]
---@return table
function get_merchant() end
--[[
Returns the maximum value of artifacts and cards that the merchant will sell. Good to scale ``random_card`` and ``random_artifact``.
--]]
---@return number
function get_merchant_gold_max() end
@ -558,7 +538,6 @@ function get_merchant_gold_max() end
-- Random Utility
-- #####################################
-- Functions
--[[
Generates a random face.
--]]
@ -584,7 +563,6 @@ function random_card(max_price) end
-- Localization
-- #####################################
-- Functions
--[[
Returns the localized string for the given key. Examples on locals definition can be found in `/assets/locals`. Example: ``
l('cards.MY_CARD.name', "English Default Name")``
@ -598,7 +576,6 @@ function l(key, default) end
-- Content Registry
-- #####################################
-- Functions
--[[
Deletes all base game content. Useful if you don't want to include base game content in your mod.

View File

@ -46,8 +46,6 @@ func main() {
builder.WriteString("\n" + glob.Name + " = \"\"\n\n")
}
builder.WriteString("-- Functions\n")
for _, key := range functions {
fn := docs.Functions[key]
if fn.Category != cat.Name {
@ -56,20 +54,22 @@ func main() {
builder.WriteString(fmt.Sprintf(`--[[
%s
--]]`, fn.Description))
builder.WriteString("\n" + strings.Join(lo.Map(fn.Args, func(item string, index int) string {
isOptional := strings.HasPrefix(item, "(optional) ")
if isOptional {
item = strings.TrimPrefix(item, "(optional) ")
}
if len(fn.Args) > 0 {
builder.WriteString("\n" + strings.Join(lo.Map(fn.Args, func(item string, index int) string {
isOptional := strings.HasPrefix(item, "(optional) ")
if isOptional {
item = strings.TrimPrefix(item, "(optional) ")
}
t := "any"
split := strings.Split(item, ":")
if len(split) > 1 {
t = strings.TrimSpace(split[1])
}
t := "any"
split := strings.Split(item, ":")
if len(split) > 1 {
t = strings.TrimSpace(split[1])
}
return "---@param " + strings.TrimSpace(split[0]) + lo.Ternary(isOptional, "?", "") + " " + t
}), "\n"))
return "---@param " + strings.TrimSpace(split[0]) + lo.Ternary(isOptional, "?", "") + " " + t
}), "\n"))
}
if fn.Return != "" {
builder.WriteString("\n---@return " + fn.Return)
}