Writing some docs
This commit is contained in:
@ -14,7 +14,14 @@ namespace Dawn {
|
||||
std::map<std::string, Asset*> assetsNotLoaded;
|
||||
|
||||
public:
|
||||
/**
|
||||
* Initializes this asset manager so it can begin accepting assets.
|
||||
*/
|
||||
void init();
|
||||
|
||||
/**
|
||||
* Ticks the asset manager for a single frame, synchronously.
|
||||
*/
|
||||
void update();
|
||||
|
||||
/**
|
||||
@ -43,6 +50,9 @@ namespace Dawn {
|
||||
//should delete the asset for you
|
||||
}
|
||||
|
||||
/**
|
||||
* Dispose the asset manager, and all attached assets.
|
||||
*/
|
||||
~AssetManager();
|
||||
};
|
||||
}
|
@ -44,12 +44,55 @@ namespace Dawn {
|
||||
Event<> eventAllCharactersRevealed;
|
||||
Event<> eventClose;
|
||||
|
||||
/**
|
||||
* Constructs a VN Textbox.
|
||||
*
|
||||
* @param canvas Canvas that this textbox belongs to.
|
||||
*/
|
||||
VisualNovelTextbox(UICanvas *canvas);
|
||||
|
||||
/**
|
||||
* Sets the font for this vn textbox. Passed to the underlying label.
|
||||
*
|
||||
* @param font Font to set for this textbox.
|
||||
*/
|
||||
void setFont(Font *font);
|
||||
|
||||
/**
|
||||
* Sets the border information for this textbox.
|
||||
*
|
||||
* @param texture Texture to use for the border.
|
||||
* @param dimensions Dimensions of the border.
|
||||
*/
|
||||
void setBorder(Texture *texture, glm::vec2 dimensions);
|
||||
|
||||
/**
|
||||
* Sets the string (label) for this textbox.
|
||||
*
|
||||
* @param text Text to set.
|
||||
* @param fontSize Font size of the string.
|
||||
*/
|
||||
void setText(std::string text, float_t fontSize);
|
||||
|
||||
/**
|
||||
* Returns true if all of the characters that can be made visible for the
|
||||
* current textbox size have finished revealing, or false if not.
|
||||
*
|
||||
* @return True if above statement is met.
|
||||
*/
|
||||
bool_t hasRevealedAllCurrentCharacters();
|
||||
|
||||
/**
|
||||
* Returns true only when every character passed previously in setText
|
||||
* has been revealed by scrolling.
|
||||
*
|
||||
* @return True if above statement is true.
|
||||
*/
|
||||
bool_t hasRevealedAllCharacters();
|
||||
|
||||
/**
|
||||
* Cleans the VN Textbox.
|
||||
*/
|
||||
~VisualNovelTextbox();
|
||||
};
|
||||
}
|
Reference in New Issue
Block a user