AngelScript bindings mega-issue

[pivotman319-owo]

This is a mega-issue covering various requests for implementing AS binding for pre-existing cpp classes. These will live here.

Client Side

• Potentially expose pano to AS? Would help for interfacing with UI and game

MaterialSystem

• IMatRenderContext

Server Side

CBaseEntity

• Core
  • SetName() Right now the name can be changed, but it has to be done with CBaseEntity::KeyValue("targetname", name)
• Effect Flags (EF_)
  • Enum for EF_ bitflags EF_ITEM_BLINK and EF_PARENT_ANIMATES are not exposed. Latter might not be needed. Also currently the dump is saying that EF_MAX_BITS is earlier in the Enum than where it is in 2013SDK. Unsure if this means that it was defined with a lower value incorrectly or the dumper is weird.
• Entity and Behavior Flags (EFL_, FL_)
  • Enums entity flags Some were exposed but not all, need to check if any more are viable to be exposed.
  • Enum behavior flags
• Thinking
  • float GetNextThink( int nContextIndex )
  • void SetLastThink( int nContextIndex, float thinkTime )
  • int GetNextThinkTick( int nContextIndex )

CBaseAnimating

• Fire
  • IgniteNumHitboxFires()
  • IgniteHitboxFireScale()

CBasePlayer

• [ ]

Triggers

• CTriggerOnce
• CTriggerMultiple

Additional entity classes

• Props
  • CPhysicsProp
  • CDynamicProp
  • CPropScalable

Global Functions

• SendToConsole (or equivalents)

Gameplay

AI

• Need CBaseCombatCharacter, CAI_BaseNPC and CNPC_PlayerCompanion properly exposed to get a basic NPC going
  • Potentially re-add NextBot support to game build and expose to AS?
• NPC animations, attacks, capabilities, tasks, schedules, classifications (e.g.: CLASS_PLAYER_ALLY_VITAL, CLASS_COMBINE), relationships, line-of-sight/Potentially Visible Set
  • Weapon interactions are being tracked as part of weapons binding requests below (acttables, attacks, et al.)

Player

• Expose CBasePlayer, CPortal_Player
  • Movement
  • Weapon handling
  • Health, armor and ammo
    • Difficulty-based damage scaling and ammo scarcity
  • Interactions (+USE, grab/pickup controllers (CGrabController⁩⁩, CPlayerPickupController⁩⁩)
  • Player bots (IBotController)
  • Button/keypress states, input types defined in in_buttons.h
    • void ForceButtons( int nButtons ) Sort of works, does register, but actions based on those buttons dont occur

Weapons

• Dedicated issue: Feature: Expose some weapon-related bindings and classes over AngelScript #2026
• Need some crucial C++ classes related to base player and weapons exposed, plus some internal engine functions like Vector AngleVectors()

Misc

• Vehicles + passenger behaviors (CAI_PassengerBehavior + possibly genericize and refactor alyx/zombie behaviors?)
• ToBasePlayer(arg1) (used to get a pointer to the owner player class or invoking command client, see entity_tools_server.cpp and the various weapon obj files in sdk2013) - bedrock requirement for weapons!!

Portal-specific

Portals

• CPropPortal (prop_portal)
  • ... ?
• CWeaponPortalgun (weapon_portalgun)
• CLinkedPortalDoor (prop_linked_portal_door; statically-placed world portals)
• Fizzlers (CTriggerPortalCleanser)
• Portal bumpers and detectors (CFuncPortalDetector, CFuncPortalBumper)

Testing elements

These will not be directly exposed. Instead an ECS type system is planned for these to add behaviors to them instead.

• Buttons (CPropButton, CPropUnderButton, CPropFloorButton)
• Weighted cubes (CPropWeightedCube, CPropMonsterBox)
  • ... ?
• Indicator panels (CPropIndicatorPanel)
• Turrets
  • Aperture Sentry Turret (CNPC_Portal_FloorTurret)
    • Requires CBaseTurret (base HL2 turret class; dependency of CNPC_Portal_FloorTurret)
    • Requires CNPC_FloorTurret (dependency of CNPC_Portal_FloorTurret)
  • Rocket turrets (CNPC_RocketTurret, CPropRocketTripwire)
• Paint
  • CPaintSprayer
  • CPaintStream
  • CPropPaintBomb
    - [ ] CTEWallPaintedEvent Will not implement
  • CTriggerPaintCleanser
  • CWeaponPaintGun
  • Blobulator behaviors
  • Ability to add custom paint definitions
• Hard Light Bridges
  • CBaseProjector
  • CPropWallProjector
• Excursion Funnels/Tractor Beams
  • CPropTractorBeamProjector
  • CProjectedTractorBeamEntity
  • CTrigger_TractorBeam
• Aerial Faith Plates + Hidden Catapult Triggers (CTriggerCatapult)
  • Per TF2 SDK (server, shared):
    • Vector CalculateLaunchVector( CBaseEntity *pVictim, CBaseEntity *pTarget )
    • Vector CalculateLaunchVectorPreserve( Vector vecInitialVelocity, CBaseEntity *pVictim, CBaseEntity *pTarget, bool bForcePlayer )
    • void LaunchByTarget( CBaseEntity *pVictim, CBaseEntity *pTarget )
    • void LaunchByDirection( CBaseEntity *pVictim )
    • void PlayerPassesTriggerFiltersThink()
    • Player/physics velocity, catapult targets, air control
• Test chamber signs (CPropTestChamberSign)
• Thermal Discouragement Beams
  • CPortalLaser
    • ... ?
  • Laser Catcher
    • ... ?
  • Portions of CPropWeightedCube (reflection cube + schrodinger)
• Wheatley bombs
  • CPropGlassFutbol
  • CPropExplodingFutbol
  • CPropFutbolSocket
  • CPropFutbolSpawner

Engine

Tools

Hammer

• None yet so far

Misc

• Could potentially bring in AS support for faceposer and hlmv?
• Would also help to have custom AS-based engine tools...

Mathlib

• Add QAngle::GetForward(), QAngle::GetUp(), QAngle::GetRight() to match Quaternions
• DEG2RAD, PI, and other various math macros

[Trico-Everfire]

Missing as of writing this:
class CTriggerMultiple

CBaseEntity::GetNextThink(string ctx)⁩
CBaseEntity::IsPlayer()

[OrsellGit]

CBaseTrigger::Enabled/Disable needs to be exposed.

CBaseEntity::EntityText would be useful for debugging.

The whole set of effect functions and enums for CBaseEntity:

• GetEffects
• HasEffects
• RemoveEffects
• ClearEffects
• SetEffects
• IsEffectActive

The whole set of flag functions and bit flags for CBaseEntity:

• AddFlag
• RemoveFlag
• ClearFlags
• ToggleFlag

[OrsellGit]

Should also mention that this issue exists StrataSource/Engine#1564 that I made a bit ago, but way out of scope for the moment. Just though I would add it to the list at least.

[vrad-exe]

What the hell is CPortal_VRPlayer? Is that from the motionpack or something?

[TeamSpen210]

It's from HL2VR, WIP. -vr :)

[vrad-exe]

Oh okay so I guess p2ce just has a VR mode now.

[Trico-Everfire]

Missing as of writing this (required for custom weapon fire behaviour)

• button enum
• GetButtons() (CBasePlayer::m_nButtons)
• int CBaseEntity::GetWaterLevel()

Generally, these are a few functions, preferably a lot of the content in CBaseCombatWeapon's core functionality needs to be exposed. Not just related to the class, but also to the classes that reference the entity (like CBasePlayer). As they are vital to it's functionality.

[pivotman319-owo]

Missing as of writing this (required for custom weapon fire behaviour)

* [button enum](https://github.com/ValveSoftware/source-sdk-2013/blob/11a677c349b149b2f77184dc903e6bb17f8df69b/src/game/shared/in_buttons.h#L13)

* GetButtons() (CBasePlayer::m_nButtons)

First and second ones are actually covered by the weapon issue, but I'll add them to here as well

[OrsellGit]

Is it possible to move a lot of the math and Vector math functions into namespaces for some better organization, so that way not everything is in the global namespace? Would it also be viable to add more math constants and functions too, such as PI and DEGTORAD?

[Trico-Everfire]

CEntityOutputTemplate derivatives (COutputEvent and the typed variants) don't have
void Init( Type value )
void Set( Type value, CBaseEntity *pActivator, CBaseEntity *pCaller )
Type Get( void )
exposed which is used by stuff like logic entities to get and set the values stored within.

[vrad-exe]

Currently none of the constructors for ConVar seem to let you set a description, which is something many vanilla convars have. It would be nice if that could be added.