Lua/Objects/Entity

From NS2 community wiki

Lua Object
Name	Lua/Objects/Entity
Inherits	nil
Direct Subclasses	Actor
Client/Server	Unknown
Created With	None
Destroyed With	None
Description:
No description provided.

This page needs editing: Not using proper format. You can help the NS2 Wiki by editing it!

enum PropagateOptions

Entity.Propagate_Never
Entity.Propagate_Always
Entity.Propagate_Callback

Functions

nil Entity:ClearEffects ( )

Entity Entity:FindChildEntity ( Entity )

Angles Entity:GetAngles ( )

string Entity:GetClassName ( )

Coords Entity:GetCoords ( )

integer Entity:GetId ( )

bool Entity:GetIsMapEntity ( )

bool Entity:GetIsTempEntity ( )

bool Entity:GetIsVisible ( )

bool Entity:GetLagCompensated ( )

string Entity:GetMapName ( )

Vector Entity:GetOrigin ( )

Entity Entity:GetParent ( )

nil Entity:PlaySound ( string SoundPath )

Entity:SetAngles ( Angles )

nil Entity:SetAttachPoint ( string AttachPointName )

nil Entity:SetIsVisible ( bool IsVisible )

Entity:SetLagCompensated ( bool lagCompensated )

Entity:SetNextThink ( float DelayToNextOnThink )

Entity:SetOrigin ( Vector Position )

Entity:SetPropagate ( PropagateOptions option )

nil Entity:SetParent ( Entity NewParent )

nil Entity:SetSoundParameter ( string ,string ,float ,float )

Entity:SetUpdates ( bool enableUpdates )

nil Entity:StopSound ( string SoundPath )

Hooks

Coords Entity:GetAttachPointCoords ( integer index )

Called by both lua code and the engine to Get the Coords of the specified attach point

integer Entity:GetAttachPointIndex ( string attach_point ) description

nil Entity:OnCreate ( )

Called when the entity is created

nil Entity:OnInit ( )

nil Entity:OnLoad ( )

Called when the data from the map file has been loaded into the entity some of the fields will be loaded as strings

nil Entity:OnUpdate ( float deltaTime )

Called every frame to update the entity

nil Entity:OnDestroy ( )

Called when the entity is destroyed

nil Entity:OnSynchronized ( )

Called when the network variables for the entity are updated from values from the server.

nil Entity:OnProcessMove ( Move PlayerInput )

Called after OnUpdate, OnUpdatePhysics, but before rendering takes place.

Lua/Objects/Entity/OnUpdateRender

Lua/Objects/Entity/OnUpdatePhysics

Called to handle user input for the player

nil Entity:OverrideInput ( Move PlayerInput )

Only called client side

nil Entity:TraceRay ( Vector PointStart, Vector PointEnd, Trace TraceResult )

Called by the engine when a ray is traced through the world

nil Entity:OnThink ( )

Coords Entity:GetCameraViewCoords ( )

Called by the engine to get the object to world space transformation for the camera.

bool Entity:GetCanPlayerHearPlayer ( Entity Player )

bool Entity:OnGetIsRelevant ( Entity Player )

nil Entity:UpdateClientEffects ( float )

float Entity:GetRenderFov ( )