Class LevelModuleBetterEvents
LevelModule which monitors, tracks and invokes events with rich data
Inheritance
System.Object
ThunderRoad.LevelModule
LevelModuleBetterEvents
Inherited Members
ThunderRoad.LevelModule.type
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Assembly: !BetterMods.dll
Syntax
public class LevelModuleBetterEvents : LevelModule
Fields
|
Improve this Doc
View Source
currentLevel
Current level the game is on
Declaration
public Level currentLevel
Field Value
Type |
Description |
ThunderRoad.Level |
|
|
Improve this Doc
View Source
enableLogging
Enable/Disable Better Logging for BetterEvents
Declaration
public bool enableLogging
Field Value
Type |
Description |
System.Boolean |
|
|
Improve this Doc
View Source
levelModuleWave
Currently loaded Wave levelmodule
Declaration
protected LevelModuleWave levelModuleWave
Field Value
Type |
Description |
ThunderRoad.LevelModuleWave |
|
|
Improve this Doc
View Source
local
Local static reference to the currently loaded BetterEvents level module
Declaration
public static LevelModuleBetterEvents local
Field Value
|
Improve this Doc
View Source
logLevel
Set the GetLogLevel for BetterEvents
Declaration
public BetterLogger.LogLevel logLevel
Field Value
|
Improve this Doc
View Source
spellCasterLeft
Declaration
public SpellCaster spellCasterLeft
Field Value
Type |
Description |
ThunderRoad.SpellCaster |
|
|
Improve this Doc
View Source
spellCasterRight
Players right spellcaster
Declaration
public SpellCaster spellCasterRight
Field Value
Type |
Description |
ThunderRoad.SpellCaster |
|
Properties
|
Improve this Doc
View Source
SpellCasterLeftGrabbedHandle
Returns the players left telekinesis grabbed handle
Declaration
public Handle SpellCasterLeftGrabbedHandle { get; }
Property Value
Type |
Description |
ThunderRoad.Handle |
|
|
Improve this Doc
View Source
SpellCasterRightGrabbedHandle
Returns the players right telekinesis grabbed handle
Declaration
public Handle SpellCasterRightGrabbedHandle { get; }
Property Value
Type |
Description |
ThunderRoad.Handle |
|
Methods
|
Improve this Doc
View Source
GetCreatureState(Creature)
Declaration
public virtual HashSet<BetterEvents.CreatureState> GetCreatureState(Creature creature)
Parameters
Type |
Name |
Description |
ThunderRoad.Creature |
creature |
|
Returns
|
Improve this Doc
View Source
GetDamageArea(Creature, CollisionInstance)
The area that was hit, head/neck/body etc
Declaration
public virtual BetterEvents.DamageArea GetDamageArea(Creature creature, CollisionInstance collisionInstance)
Parameters
Type |
Name |
Description |
ThunderRoad.Creature |
creature |
|
ThunderRoad.CollisionInstance |
collisionInstance |
|
Returns
|
Improve this Doc
View Source
GetDamageType(CollisionInstance)
The type of damage, stabbing, blunt, energy, shock etc
Declaration
public virtual DamageType GetDamageType(CollisionInstance collisionInstance)
Parameters
Type |
Name |
Description |
ThunderRoad.CollisionInstance |
collisionInstance |
|
Returns
Type |
Description |
ThunderRoad.DamageType |
|
|
Improve this Doc
View Source
GetHitDirection(Creature, CollisionInstance)
Returns the direction a creature was hit, ie Direction.back is backstabbed
Declaration
public virtual BetterEvents.Direction GetHitDirection(Creature creature, CollisionInstance collisionInstance)
Parameters
Type |
Name |
Description |
ThunderRoad.Creature |
creature |
|
ThunderRoad.CollisionInstance |
collisionInstance |
|
Returns
|
Improve this Doc
View Source
GetHitStates(CollisionInstance)
Returns a collection of various states a hit could be
Declaration
public virtual HashSet<BetterEvents.HitState> GetHitStates(CollisionInstance collisionInstance)
Parameters
Type |
Name |
Description |
ThunderRoad.CollisionInstance |
collisionInstance |
|
Returns
|
Improve this Doc
View Source
GetPenetrationType(CollisionInstance)
Declaration
public virtual DamageStruct.Penetration GetPenetrationType(CollisionInstance collisionInstance)
Parameters
Type |
Name |
Description |
ThunderRoad.CollisionInstance |
collisionInstance |
|
Returns
Type |
Description |
ThunderRoad.DamageStruct.Penetration |
|
|
Improve this Doc
View Source
Hand_OnGrabEvent(Side, Handle, Single, HandleOrientation, EventTime)
Called wh en the players hand grabs or TK grabs something
Declaration
public virtual void Hand_OnGrabEvent(Side side, Handle handle, float axisPosition, HandleOrientation orientation, EventTime eventTime)
Parameters
Type |
Name |
Description |
ThunderRoad.Side |
side |
|
ThunderRoad.Handle |
handle |
|
System.Single |
axisPosition |
|
ThunderRoad.HandleOrientation |
orientation |
|
ThunderRoad.EventTime |
eventTime |
|
|
Improve this Doc
View Source
Hand_OnUnGrabEvent(Side, Handle, Boolean, EventTime)
Called when the players hand stops grabbing or TK grabbing something
Declaration
public virtual void Hand_OnUnGrabEvent(Side side, Handle handle, bool throwing, EventTime eventTime)
Parameters
Type |
Name |
Description |
ThunderRoad.Side |
side |
|
ThunderRoad.Handle |
handle |
|
System.Boolean |
throwing |
|
ThunderRoad.EventTime |
eventTime |
|
|
Improve this Doc
View Source
Locomotion_OnGroundEvent(Boolean, Vector3)
Called when player locomotion is on ground
Declaration
public virtual void Locomotion_OnGroundEvent(bool grounded, Vector3 velocity)
Parameters
Type |
Name |
Description |
System.Boolean |
grounded |
|
UnityEngine.Vector3 |
velocity |
|
|
Improve this Doc
View Source
MonitorCast(SpellCaster, Side)
This function monitors when the player casts spells and fires one off events when the player starts/stops casting
Declaration
public virtual void MonitorCast(SpellCaster spellCaster, Side side)
Parameters
Type |
Name |
Description |
ThunderRoad.SpellCaster |
spellCaster |
|
ThunderRoad.Side |
side |
|
|
Improve this Doc
View Source
MonitorTk(SpellCaster, Side, ref Handle)
Continually checks if the player has grabbed something with Telekinesis and updates a handle reference
Declaration
public virtual void MonitorTk(SpellCaster spellCaster, Side side, ref Handle handle)
Parameters
Type |
Name |
Description |
ThunderRoad.SpellCaster |
spellCaster |
|
ThunderRoad.Side |
side |
|
ThunderRoad.Handle |
handle |
|
|
Improve this Doc
View Source
OnCreatureHit(Creature, CollisionInstance)
Called when a creature is hit
Declaration
public virtual void OnCreatureHit(Creature creature, CollisionInstance collisionInstance)
Parameters
Type |
Name |
Description |
ThunderRoad.Creature |
creature |
|
ThunderRoad.CollisionInstance |
collisionInstance |
|
|
Improve this Doc
View Source
OnCreatureKill(Creature, Player, CollisionInstance, EventTime)
Called when a creature is killed
Declaration
public virtual void OnCreatureKill(Creature creature, Player player, CollisionInstance collisionInstance, EventTime eventTime)
Parameters
Type |
Name |
Description |
ThunderRoad.Creature |
creature |
|
ThunderRoad.Player |
player |
|
ThunderRoad.CollisionInstance |
collisionInstance |
|
ThunderRoad.EventTime |
eventTime |
|
|
Improve this Doc
View Source
OnCreatureParry(Creature, CollisionInstance)
Called when a creature parrys
Declaration
public virtual void OnCreatureParry(Creature creature, CollisionInstance collisionInstance)
Parameters
Type |
Name |
Description |
ThunderRoad.Creature |
creature |
|
ThunderRoad.CollisionInstance |
collisionInstance |
|
|
Improve this Doc
View Source
OnDeflectEvent(Creature, Item, Creature)
Called when a spell is deflected
Declaration
public virtual void OnDeflectEvent(Creature source, Item item, Creature target)
Parameters
Type |
Name |
Description |
ThunderRoad.Creature |
source |
|
ThunderRoad.Item |
item |
|
ThunderRoad.Creature |
target |
|
|
Improve this Doc
View Source
OnLoadCoroutine(Level)
Called when a level is loaded
Declaration
public override IEnumerator OnLoadCoroutine(Level level)
Parameters
Type |
Name |
Description |
ThunderRoad.Level |
level |
|
Returns
Type |
Description |
System.Collections.IEnumerator |
|
Overrides
ThunderRoad.LevelModule.OnLoadCoroutine(ThunderRoad.Level)
|
Improve this Doc
View Source
OnPossessEvent(Creature, EventTime)
Declaration
public virtual void OnPossessEvent(Creature creature, EventTime eventTime)
Parameters
Type |
Name |
Description |
ThunderRoad.Creature |
creature |
|
ThunderRoad.EventTime |
eventTime |
|
|
Improve this Doc
View Source
OnUnload(Level)
Called when the current level is unloaded
Declaration
public override void OnUnload(Level level)
Parameters
Type |
Name |
Description |
ThunderRoad.Level |
level |
|
Overrides
ThunderRoad.LevelModule.OnUnload(ThunderRoad.Level)
|
Improve this Doc
View Source
OnUnPossessEvent(Creature, EventTime)
Declaration
public virtual void OnUnPossessEvent(Creature creature, EventTime eventTime)
Parameters
Type |
Name |
Description |
ThunderRoad.Creature |
creature |
|
ThunderRoad.EventTime |
eventTime |
|
|
Improve this Doc
View Source
OnWaveBegin()
Declaration
public virtual void OnWaveBegin()
|
Improve this Doc
View Source
OnWaveLoop()
Declaration
public virtual void OnWaveLoop()
|
Improve this Doc
View Source
This is called when the players grabbed, TKed item or fists has begun touching another rigidbody/collider
Declaration
public virtual void PlayerItemFootHand_OnCollisionStartEvent(CollisionInstance collisionInstance)
Parameters
Type |
Name |
Description |
ThunderRoad.CollisionInstance |
collisionInstance |
|
|
Improve this Doc
View Source
Ragdoll_OnSliceEvent(RagdollPart, EventTime)
Called when a ragdoll part is sliced
Declaration
public virtual void Ragdoll_OnSliceEvent(RagdollPart ragdollPart, EventTime eventTime)
Parameters
Type |
Name |
Description |
ThunderRoad.RagdollPart |
ragdollPart |
|
ThunderRoad.EventTime |
eventTime |
|
|
Improve this Doc
View Source
SubscribeToHandleColliders(Handle)
Subscribes to the handles colliders OnCollisionStartEvent
Declaration
public virtual void SubscribeToHandleColliders(Handle handle)
Parameters
Type |
Name |
Description |
ThunderRoad.Handle |
handle |
|
|
Improve this Doc
View Source
SubscribeToRagdollSlice(RagdollPart)
Used to listen to a ragdoll parts slice events
Declaration
public virtual void SubscribeToRagdollSlice(RagdollPart ragdollPart)
Parameters
Type |
Name |
Description |
ThunderRoad.RagdollPart |
ragdollPart |
|
|
Improve this Doc
View Source
TkCaughtHandle(Handle, Side)
Called when the player TK grabbed something
Declaration
public virtual void TkCaughtHandle(Handle handle, Side side)
Parameters
Type |
Name |
Description |
ThunderRoad.Handle |
handle |
|
ThunderRoad.Side |
side |
|
|
Improve this Doc
View Source
UnsubscribeToHandleColliders(Handle)
Unsubscribes to a handles colliders OnCollisionStartEvent
Declaration
public virtual void UnsubscribeToHandleColliders(Handle handle)
Parameters
Type |
Name |
Description |
ThunderRoad.Handle |
handle |
|
|
Improve this Doc
View Source
Update(Level)
Declaration
public override void Update(Level level)
Parameters
Type |
Name |
Description |
ThunderRoad.Level |
level |
|
Overrides
ThunderRoad.LevelModule.Update(ThunderRoad.Level)