Skip to content

Commit

Permalink
Update docs for 0.0.2
Browse files Browse the repository at this point in the history
  • Loading branch information
Fexty12573 committed Jan 15, 2024
1 parent a7c007c commit 7ef5af8
Show file tree
Hide file tree
Showing 19 changed files with 698 additions and 33 deletions.
91 changes: 91 additions & 0 deletions docs/API/SharpPluginLoader.Core.Actions.Action.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
# Action

Namespace: SharpPluginLoader.Core.Actions

Represents an instance of the cActionBase class.

```csharp
public class Action : SharpPluginLoader.Core.MtObject
```

Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object) → [NativeWrapper](./SharpPluginLoader.Core.NativeWrapper.md) → [MtObject](./SharpPluginLoader.Core.MtObject.md) → [Action](./SharpPluginLoader.Core.Actions.Action.md)

## Properties

### **ActiveTime**

The amount of time the action has been active.

```csharp
public Single& ActiveTime { get; }
```

#### Property Value

[Single&](https://docs.microsoft.com/en-us/dotnet/api/System.Single&)<br>

### **DeltaSec**

The actions delta time.

```csharp
public Single& DeltaSec { get; }
```

#### Property Value

[Single&](https://docs.microsoft.com/en-us/dotnet/api/System.Single&)<br>

### **Flags**

The flags of the action.

```csharp
public UInt64& Flags { get; }
```

#### Property Value

[UInt64&](https://docs.microsoft.com/en-us/dotnet/api/System.UInt64&)<br>

### **Name**

The name of the action.

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

#### Property Value

[String](https://docs.microsoft.com/en-us/dotnet/api/System.String)<br>

### **Instance**

The native pointer.

```csharp
public nint Instance { get; set; }
```

#### Property Value

[IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr)<br>

## Constructors

### **Action(IntPtr)**

```csharp
public Action(nint instance)
```

#### Parameters

`instance` [IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr)<br>

### **Action()**

```csharp
public Action()
```
135 changes: 135 additions & 0 deletions docs/API/SharpPluginLoader.Core.Actions.ActionController.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
# ActionController

Namespace: SharpPluginLoader.Core.Actions

Represents an instance of the cActionController class.

```csharp
public class ActionController : SharpPluginLoader.Core.MtObject
```

Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object) → [NativeWrapper](./SharpPluginLoader.Core.NativeWrapper.md) → [MtObject](./SharpPluginLoader.Core.MtObject.md) → [ActionController](./SharpPluginLoader.Core.Actions.ActionController.md)

## Properties

### **CurrentAction**

The action that is currently being performed.

```csharp
public ActionInfo& CurrentAction { get; }
```

#### Property Value

[ActionInfo&](./SharpPluginLoader.Core.Actions.ActionInfo.md)<br>

### **NextAction**

The action that will be performed next.

```csharp
public ActionInfo& NextAction { get; }
```

#### Property Value

[ActionInfo&](./SharpPluginLoader.Core.Actions.ActionInfo.md)<br>

### **PreviousAction**

The action that was performed before the current one.

```csharp
public ActionInfo& PreviousAction { get; }
```

#### Property Value

[ActionInfo&](./SharpPluginLoader.Core.Actions.ActionInfo.md)<br>

### **Owner**

The owner of this action controller.

```csharp
public Entity Owner { get; }
```

#### Property Value

[Entity](./SharpPluginLoader.Core.Entities.Entity.md)<br>

### **Instance**

The native pointer.

```csharp
public nint Instance { get; set; }
```

#### Property Value

[IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr)<br>

## Constructors

### **ActionController(IntPtr)**

```csharp
public ActionController(nint instance)
```

#### Parameters

`instance` [IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr)<br>

### **ActionController()**

```csharp
public ActionController()
```

## Methods

### **GetActionList(Int32)**

Gets an action list by its index.

```csharp
public ActionList GetActionList(int actionSet)
```

#### Parameters

`actionSet` [Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32)<br>
The index of the action set

#### Returns

[ActionList](./SharpPluginLoader.Core.Actions.ActionList.md)<br>
The list of actions for the requested action set

#### Exceptions

[ArgumentOutOfRangeException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentOutOfRangeException)<br>

### **DoAction(Int32, Int32)**

Makes the entity perform an action.

```csharp
public void DoAction(int actionSet, int actionId)
```

#### Parameters

`actionSet` [Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32)<br>
The action set to use

`actionId` [Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32)<br>
The id of the action within the action set

**Remarks:**

For monsters use the [Monster.ForceAction(Int32)](./SharpPluginLoader.Core.Entities.Monster.md#forceactionint32) method instead.
94 changes: 94 additions & 0 deletions docs/API/SharpPluginLoader.Core.Actions.ActionInfo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
# ActionInfo

Namespace: SharpPluginLoader.Core.Actions

Represents an action that can be performed by an entity.
This is a combination of an action set and an action id.

```csharp
public struct ActionInfo
```

Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object) → [ValueType](https://docs.microsoft.com/en-us/dotnet/api/System.ValueType) → [ActionInfo](./SharpPluginLoader.Core.Actions.ActionInfo.md)
## Fields

### **ActionSet**

The action set that this action belongs to.

```csharp
public int ActionSet;
```

### **ActionId**

The id of the action within the action set.

```csharp
public int ActionId;
```

## Constructors

### **ActionInfo(Int32, Int32)**

```csharp
ActionInfo(int actionSet, int actionId)
```

#### Parameters

`actionSet` [Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32)<br>
`actionId` [Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32)<br>
## Methods

### **Equals(ActionInfo)**

```csharp
bool Equals(ActionInfo other)
```

#### Parameters

`other` [ActionInfo](./SharpPluginLoader.Core.Actions.ActionInfo.md)<br>

#### Returns

[Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean)<br>
### **Equals(Object)**

```csharp
bool Equals(object obj)
```

#### Parameters

`obj` [Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object)<br>
#### Returns

[Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean)<br>
### **GetHashCode()**

```csharp
int GetHashCode()
```

#### Returns

[Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32)<br>
### **ToString()**

```csharp
string ToString()
```

#### Returns

[String](https://docs.microsoft.com/en-us/dotnet/api/System.String)<br>
35 changes: 35 additions & 0 deletions docs/API/SharpPluginLoader.Core.Actions.ActionList.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# ActionList

Namespace: SharpPluginLoader.Core.Actions

```csharp
public struct ActionList
```

Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object) → [ValueType](https://docs.microsoft.com/en-us/dotnet/api/System.ValueType) → [ActionList](./SharpPluginLoader.Core.Actions.ActionList.md)
## Fields

### **Actions**

```csharp
public nint Actions;
```

### **Count**

```csharp
public int Count;
```

## Properties

### **Item**

```csharp
public Action Item { get; set; }
```

#### Property Value

[Action](./SharpPluginLoader.Core.Actions.Action.md)<br>
35 changes: 35 additions & 0 deletions docs/API/SharpPluginLoader.Core.Area.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Area

Namespace: SharpPluginLoader.Core

Exposes functionality related to the sMhArea singleton.

```csharp
public static class Area
```

Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object) → [Area](./SharpPluginLoader.Core.Area.md)
## Properties

### **SingletonInstance**

```csharp
public static nint SingletonInstance { get; }
```

#### Property Value

[IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr)<br>
### **CurrentStage**

Gets the current area id.

```csharp
public static Stage CurrentStage { get; }
```

#### Property Value

[Stage](./SharpPluginLoader.Core.Stage.md)<br>
Loading

0 comments on commit 7ef5af8

Please sign in to comment.