Lua:Entity typing - Revision history

R00Kie: /* Entity Checking */

2015-04-05T20:55:29Z

Entity Checking

R00Kie: /* Casting Commands */

2015-04-05T20:54:05Z

Casting Commands

R00Kie: /* Entity Checking */

2015-04-05T20:51:10Z

Entity Checking

R00Ki3 at 22:14, 19 November 2014

2014-11-19T22:14:28Z

Crazycarl at 06:51, 26 June 2011

2011-06-26T06:51:54Z

Crazycarl at 18:22, 5 May 2010

2010-05-05T18:22:05Z

Crazycarl at 07:00, 2 May 2010

2010-05-02T07:00:37Z

Crazycarl at 02:02, 19 March 2010

2010-03-19T02:02:30Z

Crazycarl at 06:55, 16 February 2010

2010-02-16T06:55:51Z

Crazycarl at 03:03, 27 June 2009

2009-06-27T03:03:54Z

@@ Line 51: / Line 51: @@
 |-
 | [[Lua:IsPlayer|IsPlayer]]( ent_id ) || used to see if a passed in entity is a player to before actions are performed on said player.
 |-
 | [[Lua:IsDispenser|IsDispenser]]( ent_id ) ||
@@ Line 63: / Line 67: @@
 |-
 | [[Lua:IsBuildable|IsBuildable]]( ent_id ) ||
 |-
 | [[Lua:IsTurret|IsTurret]]( ent_id ) || Refers to respawn turrets.

@@ Line 89: / Line 89: @@
 |-
 | [[Lua:CastToDetpack|CastToDetpack]]( ent_id ) ||
 |}

@@ Line 59: / Line 59: @@
 |-
 | [[Lua:IsGrenade|IsGrenade]]( ent_id ) ||
 |-
 | [[Lua:IsTurret|IsTurret]]( ent_id ) || Refers to respawn turrets.

@@ Line 10: / Line 10: @@
 *[[Lua:GetEntity|GetEntity]]( int ) Every entity in the game has a unique ID number. Use the [[Lua:GetId|GetId]]() function to access this number for a particular entity.
 *[[Lua:GetEntityByName|GetEntityByName]]( String )
 ===InfoScript===
 An InfoScript is created by using the [[Lua:info_ff_script | info_ff_script]]:new() command in lua, and placing an info_ff_script in a map. This is usually a game item such as a flag, ball, or supply pack,

@@ Line 1: / Line 1: @@
 {{Infobox manual/Header}}
 {{Infobox_mapping}}
-Lua is a dynamically typed language--this means that a variable can hold any type of data at any time. C objects, such as those used in Fortress Forever, are stored as blocks of raw data. Lua can only access this data through functions that are made available by the API.
+Lua is a dynamically typed language--this means that a variable can hold any type of data at any time. C objects, such as those used in Fortress Forever, are accessed as blocks of raw data. Because altering these objects incorrectly can cause the game to crash, It's important that the Lua system correctly knows what type of class it is dealing with.
 ==FF Object Types==
-===BaseEntity===
+===CBaseEntity===
-This is the basic type from which all other entities are derived. Consequently there's not much you can do with it. When naming a variable of this type, it's best to use the word "entity" to prevent confusion.
+This is the basic type from which all other entities are derived. Consequently there's not a lot you can do with it--see [[:Category:Entity_functions]]. When naming an object of this type, it's best to use the word "entity" to prevent confusion.
 The following commands will return a CBaseEntity:
@@ Line 43: / Line 43: @@
 ==Entity Checking==
-Often in a lua script an entity will be passed to the script as a CBaseEntity. This is a basic type of object used in the SDK, from which other types are derived. To gain access to more specific functions, we must ''cast'' the variable to a more specific type.
+Often in a lua script an entity will be passed to the script as a CBaseEntity. To gain access to more specific functions, we must ''cast'' the variable to a more specific type. But before casting to a more specific type of object, it's usually necessary to verify that the object exists, and that it's the kind of object we expect. Failing to do so can cause the script to fail and the game to crash.
-Before casting to a more specific type of object, it's usually necessary to verify that the object exists, and that it's the kind of object we expect. Failing to do so can cause the script to fail and the game to crash. If these functions return ''true'', it is safe to cast to that type of object.
+If these functions return ''true'', it is safe to cast to that type of object.
 {| border="1" cellspacing="0"
 ! LUA Command !! Description
@@ Line 77: / Line 75: @@
 | [[Lua:CastToTriggerScript|CastToTriggerScript]]( ent_id ) || This may be any kind of brush trigger that's referred to in an active lua script.
 |-
-| [[Lua:CastToTriggerClip|CastToTriggerClip]]( ent_id ) || Refers to a [[trigger_ff_clip]].
+| [[Lua:CastToTriggerClip|CastToTriggerClip]]( ent_id ) || Refers to a [[Lua:trigger_ff_clip|trigger_ff_clip]].
 |-
 | [[Lua:CastToGrenade|CastToGrenade]]( ent_id ) ||

@@ Line 33: / Line 33: @@
 The following commands will return a CFFTeam:
-*[[Lua:GetPlayer|GetTeam]]( teamId ) This returns a CFFTeam object when given a team number. See [[Lua:Flags#Team]].
+*[[Lua:GetTeam|GetTeam]]( teamId ) This returns a CFFTeam object when given a team number. See [[Lua:Flags#Team]].
 ===CFFBuildableObject===
 Objects that the player can place or build. Includes dispensers, sentry guns, mancannons, and detpacks. See [[:Category:Buildable_functions]].
 ===CFFGrenadeBase===
 Refers to thrown grenades
 ===CTakeDamageInfo===
 Damageinfo is an object that's passed along whenever a player is damaged or dies. By intercepting this object, you can detect events in the game, or change the outcome of those events. Damageinfo can be accessed from within the callbacks player_ondamage and player_killed. See [[:Category:Damageinfo_functions]].

@@ Line 47: / Line 47: @@
 These are pretty self-explanatory.
-*[[Lua:IsPlayer|IsPlayer]]( ent_id )
+{| border="1" cellspacing="0"
-*[[Lua:IsDispenser|IsDispenser]]( ent_id )
+! LUA Command !! Description
-*[[Lua:IsSentrygun|IsSentrygun]]( ent_id )
+|-
-*[[Lua:IsDetpack|IsDetpack]]( ent_id )
+| [[Lua:IsPlayer|IsPlayer]]( ent_id ) || used to see if a passed in entity is a player to before actions are performed on said player.
-*[[Lua:IsGrenade|IsGrenade]]( ent_id )
+|-
-*[[Lua:IsTurret|IsTurret]]( ent_id )  Meaning a respawn turret.
+| [[Lua:IsDispenser|IsDispenser]]( ent_id ) ||
 ==Casting Commands==
 A casting function accepts a CBaseEntity and returns the requested type of object, which you can assign to a new variable.
-*[[Lua:CastToBeam|CastToBeam]]( ent_id ) tries to cast the entity to a beam (to see if whatever triggered the event was a laser beam, a la SD2). If it fails, it returns null.
+{| border="1" cellspacing="0"
-*[[Lua:CastToPlayer|CastToPlayer]]( ent_id ) used to cast the passed in entity to a player, often used for touch commands.
+! LUA Command !! Description
-*[[Lua:CastToInfoScript|CastToInfoScript]]( ent_id )  This may be a flag, resupply pack, or the like.
+|-
-*[[Lua:CastToTriggerScript|CastToTriggerScript]]( ent_id ) This may be any kind of brush trigger that's referred to in an active lua script.
+| [[Lua:CastToBeam|CastToBeam]]( ent_id ) || tries to cast the entity to a beam (to see if whatever triggered the event was a laser beam, a la SD2). If it fails, it returns null.
-*[[Lua:CastToTriggerClip|CastToTriggerClip]]( ent_id ) Refers to a trigger_ff_clip
+|-
-*[[Lua:CastToGrenade|CastToGrenade]]( ent_id )
+| [[Lua:CastToPlayer|CastToPlayer]]( ent_id ) || used to cast the passed in entity to a player, often used for touch commands.
-*[[Lua:CastToDispenser|CastToDispenser]]( ent_id )
+|-
-*[[Lua:CastToSentrygun|CastToSentrygun]]( ent_id )
+| [[Lua:CastToInfoScript|CastToInfoScript]]( ent_id ) || This may be a flag, resupply pack, or the like.
-*[[Lua:CastToDetpack|CastToDetpack]]( ent_id )
+|-
 ==Example==

← Older revision		Revision as of 06:55, 16 February 2010
Line 1:		Line 1:
	{{Infobox manual/Header}}		{{Infobox manual/Header}}
		+	{{Infobox_mapping}}
	Lua is a dynamically typed language--this means that a variable can hold any type of data at any time. C objects, such as those used in Fortress Forever, are stored as blocks of raw data. Lua can only access this data through functions that are made available by the API.		Lua is a dynamically typed language--this means that a variable can hold any type of data at any time. C objects, such as those used in Fortress Forever, are stored as blocks of raw data. Lua can only access this data through functions that are made available by the API.