Difference between revisions of "Angelscript"
Jump to navigation
Jump to search
Outerbeast (talk | contribs) m |
Outerbeast (talk | contribs) m (Added Misc Table) |
||
| Line 3: | Line 3: | ||
[https://r4to0.github.io/asautodocs/nd_prerelease/index.html API auto-generated documentation is available here.] | [https://r4to0.github.io/asautodocs/nd_prerelease/index.html API auto-generated documentation is available here.] | ||
For information on the AngelScript language, visit the [https://www.angelcode.com/angelscript/sdk/docs/manual/doc_script.html official AngelScript manual here] | For information on the AngelScript language, visit the [https://www.angelcode.com/angelscript/sdk/docs/manual/doc_script.html official AngelScript manual here] | ||
| − | + | == Getting Started == | |
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
| Line 30: | Line 30: | ||
| style="vertical-align:middle; " | Build your own custom entity | | style="vertical-align:middle; " | Build your own custom entity | ||
|} | |} | ||
| − | + | == API Features == | |
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
| Line 81: | Line 81: | ||
| style="vertical-align:middle; " | Covers the use of temporary entities. | | style="vertical-align:middle; " | Covers the use of temporary entities. | ||
|- | |- | ||
| − | | style="text-decoration:underline; " | [[ | + | | style="text-decoration:underline; " | [[File System]] |
| − | | style="vertical-align:middle; " | | + | | style="vertical-align:middle; " | Covers the usage of the the file system |
|} | |} | ||
| − | + | == Data Types == | |
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
! style="text-decoration:underline;" | Data Types | ! style="text-decoration:underline;" | Data Types | ||
| − | ! style="vertical-align:middle;" | Covers some common data | + | ! style="vertical-align:middle;" | Covers some common data types used in scripts |
|- | |- | ||
| style="text-decoration:underline;" | [[Strings]] | | style="text-decoration:underline;" | [[Strings]] | ||
| Line 101: | Line 101: | ||
| style="text-decoration:underline;" | [[EHandle]] | | style="text-decoration:underline;" | [[EHandle]] | ||
| style="vertical-align:middle;" | Covers the usage of EHandle for storing entity handles | | style="vertical-align:middle;" | Covers the usage of EHandle for storing entity handles | ||
| + | |- | ||
| + | | style="text-decoration:underline;" | [[CCVar]] | ||
| + | | style="vertical-align:middle;" | Covers how to create and use custom CVars | ||
| + | |- | ||
| + | |} | ||
| + | |||
| + | == Miscellaneous == | ||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | ! style="text-decoration:underline;" | Page | ||
| + | ! style="vertical-align:middle;" | Description | ||
| + | |- | ||
| + | | style="text-decoration:underline;" | [[Animation Extensions]] | ||
| + | | style="vertical-align:middle;" | Animation Extensions used by weapons for player models. | ||
| + | |- | ||
| + | | style="text-decoration:underline;" | [[Default Ammo Types]] | ||
| + | | style="vertical-align:middle;" | Default Ammo Types used by the game. | ||
|- | |- | ||
|} | |} | ||
Revision as of 18:26, 13 February 2025
This page contains basic coverage and tutorials for Sven Co-op's Angelscript API.
API auto-generated documentation is available here. For information on the AngelScript language, visit the official AngelScript manual here
1 Getting Started
| Tutorials | Basics of building scripts |
|---|---|
| Running Scripts | Covers how to import and execute script files, such as map scripts and plugins |
| Typecasting | Covers how and when to use typecasts |
| Debugging | Debugging scripts |
| trigger_script | Build a trigger_script entity function |
| squadmaker function | Describes the usage of the squadmaker entity to call script functions. |
| ondestroyfn | Describes the usage of the "ondestroyfn" function |
| Custom Entities | Build your own custom entity |
2 API Features
| API Features | Covers some fundamental aspects of writing scripts for Sven Co-op |
|---|---|
| Global Functions | Global Functions available for use. |
| Entity Basics | Covers the basics of what entities are and how to use them. |
| Entity Intermediate | Covers intermediate topics regarding entities. |
| Entity Functions | How to use the various entity functions. |
| Player | Various player related functions |
| Sound System | How to use the sound system. |
| Engine Functions | How to use engine functions. |
| Custom Keyvalues | Covers the usage of custom keyvalues in scripts. |
| CEngine | Covers the CEngine class. This class includes the current time and frametime, as well as engine configuration and the global trace. |
| CGame | Contains methods integral to the game's operation. |
| Tracing | Covers performing traces and usage of the TraceResult class, as well as related enumerations. |
| Hooks | Covers the purpose and use of hooks. |
| Scheduler | Covers the use of the scheduler. |
| Entity Variables | Covers the usage of the entvars_t structure |
| Temporary Entities | Covers the use of temporary entities. |
| File System | Covers the usage of the the file system |
3 Data Types
| Data Types | Covers some common data types used in scripts |
|---|---|
| Strings | Covers the basics of strings in scripts |
| Vectors | Covers the basics of Vectors in scripts |
| RGBA | Covers the basics of the RGBA structure |
| EHandle | Covers the usage of EHandle for storing entity handles |
| CCVar | Covers how to create and use custom CVars |
4 Miscellaneous
| Page | Description |
|---|---|
| Animation Extensions | Animation Extensions used by weapons for player models. |
| Default Ammo Types | Default Ammo Types used by the game. |