Skip to content

docs: Pool badges #128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nh6574 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: Pool badges #128

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions SMODS.ObjectType.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,22 @@ This is a subclass of `SMODS.ObjectType`. All values and functions tied to `SMOD
- Used for modifying any registered cards of this type, or adding them to additional pools.
- `ObjectType.delete_card(self, center)`
- Used for removing cards from additional pools when deleted.
- `ObjectType.set_badges(self, card, badges)`
- Add additional badges, leaving existing badges intact. This function doesn't return; add badges by appending to `badges`.
- Avoid overwriting existing elements. It will cause text to appear on the top left corner of your screen instead.
- Function for creating badges: `create_badge(_string, _badge_col, _text_col, scaling)`
- `_string`: Text displayed on the badge.
- `_badge_col = G.C.GREEN`: Background colour.
- `_text_col = G.C.WHITE`: Text colour.
- `_scaling = 1`: Relative size of the badge.
- Example:
```lua
{
set_badges = function(self, card, badges)
badges[#badges+1] = create_badge(localize('k_your_string'), G.C.RED, G.C.BLACK, 1.2 )
end,
}
```
- `ConsumableType.create_UIBox_your_collection(self) -> table`
- Returns the UIBox of the ConsumableType's collections menu.

Expand Down