-
Notifications
You must be signed in to change notification settings - Fork 0
/
insp-agenteventtype.html
311 lines (293 loc) · 13.6 KB
/
insp-agenteventtype.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
<!doctype html>
<html lang="en">
<head>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<link rel="icon" href="images/TotalAILogoTrans32.png" type="image/x-icon">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600|Roboto Mono&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Goldman&display=swap" rel="stylesheet">
<!-- Bootstrap CSS -->
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/css/bootstrap.min.css" integrity="sha384-9aIt2nRpC12Uk9gS9baDl411NQApFmC26EwAOH8WgZl5MYYxFfc+NcPb1dKGj7Sk" crossorigin="anonymous">
<link rel="stylesheet" href="main.css">
<title>Total AI</title>
</head>
<body>
<nav class="navbar sticky-top tai-navbar">
<a class="navbar-brand" style="margin-top: -8px; margin-bottom: -8px;" href="index.html">
<img src="images/TotalAILogoTrans.png" height="40" alt="" loading="lazy">
</a>
<ul class="nav mr-auto">
<li class="nav-item">
<a class="nav-link" href="index.html">Home <span class="sr-only">(current)</span></a>
</li>
<li class="nav-item">
<a class="nav-link" href="doc-introduction.html">Guide</a>
</li>
<li class="nav-item">
<a class="nav-link active" href="insp-introduction.html">Inspectors</a>
</li>
<li class="nav-item">
<a class="nav-link" href="script-introduction.html">Scripts</a>
</li>
<li class="nav-item">
<a class="nav-link" href="videos.html">Videos</a>
</li>
<li class="nav-item">
<a class="nav-link" href="contributors.html">Contributors</a>
</li>
<li class="nav-item">
<a class="nav-link" href="about.html">About</a>
</li>
<li class="nav-item" style="padding-left: 25px;">
<a class="nav-link" href="contrib-introduction.html">Contribute</a>
</li>
</ul>
<ul class="nav justify-content-end">
<li class="nav-item">
<a class="nav-link" target="_blank" href="https://discord.gg/PfKUm42Zax">
Discord
<svg width="1em" height="1em" viewBox="0 0 20 20" class="bi bi-box-arrow-up-right" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
<path fill-rule="evenodd" d="M8.636 3.5a.5.5 0 0 0-.5-.5H1.5A1.5 1.5 0 0 0 0 4.5v10A1.5 1.5 0 0 0 1.5 16h10a1.5 1.5 0 0 0 1.5-1.5V7.864a.5.5 0 0 0-1 0V14.5a.5.5 0 0 1-.5.5h-10a.5.5 0 0 1-.5-.5v-10a.5.5 0 0 1 .5-.5h6.636a.5.5 0 0 0 .5-.5z"/>
<path fill-rule="evenodd" d="M16 .5a.5.5 0 0 0-.5-.5h-5a.5.5 0 0 0 0 1h3.793L6.146 9.146a.5.5 0 1 0 .708.708L15 1.707V5.5a.5.5 0 0 0 1 0v-5z"/>
</svg>
</a>
</li>
<li class="nav-item">
<a class="nav-link" target="_blank" href="https://github.com/TotalAI/TotalAI">
GitHub
<svg width="1em" height="1em" viewBox="0 0 20 20" class="bi bi-box-arrow-up-right" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
<path fill-rule="evenodd" d="M8.636 3.5a.5.5 0 0 0-.5-.5H1.5A1.5 1.5 0 0 0 0 4.5v10A1.5 1.5 0 0 0 1.5 16h10a1.5 1.5 0 0 0 1.5-1.5V7.864a.5.5 0 0 0-1 0V14.5a.5.5 0 0 1-.5.5h-10a.5.5 0 0 1-.5-.5v-10a.5.5 0 0 1 .5-.5h6.636a.5.5 0 0 0 .5-.5z"/>
<path fill-rule="evenodd" d="M16 .5a.5.5 0 0 0-.5-.5h-5a.5.5 0 0 0 0 1h3.793L6.146 9.146a.5.5 0 1 0 .708.708L15 1.707V5.5a.5.5 0 0 0 1 0v-5z"/>
</svg>
</a>
</li>
<li class="nav-item">
<a class="nav-link" target="_blank" href="https://patreon.com/zacwarren">
Patreon
<svg width="1em" height="1em" viewBox="0 0 20 20" class="bi bi-box-arrow-up-right" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
<path fill-rule="evenodd" d="M8.636 3.5a.5.5 0 0 0-.5-.5H1.5A1.5 1.5 0 0 0 0 4.5v10A1.5 1.5 0 0 0 1.5 16h10a1.5 1.5 0 0 0 1.5-1.5V7.864a.5.5 0 0 0-1 0V14.5a.5.5 0 0 1-.5.5h-10a.5.5 0 0 1-.5-.5v-10a.5.5 0 0 1 .5-.5h6.636a.5.5 0 0 0 .5-.5z"/>
<path fill-rule="evenodd" d="M16 .5a.5.5 0 0 0-.5-.5h-5a.5.5 0 0 0 0 1h3.793L6.146 9.146a.5.5 0 1 0 .708.708L15 1.707V5.5a.5.5 0 0 0 1 0v-5z"/>
</svg>
</a>
</li>
</ul>
</nav>
<main style="width: 100%">
<div class="container-fluid">
<div class="row flex-xl-nowrap">
<div class="col-md-3 col-xl-2" style="position: sticky; top: 0; z-index: 1000; height: calc(100vh - 4rem); order: 0; overflow-y: auto; padding-top: 10px; padding-bottom: 40px;">
<h3 class="nav-header">Components</h3>
<ul class="nav flex-column">
<li class="nav-item">
<a class="nav-link" href="insp-agent.html">Agent</a>
</li>
<li class="nav-item">
<a class="nav-link" href="insp-agentevent.html">Agent Event</a>
</li>
<li class="nav-item">
<a class="nav-link" href="insp-entity.html">Entity</a>
</li>
<li class="nav-item">
<a class="nav-link" href="insp-worldobject.html">World Object</a>
</li>
</ul>
<h3 class="nav-header">ScriptableObjects</h3>
<ul class="nav flex-column">
<li class="nav-item">
<a class="nav-link" href="insp-actiontype.html">Action Type</a>
</li>
<li class="nav-item">
<a class="nav-link" href="insp-agenttype.html">Agent Type</a>
</li>
<li class="nav-item">
<a class="nav-link active" href="insp-agenteventtype.html">Agent Event Type</a>
</li>
<li class="nav-item">
<a class="nav-link" href="insp-drivetype.html">Drive Type</a>
</li>
<li class="nav-item">
<a class="nav-link" href="insp-entitytrigger.html">Entity Trigger</a>
</li>
<li class="nav-item">
<a class="nav-link" href="insp-entitytype.html">Entity Type</a>
</li>
<li class="nav-item">
<a class="nav-link" href="insp-faction.html">Faction</a>
</li>
<li class="nav-item">
<a class="nav-link" href="insp-inventoryslot.html">Inventory Slot</a>
</li>
<li class="nav-item">
<a class="nav-link" href="insp-itemcondition.html">Item Condition</a>
</li>
<li class="nav-item">
<a class="nav-link" href="insp-mappingtype.html">Mapping Type</a>
</li>
<li class="nav-item">
<a class="nav-link" href="insp-roletype.html">Role Type</a>
</li>
<li class="nav-item">
<a class="nav-link" href="insp-selectortype.html">Selector Type</a>
</li>
<li class="nav-item">
<a class="nav-link" href="insp-worldobjecttype.html">World Object Type</a>
</li>
</ul>
<h3 class="nav-header">Plain C# Classes</h3>
<ul class="nav flex-column">
<li class="nav-item">
<a class="nav-link" href="insp-inputcondition.html">Input Condition</a>
</li>
<li class="nav-item">
<a class="nav-link" href="insp-outputchange.html">Output Change</a>
</li>
</ul>
</div>
<div class="col-md-1">
</div>
<div class="col content" style="padding-top: 40px; padding-bottom: 40px; line-height: 1.6em; color: #304455; font-size: 1rem;">
<h1><nobr>AgentEventType : EntityType : ScriptableObject</nobr></h1>
<h3>What is an Agent Event Type?</h3>
<hr>
<p>
An Agent Event Type contains the main configuration for an Agent Event. It inherits from Entity Type which
is also the base class for Agent Type and World Object Type.
<br><br>
See <a class="text-link" href="doc-agentevent.html">Agent Event</a> for more info.
</p>
<h3>Agent Event Type Custom Inspector</h3>
<hr>
<img src="images/AgentEventType.png">
<h3>Entity Type Fields</h3>
<hr>
<p>
See <a class="text-link" href="insp-entitytype.html">Entity Type</a> for info on Entity Type Info, Prefab Variants,
Placement Info, Tags, Inventory, and Entity Triggers.
</p>
<h3>Timing</h3>
<hr>
<img src="images/AETTiming.png">
<table class="table table-dark table-striped table-tai">
<tr>
<td><nobr>Max Time To Wait</nobr></td>
<td>How long to wait for min number of attendees? If this time is exceeded the Agent Event will terminate.</td>
</tr>
<tr>
<td>Time To Wait After Min</td>
<td>Once the min number of attendees is reached, how long to wait for more Agents to join?</td>
</tr>
<tr>
<td>Include Go To Agents</td>
<td>
Should Agents that are currently going to the Agent Event be counted?
Check this to avoid Agent Events from being cancelled when
Max Time To Wait is reached but enough Agents are going to the event.
</td>
</tr>
<tr>
<td>Running Time Limit</td>
<td>Max time for event to run for. Leave at None for no limit. The length of a game hour is set in the Scene's TimeManager.</td>
</tr>
<tr>
<td>End When Creator Quits</td>
<td>If the creator quits should the event end? Agents can quit Agent Events at any time.</td>
</tr>
<tr>
<td>End When Less Than Min</td>
<td>If a running event goes below min number of attendees should it end? Agents can quit Agent Events at any time.</td>
</tr>
</table>
<h3>Attendees</h3>
<hr>
<img src="images/AETAttendees.png">
<table class="table table-dark table-striped table-tai">
<tr>
<td>Only Faction Members</td>
<td>A Bool indicating if the attendees must be in the same Faction as the creator.</td>
</tr>
<tr>
<td>R Level Min</td>
<td>
What relationship level (R Level) must the attendee have with the Creator?
This R Level comes from the Creator's memory. (Creator's view of the attendee.)
</td>
</tr>
<tr>
<td>Min Attendees</td>
<td>Minimum number of attendees for this Agent Event to run.</td>
</tr>
<tr>
<td><nobr>Max Attendees</nobr></td>
<td>Maximum number of attendees for this Agent Event.</td>
</tr>
</table>
<h3>Sound</h3>
<hr>
<img src="images/AETSound.png">
<table class="table table-dark table-striped table-tai">
<tr>
<td><nobr>Sound For Waiting</nobr></td>
<td>Will play the selected Audio Clip while the Agent Event is in the Waiting state.</td>
</tr>
<tr>
<td>Loop</td>
<td>Should this sound loop?</td>
</tr>
</table>
<h3>Role Types</h3>
<hr>
<p>
Assign role types to the attendees. Role Types can completely change an Agent's Drives and Actions.
When the Agent Event is over the Role Types are removed, unless the Role Type was active before the Event.
</p>
<img src="images/AETRoleTypes.png">
<table class="table table-dark table-striped table-tai">
<tr>
<td>Role Mapping Type</td>
<td>Creator Attendee, Join Order, or Has Role Type: What criteria type to use to assign role types to attendees?</td>
</tr>
<tr>
<td><nobr>How Many Mappings?</nobr></td>
<td>How many criteria to Role Types mappings are there?</td>
</tr>
<tr>
<td>For Creator</td>
<td>Is this for the creator or the attendee?</td>
</tr>
<tr>
<td>Mapping Join Orders</td>
<td>A list of join order positions that get these Role Types.</td>
</tr>
<tr>
<td>Mapping Role Types</td>
<td>List of Role Types. If any match the Agent will get these role types.</td>
</tr>
<tr>
<td>Role Types</td>
<td>All of these will be added to the Agent if they match the above criteria.</td>
</tr>
</table>
</div>
<div class="col-md-3">
</div>
</div>
</main>
<script>
$(document).ready(function() {
$(window).resize(function() {
resize();
});
function resize() {
var myheight = $(window).outerHeight(true) - 0;
$('.main').outerHeight(myheight);
}
resize();
});
</script>
<script src="https://code.jquery.com/jquery-3.5.1.slim.min.js" integrity="sha384-DfXdz2htPH0lsSSs5nCTpuj/zy4C+OGpamoFVy38MVBnE+IbbVYUew+OrCXaRkfj" crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.0/dist/umd/popper.min.js" integrity="sha384-Q6E9RHvbIyZFJoft+2mJbHaEWldlvI9IOYy5n3zV9zzTtmI3UksdQRVvoxMfooAo" crossorigin="anonymous"></script>
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/js/bootstrap.min.js" integrity="sha384-OgVRvuATP1z7JjHLkuOU7Xw704+h835Lr+6QL9UvYjZE3Ipu6Tp75j7Bh/kR0JKI" crossorigin="anonymous"></script>
</body>
</html>