Updated VScript in Mapbase (markdown)

Blixibon 2020-06-13 12:16:55 -05:00
parent fa01f03a08
commit 3f60abefa6

@ -79,9 +79,14 @@ Some features from Valve's games are not available in Mapbase's implementation o
* `Entities` * `Entities`
* `Convars` * `Convars`
* `NetProps` * `NetProps`
* `SetAngles` now takes a `Vector` instead of a separate pitch, yaw, and roll, similar to `SetOrigin`. * `script_debug` is not supported.
* In the source code, the following `IScriptVM` functions are currently unsupported: `ConnectDebugger`, `DisconnectDebugger`, `AddSearchPath`, `Frame`, `DumpState`, `SetOutputCallback`, `SetErrorCallback` * In the source code, the following `IScriptVM` functions are currently unsupported: `ConnectDebugger`, `DisconnectDebugger`, `AddSearchPath`, `Frame`, `DumpState`, `SetOutputCallback`, `SetErrorCallback`
The following differences are intentional:
* `SetAngles` now takes a `Vector` instead of a separate pitch, yaw, and roll, similar to `SetOrigin`.
* `EntFire` can now take an optional caller at the end and `EntFireByHandle` no longer requires all parameters.
# Tutorials # Tutorials
A few tutorials are available for using VScript in Mapbase. A few tutorials are available for using VScript in Mapbase.
@ -109,7 +114,6 @@ These are functions that can be accessed globally and without a class.
| Signature | Description | | Signature | Description |
|:------------- | :-----| |:------------- | :-----|
| *handle* SpawnEntityFromKeyValues(string *className*, handle *keyValues*)| Spawns an entity with the keyvalues in a CScriptKeyValues handle. |
| *handle* GameOver(string *message*, float *delay*, float *fadeTime*, float *loadTime*, int *r*, int *g*, int *b*)| Ends the game and reloads the last save. | | *handle* GameOver(string *message*, float *delay*, float *fadeTime*, float *loadTime*, int *r*, int *g*, int *b*)| Ends the game and reloads the last save. |
| *bool* MegaPhyscannonActive()| Checks if supercharged gravity gun mode is enabled. | | *bool* MegaPhyscannonActive()| Checks if supercharged gravity gun mode is enabled. |
| *void* printc(string *text*)| Version of print() which takes a color before the message. | | *void* printc(string *text*)| Version of print() which takes a color before the message. |
@ -117,6 +121,16 @@ These are functions that can be accessed globally and without a class.
*** ***
### Entities
These global functions are related to entities.
| Signature | Description |
|:------------- | :-----|
| *handle* SpawnEntityFromKeyValues(*string* className, *handle* keyValues)| Spawns an entity with the keyvalues in a CScriptKeyValues handle. |
| *void* EntitiesInBox(*handle* table, *int* listMax, *Vector* hullMin, *Vector* hullMax, *int* iMask)| Gets all entities which are within a worldspace box. |
| *void* EntitiesAtPoint(*handle* table, *int* listMax, *Vector* point, *int* iMask)| Gets all entities which are intersecting a point in space. |
| *void* EntitiesInSphere(*handle* table, *int* listMax, *Vector* center, *float* radius, *int* iMask)| Gets all entities which are within a sphere. |
### Math ### Math
These global functions are related to math or math-related classes. These global functions are related to math or math-related classes.
@ -485,10 +499,12 @@ All-purpose Mapbase system primarily used for map-specific files. Can be accesse
| Signature | Description | | Signature | Description |
|:------------- | :-----| |:------------- | :-----|
| *void* AddManifestFile(string *fileName*)| Loads a manifest file. | | *void* AddManifestFile(*string* fileName)| Loads a manifest file. |
| *void* LoadSoundscriptFile(string *fileName*)| Loads a custom soundscript file. | | *void* LoadSoundscriptFile(*string* fileName)| Loads a custom soundscript file. |
| *void* LoadTalkerFile(string *fileName*)| Loads a custom talker file. | | *void* LoadTalkerFile(*string* fileName)| Loads a custom talker file. |
| *void* LoadActbusyFile(string *fileName*)| Loads a custom actbusy file. | | *void* LoadActbusyFile(*string* fileName)| Loads a custom actbusy file. |
| *string* GetModName()| Gets the name of the mod. This is the name which shows up on Steam, RPC, etc. |
| *bool* IsCoreMapbase()| Indicates whether this is one of the original Mapbase mods or just a separate mod using its code. |
*** ***