Skip to content
This repository was archived by the owner on Jun 21, 2025. It is now read-only.

Commit a1ea4f8

Browse files
committed
Docs update
1 parent 4913810 commit a1ea4f8

19 files changed

Lines changed: 492 additions & 348 deletions

NwPluginAPI.Docs/log.txt

Lines changed: 90 additions & 0 deletions
Large diffs are not rendered by default.

docs/.manifest

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,6 @@
148148
"PluginAPI.Core.Factories.PlayerFactory": "PluginAPI.Core.Factories.PlayerFactory.yml",
149149
"PluginAPI.Core.Factories.PlayerFactory.BaseType": "PluginAPI.Core.Factories.PlayerFactory.yml",
150150
"PluginAPI.Core.Factories.PlayerFactory.Create(PluginAPI.Core.Interfaces.IGameComponent)": "PluginAPI.Core.Factories.PlayerFactory.yml",
151-
"PluginAPI.Core.Factories.PlayerFactory.DefaultServer": "PluginAPI.Core.Factories.PlayerFactory.yml",
152151
"PluginAPI.Core.FactoryManager": "PluginAPI.Core.FactoryManager.yml",
153152
"PluginAPI.Core.FactoryManager.Init": "PluginAPI.Core.FactoryManager.yml",
154153
"PluginAPI.Core.FactoryManager.RegisterPlayerFactory(System.Object,PluginAPI.Core.Factories.PlayerFactory)": "PluginAPI.Core.FactoryManager.yml",
@@ -403,6 +402,7 @@
403402
"PluginAPI.Core.Server.KickPlayer(PluginAPI.Core.Player,System.String)": "PluginAPI.Core.Server.yml",
404403
"PluginAPI.Core.Server.MaxPlayers": "PluginAPI.Core.Server.yml",
405404
"PluginAPI.Core.Server.Port": "PluginAPI.Core.Server.yml",
405+
"PluginAPI.Core.Server.ReservedSlots": "PluginAPI.Core.Server.yml",
406406
"PluginAPI.Core.Server.Restart": "PluginAPI.Core.Server.yml",
407407
"PluginAPI.Core.Server.Restart(System.UInt16)": "PluginAPI.Core.Server.yml",
408408
"PluginAPI.Core.Server.RunCommand(System.String,CommandSender)": "PluginAPI.Core.Server.yml",
@@ -590,7 +590,9 @@
590590
"PluginAPI.Enums.ServerEventType": "PluginAPI.Enums.ServerEventType.yml",
591591
"PluginAPI.Enums.ServerEventType.BanIssued": "PluginAPI.Enums.ServerEventType.yml",
592592
"PluginAPI.Enums.ServerEventType.BanRevoked": "PluginAPI.Enums.ServerEventType.yml",
593+
"PluginAPI.Enums.ServerEventType.BanUpdated": "PluginAPI.Enums.ServerEventType.yml",
593594
"PluginAPI.Enums.ServerEventType.ConsoleCommand": "PluginAPI.Enums.ServerEventType.yml",
595+
"PluginAPI.Enums.ServerEventType.ConsoleCommandExecuted": "PluginAPI.Enums.ServerEventType.yml",
594596
"PluginAPI.Enums.ServerEventType.GeneratorActivated": "PluginAPI.Enums.ServerEventType.yml",
595597
"PluginAPI.Enums.ServerEventType.GrenadeExploded": "PluginAPI.Enums.ServerEventType.yml",
596598
"PluginAPI.Enums.ServerEventType.ItemSpawned": "PluginAPI.Enums.ServerEventType.yml",
@@ -622,6 +624,7 @@
622624
"PluginAPI.Enums.ServerEventType.PlayerEscape": "PluginAPI.Enums.ServerEventType.yml",
623625
"PluginAPI.Enums.ServerEventType.PlayerExitPocketDimension": "PluginAPI.Enums.ServerEventType.yml",
624626
"PluginAPI.Enums.ServerEventType.PlayerGameConsoleCommand": "PluginAPI.Enums.ServerEventType.yml",
627+
"PluginAPI.Enums.ServerEventType.PlayerGameConsoleCommandExecuted": "PluginAPI.Enums.ServerEventType.yml",
625628
"PluginAPI.Enums.ServerEventType.PlayerHandcuff": "PluginAPI.Enums.ServerEventType.yml",
626629
"PluginAPI.Enums.ServerEventType.PlayerInteractDoor": "PluginAPI.Enums.ServerEventType.yml",
627630
"PluginAPI.Enums.ServerEventType.PlayerInteractElevator": "PluginAPI.Enums.ServerEventType.yml",
@@ -641,6 +644,7 @@
641644
"PluginAPI.Enums.ServerEventType.PlayerReceiveEffect": "PluginAPI.Enums.ServerEventType.yml",
642645
"PluginAPI.Enums.ServerEventType.PlayerReloadWeapon": "PluginAPI.Enums.ServerEventType.yml",
643646
"PluginAPI.Enums.ServerEventType.PlayerRemoteAdminCommand": "PluginAPI.Enums.ServerEventType.yml",
647+
"PluginAPI.Enums.ServerEventType.PlayerRemoteAdminCommandExecuted": "PluginAPI.Enums.ServerEventType.yml",
644648
"PluginAPI.Enums.ServerEventType.PlayerRemoveHandcuffs": "PluginAPI.Enums.ServerEventType.yml",
645649
"PluginAPI.Enums.ServerEventType.PlayerReport": "PluginAPI.Enums.ServerEventType.yml",
646650
"PluginAPI.Enums.ServerEventType.PlayerSearchedPickup": "PluginAPI.Enums.ServerEventType.yml",

docs/PluginAPI.Core.Factories.Factory-1.yml

Lines changed: 28 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -101,46 +101,46 @@ items:
101101
- Public
102102
fullName.vb: PluginAPI.Core.Factories.Factory(Of T).Get()
103103
- uid: PluginAPI.Core.Factories.Factory`1.DefaultServer
104-
commentId: M:PluginAPI.Core.Factories.Factory`1.DefaultServer
104+
commentId: P:PluginAPI.Core.Factories.Factory`1.DefaultServer
105105
id: DefaultServer
106106
parent: PluginAPI.Core.Factories.Factory`1
107107
langs:
108108
- csharp
109109
- vb
110-
name: DefaultServer()
111-
nameWithType: Factory<T>.DefaultServer()
112-
fullName: PluginAPI.Core.Factories.Factory<T>.DefaultServer()
113-
type: Method
110+
name: DefaultServer
111+
nameWithType: Factory<T>.DefaultServer
112+
fullName: PluginAPI.Core.Factories.Factory<T>.DefaultServer
113+
type: Property
114114
source:
115115
remote:
116116
path: NwPluginAPI/Core/Factories/Factory.cs
117117
branch: master
118118
repo: git@github.com:northwood-studios/NwPluginAPI.git
119119
id: DefaultServer
120120
path: ../NwPluginAPI/Core/Factories/Factory.cs
121-
startLine: 23
121+
startLine: 22
122122
assemblies:
123123
- PluginAPI
124124
namespace: PluginAPI.Core.Factories
125125
summary: "\nDefault server entity.\n"
126126
example: []
127127
syntax:
128-
content: public virtual T DefaultServer()
128+
content: public T DefaultServer { get; set; }
129+
parameters: []
129130
return:
130131
type: '{T}'
131-
description: Entity
132-
content.vb: Public Overridable Function DefaultServer As T
132+
content.vb: Public Property DefaultServer As T
133133
overload: PluginAPI.Core.Factories.Factory`1.DefaultServer*
134134
implements:
135135
- PluginAPI.Core.Factories.IEntityFactory{{T}}.DefaultServer
136-
nameWithType.vb: Factory(Of T).DefaultServer()
136+
nameWithType.vb: Factory(Of T).DefaultServer
137137
modifiers.csharp:
138138
- public
139-
- virtual
139+
- get
140+
- set
140141
modifiers.vb:
141142
- Public
142-
- Overridable
143-
fullName.vb: PluginAPI.Core.Factories.Factory(Of T).DefaultServer()
143+
fullName.vb: PluginAPI.Core.Factories.Factory(Of T).DefaultServer
144144
- uid: PluginAPI.Core.Factories.Factory`1.Create(PluginAPI.Core.Interfaces.IGameComponent)
145145
commentId: M:PluginAPI.Core.Factories.Factory`1.Create(PluginAPI.Core.Interfaces.IGameComponent)
146146
id: Create(PluginAPI.Core.Interfaces.IGameComponent)
@@ -159,7 +159,7 @@ items:
159159
repo: git@github.com:northwood-studios/NwPluginAPI.git
160160
id: Create
161161
path: ../NwPluginAPI/Core/Factories/Factory.cs
162-
startLine: 30
162+
startLine: 29
163163
assemblies:
164164
- PluginAPI
165165
namespace: PluginAPI.Core.Factories
@@ -204,7 +204,7 @@ items:
204204
repo: git@github.com:northwood-studios/NwPluginAPI.git
205205
id: GetOrAdd
206206
path: ../NwPluginAPI/Core/Factories/Factory.cs
207-
startLine: 37
207+
startLine: 36
208208
assemblies:
209209
- PluginAPI
210210
namespace: PluginAPI.Core.Factories
@@ -247,7 +247,7 @@ items:
247247
repo: git@github.com:northwood-studios/NwPluginAPI.git
248248
id: AddIfNotExists
249249
path: ../NwPluginAPI/Core/Factories/Factory.cs
250-
startLine: 54
250+
startLine: 57
251251
assemblies:
252252
- PluginAPI
253253
namespace: PluginAPI.Core.Factories
@@ -801,71 +801,27 @@ references:
801801
nameWithType.vb: Factory(Of T).DefaultServer
802802
fullName.vb: PluginAPI.Core.Factories.Factory(Of T).DefaultServer
803803
- uid: PluginAPI.Core.Factories.IEntityFactory{{T}}.DefaultServer
804-
commentId: M:PluginAPI.Core.Factories.IEntityFactory{`0}.DefaultServer
804+
commentId: P:PluginAPI.Core.Factories.IEntityFactory{`0}.DefaultServer
805805
parent: PluginAPI.Core.Factories.IEntityFactory{{T}}
806806
definition: PluginAPI.Core.Factories.IEntityFactory`1.DefaultServer
807-
name: DefaultServer()
808-
nameWithType: IEntityFactory<T>.DefaultServer()
809-
fullName: PluginAPI.Core.Factories.IEntityFactory<T>.DefaultServer()
810-
nameWithType.vb: IEntityFactory(Of T).DefaultServer()
811-
fullName.vb: PluginAPI.Core.Factories.IEntityFactory(Of T).DefaultServer()
812-
spec.csharp:
813-
- uid: PluginAPI.Core.Factories.IEntityFactory`1.DefaultServer
814-
name: DefaultServer
815-
nameWithType: IEntityFactory<T>.DefaultServer
816-
fullName: PluginAPI.Core.Factories.IEntityFactory<T>.DefaultServer
817-
- name: (
818-
nameWithType: (
819-
fullName: (
820-
- name: )
821-
nameWithType: )
822-
fullName: )
823-
spec.vb:
824-
- uid: PluginAPI.Core.Factories.IEntityFactory`1.DefaultServer
825-
name: DefaultServer
826-
nameWithType: IEntityFactory(Of T).DefaultServer
827-
fullName: PluginAPI.Core.Factories.IEntityFactory(Of T).DefaultServer
828-
- name: (
829-
nameWithType: (
830-
fullName: (
831-
- name: )
832-
nameWithType: )
833-
fullName: )
807+
name: DefaultServer
808+
nameWithType: IEntityFactory<T>.DefaultServer
809+
fullName: PluginAPI.Core.Factories.IEntityFactory<T>.DefaultServer
810+
nameWithType.vb: IEntityFactory(Of T).DefaultServer
811+
fullName.vb: PluginAPI.Core.Factories.IEntityFactory(Of T).DefaultServer
834812
- uid: '{T}'
835813
commentId: '!:T'
836814
definition: T
837815
name: T
838816
nameWithType: T
839817
fullName: T
840818
- uid: PluginAPI.Core.Factories.IEntityFactory`1.DefaultServer
841-
commentId: M:PluginAPI.Core.Factories.IEntityFactory`1.DefaultServer
842-
name: DefaultServer()
843-
nameWithType: IEntityFactory<TEntity>.DefaultServer()
844-
fullName: PluginAPI.Core.Factories.IEntityFactory<TEntity>.DefaultServer()
845-
nameWithType.vb: IEntityFactory(Of TEntity).DefaultServer()
846-
fullName.vb: PluginAPI.Core.Factories.IEntityFactory(Of TEntity).DefaultServer()
847-
spec.csharp:
848-
- uid: PluginAPI.Core.Factories.IEntityFactory`1.DefaultServer
849-
name: DefaultServer
850-
nameWithType: IEntityFactory<TEntity>.DefaultServer
851-
fullName: PluginAPI.Core.Factories.IEntityFactory<TEntity>.DefaultServer
852-
- name: (
853-
nameWithType: (
854-
fullName: (
855-
- name: )
856-
nameWithType: )
857-
fullName: )
858-
spec.vb:
859-
- uid: PluginAPI.Core.Factories.IEntityFactory`1.DefaultServer
860-
name: DefaultServer
861-
nameWithType: IEntityFactory(Of TEntity).DefaultServer
862-
fullName: PluginAPI.Core.Factories.IEntityFactory(Of TEntity).DefaultServer
863-
- name: (
864-
nameWithType: (
865-
fullName: (
866-
- name: )
867-
nameWithType: )
868-
fullName: )
819+
commentId: P:PluginAPI.Core.Factories.IEntityFactory`1.DefaultServer
820+
name: DefaultServer
821+
nameWithType: IEntityFactory<TEntity>.DefaultServer
822+
fullName: PluginAPI.Core.Factories.IEntityFactory<TEntity>.DefaultServer
823+
nameWithType.vb: IEntityFactory(Of TEntity).DefaultServer
824+
fullName.vb: PluginAPI.Core.Factories.IEntityFactory(Of TEntity).DefaultServer
869825
- uid: T
870826
name: T
871827
nameWithType: T

docs/PluginAPI.Core.Factories.IEntityFactory-1.yml

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -49,16 +49,16 @@ items:
4949
fullName.vb: PluginAPI.Core.Factories.IEntityFactory(Of TEntity)
5050
name.vb: IEntityFactory(Of TEntity)
5151
- uid: PluginAPI.Core.Factories.IEntityFactory`1.DefaultServer
52-
commentId: M:PluginAPI.Core.Factories.IEntityFactory`1.DefaultServer
52+
commentId: P:PluginAPI.Core.Factories.IEntityFactory`1.DefaultServer
5353
id: DefaultServer
5454
parent: PluginAPI.Core.Factories.IEntityFactory`1
5555
langs:
5656
- csharp
5757
- vb
58-
name: DefaultServer()
59-
nameWithType: IEntityFactory<TEntity>.DefaultServer()
60-
fullName: PluginAPI.Core.Factories.IEntityFactory<TEntity>.DefaultServer()
61-
type: Method
58+
name: DefaultServer
59+
nameWithType: IEntityFactory<TEntity>.DefaultServer
60+
fullName: PluginAPI.Core.Factories.IEntityFactory<TEntity>.DefaultServer
61+
type: Property
6262
source:
6363
remote:
6464
path: NwPluginAPI/Core/Factories/IEntityFactory.cs
@@ -71,13 +71,17 @@ items:
7171
- PluginAPI
7272
namespace: PluginAPI.Core.Factories
7373
syntax:
74-
content: TEntity DefaultServer()
74+
content: TEntity DefaultServer { get; set; }
75+
parameters: []
7576
return:
7677
type: '{TEntity}'
77-
content.vb: Function DefaultServer As TEntity
78+
content.vb: Property DefaultServer As TEntity
7879
overload: PluginAPI.Core.Factories.IEntityFactory`1.DefaultServer*
79-
nameWithType.vb: IEntityFactory(Of TEntity).DefaultServer()
80-
fullName.vb: PluginAPI.Core.Factories.IEntityFactory(Of TEntity).DefaultServer()
80+
nameWithType.vb: IEntityFactory(Of TEntity).DefaultServer
81+
modifiers.csharp:
82+
- get
83+
- set
84+
fullName.vb: PluginAPI.Core.Factories.IEntityFactory(Of TEntity).DefaultServer
8185
- uid: PluginAPI.Core.Factories.IEntityFactory`1.Create(PluginAPI.Core.Interfaces.IGameComponent)
8286
commentId: M:PluginAPI.Core.Factories.IEntityFactory`1.Create(PluginAPI.Core.Interfaces.IGameComponent)
8387
id: Create(PluginAPI.Core.Interfaces.IGameComponent)

0 commit comments

Comments
 (0)