Difference between revisions of "Character Script External Code"

From Wolfire Games Wiki
Jump to: navigation, search
m
Line 1: Line 1:
 
This is a list of the external code that is only available to be used inside a character script - variables, functions, and classes that "magically" exist.
 
This is a list of the external code that is only available to be used inside a character script - variables, functions, and classes that "magically" exist.
  
To see a list of external code that is available to all scripts, please see this page - '''TODO''': Page link here.
+
To see a list of external code that is available to all scripts, please see this page - [[Common Script External Code]]
  
 
This list is pulled from the ~/Documents/Wolfire/Overgrowth/aschar_docs.h file, which is automatically generated by the game.
 
This list is pulled from the ~/Documents/Wolfire/Overgrowth/aschar_docs.h file, which is automatically generated by the game.
  
See this page to find the location for the Wolfire/Overgrowth folder on each OS - http://wiki.wolfire.com/index.php/How_to_clear_the_game's_cache
+
See this page to find the location for the Wolfire/Overgrowth folder on each OS - [[How to clear the game's cache]]
  
 
'''TODO''': These can be documented individually, possibly on their own pages
 
'''TODO''': These can be documented individually, possibly on their own pages

Revision as of 12:13, 4 November 2017

This is a list of the external code that is only available to be used inside a character script - variables, functions, and classes that "magically" exist.

To see a list of external code that is available to all scripts, please see this page - Common Script External Code

This list is pulled from the ~/Documents/Wolfire/Overgrowth/aschar_docs.h file, which is automatically generated by the game.

See this page to find the location for the Wolfire/Overgrowth folder on each OS - How to clear the game's cache

TODO: These can be documented individually, possibly on their own pages

Global Variables

ASCollisions col; // Used to access collision functions
ScriptParams params;
ReactionScriptGetter reaction_getter;
SphereCollision sphere_col; // Stores results of collision functions
MovementObject this_mo;

Constants

enum AnimationFlags : uint8;
enum AttackerDirectionType : int;
enum AttackerHeightType : int;
enum CollisionSides;
enum NavPathFlag;
enum SamplePolyFlag;

Global Functions

float GetAnimationEventTime( string &in anim_path, string &in event_label );
NavPoint GetNavPoint(vec3);
vec3 GetNavPointPos(vec3);
NavPath GetPath(vec3 start, vec3 end);
NavPath GetPath(vec3 start, vec3 end, uint16 include_poly_flags, uint16 exclude_poly_flags);
vec3 LineLineIntersect(vec3 start_a, vec3 end_a, vec3 start_b, vec3 end_b);  // Get closest point between two line segments
vec3 NavRaycast(vec3 start, vec3 end);
vec3 NavRaycastSlide(vec3 start, vec3 end, int depth);

Classes

class ASCollisions;
class AttackScriptGetter;
class CollisionPoint;
class NavPath;
class NavPoint;
class ReactionScriptGetter;
class SphereCollision;