Skip to content

Commit

Permalink
more readme fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
ericoporto committed Apr 15, 2024
1 parent 3f38f1b commit 21ce268
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 13 deletions.
4 changes: 3 additions & 1 deletion README.BBCode
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
[size=14pt][b][color=maroon]F[/color][color=hotpink]a[/color][color=navy]n[/color][color=purple]c[/color][color=limegreen]y[/color][/b][/size] [color=gray][b]version 0.1.0 [/b][/color]

[url="https://github.com/ericoporto/fancy/releases/download/0.1.0/fancy.scm"]Get Latest Release [b]fancy.scm[/b][/url] | [url="https://github.com/ericoporto/fancy"]GitHub Repo[/url]
[url="https://github.com/ericoporto/fancy/releases/download/0.1.0/fancy.scm"]Get Latest Release [b]fancy.scm[/b][/url] | [url="https://github.com/ericoporto/fancy"]GitHub Repo[/url] | | [url="https://github.com/ericoporto/fancy/releases/download/0.1.0/fancy_demo_windows.zip"]Project with Demo![/url]

[url=https://github.com/ericoporto/fancy/actions][img]https://github.com/ericoporto/fancy/actions/workflows/main.yml/badge.svg[/img][/url]

Fancy is a Script module for "fancy" text in Adventure Game Studio, you can have text with multiple colors, fonts, with sprites and other. It brings it's own Typed-Text mechanism and additional fancyness.

Expand Down
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# fancy

![build-and-test-windows](https://github.com/ericoporto/fancy/actions/workflows/main.yml/badge.svg)
[![build-and-test-windows](https://github.com/ericoporto/fancy/actions/workflows/main.yml/badge.svg)](https://github.com/ericoporto/fancy/actions)

Fancy is a Script module for "fancy" text in Adventure Game Studio.

Expand All @@ -22,73 +22,73 @@ To be written...

### **Script Extensions**

**DrawingSurface.DrawFancyTextWrapped**
#### `DrawingSurface.DrawFancyTextWrapped`
```AGS Script
void DrawingSurface.DrawFancyTextWrapped(int x, int y, int width, int color, FontType font, const string text);
```
Draws text with fancy parsing wrapped within specified boundaries on the drawing surface.

### **FancyDrawingConfig**

**FancyDrawingConfig.Create**
#### `FancyDrawingConfig.Create`
```AGS Script
static FancyDrawingConfig* FancyDrawingConfig.Create(FontType font, int color, Alignment align, int line_spacing);
```
Configuration structure for fancy text drawing, allowing customization of font, text color, line spacing, and alignment.

### **FancyTextBase**

**FancyTextBase.SetDrawingConfig**
#### `FancyTextBase.SetDrawingConfig`
```AGS Script
void FancyTextBase.SetDrawingConfig(FancyDrawingConfig* config);
```
Sets the drawing configuration for fancy text rendering.

**FancyTextBase.SetDrawingArea**
#### `FancyTextBase.SetDrawingArea`
```AGS Script
void FancyTextBase.SetDrawingArea(int x, int y, int width = FANCY_INFINITE_WIDTH);
```
Sets the area for drawing fancy text, specifying the position and width.

**FancyTextBase.SetFancyText**
#### `FancyTextBase.SetFancyText`
```AGS Script
void FancyTextBase.SetFancyText(String text);
```
Sets the text content for the fancy text box.

**FancyTextBase.Draw**
#### `FancyTextBase.Draw`
```AGS Script
void FancyTextBase.Draw(DrawingSurface* surf);
```
Draws the fancy text on the specified drawing surface.

### **FancyTypedText**

**FancyTypedText.Clear**
#### `FancyTypedText.Clear`
```AGS Script
void FancyTypedText.Clear();
```
Clears all text and resets everything for typed text.

**FancyTypedText.Start**
#### `FancyTypedText.Start`
```AGS Script
void FancyTypedText.Start(String text);
```
Sets a new string and resets everything to start typing. You can then use Tick repeatedly to advance the text.

**FancyTypedText.Skip**
#### `FancyTypedText.Skip`
```AGS Script
void FancyTypedText.Skip();
```
Skips all remaining typing of the text.

**FancyTypedText.Tick**
#### `FancyTypedText.Tick`
```AGS Script
void FancyTypedText.Tick();
```
Updates the typed text state, advancing it by a single tick.

**FancyTypedText.DrawTyped**
#### `FancyTypedText.DrawTyped`
```AGS Script
void FancyTypedText.DrawTyped(DrawingSurface* surf);
```
Expand Down

0 comments on commit 21ce268

Please sign in to comment.