Skip to content
This repository has been archived by the owner on Jul 11, 2024. It is now read-only.

Commit

Permalink
Browse files Browse the repository at this point in the history
…into net21
  • Loading branch information
bgk- committed May 26, 2024
2 parents a7eac56 + 8fb9a7a commit 69fe6a0
Show file tree
Hide file tree
Showing 16 changed files with 1,705 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/trigger-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: trigger-docs

on:
push:
branches:
- main

jobs:
build:
runs-on: ubuntu-latest

steps:
- name: Trigger Docs
uses: actions/github-script@v6
with:
github-token: ${{ secrets.PAT }}
script: |
await github.rest.actions.createWorkflowDispatch({
owner: 'peartreegames',
repo: 'website',
workflow_id: 'main.yml',
ref: 'main'
})
31 changes: 31 additions & 0 deletions docs/peartreegames.topiary.bytecode.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# ByteCode

Namespace: PeartreeGames.Topiary

Provides a set of methods for working with bytecode.

```csharp
public static class ByteCode
```

Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ByteCode](./peartreegames.topiary.bytecode.md)
## Methods

### **GetExterns(BinaryReader)**

Retrieves a sorted set of external names from the given binary reader.

```csharp
public static SortedSet<string> GetExterns(BinaryReader reader)
```

#### Parameters

`reader` [BinaryReader](https://docs.microsoft.com/en-us/dotnet/api/system.io.binaryreader)
The binary reader from which to read the external names.

#### Returns

SortedSet&lt;String&gt;
A sorted set of external names.
94 changes: 94 additions & 0 deletions docs/peartreegames.topiary.choice.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
# Choice

Namespace: PeartreeGames.Topiary

Represents a choice in a dialogue.

```csharp
public struct Choice
```

Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ValueType](https://docs.microsoft.com/en-us/dotnet/api/system.valuetype) → [Choice](./peartreegames.topiary.choice.md)
## Properties

### **VisitCount**

Gets the visit count associated with the choice.

```csharp
public int VisitCount { get; }
```

#### Property Value

[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
The visit count.

### **Ip**

Gets the IP (Instruction Pointer) of the choice.

```csharp
public int Ip { get; }
```

#### Property Value

[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
**Remarks:**

Mostly used internally, but exposed here as well

### **Content**

Represents a choice in a dialogue.

```csharp
public string Content { get; }
```

#### Property Value

[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
### **Tags**

Gets the tags associated with the choice.

```csharp
public String[] Tags { get; }
```

#### Property Value

[String[]](https://docs.microsoft.com/en-us/dotnet/api/system.string)
The tags associated with the choice.

**Remarks:**

The tags are represented as an array of strings.

## Methods

### **MarshalPtr(IntPtr, Byte)**

Marshals an [IntPtr](https://docs.microsoft.com/en-us/dotnet/api/system.intptr) pointer to an array of [Choice](./peartreegames.topiary.choice.md) structures.
```csharp
Choice[] MarshalPtr(IntPtr choicePtr, byte count)
```

#### Parameters

`choicePtr` [IntPtr](https://docs.microsoft.com/en-us/dotnet/api/system.intptr)
The pointer to the array of [Choice](./peartreegames.topiary.choice.md) structures.

`count` [Byte](https://docs.microsoft.com/en-us/dotnet/api/system.byte)
The number of [Choice](./peartreegames.topiary.choice.md) structures in the array.

#### Returns

[Choice[]](./peartreegames.topiary.choice.md)
An array of [Choice](./peartreegames.topiary.choice.md) structures.
15 changes: 15 additions & 0 deletions docs/peartreegames.topiary.delegates.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Delegates

Namespace: PeartreeGames.Topiary

The Delegates class provides delegates for various functions used in the PeartreeGames.Topiary namespace.

```csharp
public static class Delegates
```

Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Delegates](./peartreegames.topiary.delegates.md)
**Remarks:**

These delegates are used for callback functions, function pointers, and event handlers within the Topiary library.
Loading

0 comments on commit 69fe6a0

Please sign in to comment.