Methods
Recruit:load(data: string? (boolean|integer)? boolean? })
Arguments:
| data: string? (boolean|integer)? boolean? } |
Recruit:onLoad(data: string? (boolean|integer)? boolean? })
(Override) Called when this recruit's data is loaded from the save file
@param data — The data that was loaded.
Arguments:
| data: string? (boolean|integer)? boolean? } | The data that was loaded. |
Recruit:onSave(data: string, recruited| boolean })
(Override) Called when this recruit's data is saved to the save file
@param data — The data that was saved.
Arguments:
| data: string, recruited| boolean } | The data that was saved. |
Fields
Recruit.attack: string|integer
The attack of this recruit, shown on its details page
Recruit.box_gradient_color: table
The color used for drawing the box gradient
Recruit.box_gradient_type: "bright"|"dark"
The type of box gradient the recruit uses, either "bright" or "dark"
Recruit.box_sprite: [string, number, number, number]
Controls the recruit sprite shown in the recruit menu box
Usage: Sprite path, x-offset, y-offset, animation speed (in seconds)
Recruit.chapter: string|integer
The chapter number this recruit will be listed as being from, shown on its details page
Recruit.defense: string|integer
The defense of this recruit, shown on its details page
Recruit.description: string
The description of this recruit, shown on its details page
Recruit.dislike: string
The like of this recruit, shown on its details page
Recruit.element: string
The element of this recruit, shown on its details page
Recruit.index: integer
This recruit's position in the recruit menu
Recruit.level: string|integer
The level of this recruit, shown on its details page
Recruit.like: string
The dislike of this recruit, shown on its details page
Recruit.name: string
The display name of this recruit
Recruit.recruit_amount: integer
How many times this enemy must be spared to recruit it
Recruit.recruited: boolean|integer
The status of this recruit:
- As an integer, represents the recruit progress
- As a boolean, represents Recruited (
true) or Lost (false)
This value is saved to the save file