Lua:info ff script - Revision history

R00Kie: /* Get Functions */

2015-04-05T21:09:06Z

Get Functions

Crazycarl at 21:51, 13 April 2010

2010-04-13T21:51:49Z

Crazycarl at 21:46, 13 April 2010

2010-04-13T21:46:21Z

Crazycarl at 01:44, 8 March 2010

2010-03-08T01:44:13Z

Crazycarl at 15:39, 29 June 2009

2009-06-29T15:39:39Z

Crazycarl at 15:38, 29 June 2009

2009-06-29T15:38:43Z

Crazycarl at 01:24, 27 June 2009

2009-06-27T01:24:05Z

Crazycarl at 23:07, 26 June 2009

2009-06-26T23:07:03Z

Crazycarl: /* Get Functions */

2009-05-12T22:18:21Z

Get Functions

Crazycarl: /* Get Functions */

2009-05-12T22:16:22Z

Get Functions

@@ Line 82: / Line 82: @@
 ===Get Functions===
 Get functions return some information. Information you can use.
-*[[Info_ff_script:GetAngles]]()--Returns an orientation array. (p,y,r, I believe)
+{| border="1" cellspacing="0"
-*[[Info_ff_script:GetOrigin]]()--Returns a location array. (x,y,z)
+! Command !! Description
-*[[Info_ff_script:GetName]]()--Returns a string containing the name of the info_ff_script.
+|-
 ===Set Functions===

@@ Line 53: / Line 53: @@
 *[[Info_ff_script:precache|precache()]]--Called on each info_ff_script when the map is loaded, but before it starts. See [[Lua:precache]].
 *[[Info_ff_script:materialize|materialize()]]--Called when an item respawns.
 ==Functions==
@@ Line 68: / Line 73: @@
             end
        end
 ===Attachment Functions===

@@ Line 1: / Line 1: @@
 {{Infobox_mapping}}
 ==Introduction==
-An info_ff_script is a point-based scriptable entity.  Unlike most Source entities, which represent one type of object and have predetermined behavior, the scriptability behind this entity makes it extremely flexibile.
+info_ff_script is used to represent items that can affect, and be affected by players. Such items might be the flags in a CTF map, or the armor, health and ammo packs in a respawn room.
-info_ff_script entities represent items that can affect, and be affected by players. Such items might be the flags in a CTF map, or the armor, health and ammo packs in a respawn room.
+These entities are placed in a map editor, such as Hammer, and must be given a name in order to function correctly.  This name will be used to link it into the map's corresponding Lua file.  So, whenever you put a named info_ff_script entity in your map, the game attempts to find a correspondingly named object in '''mapname'''.lua.
 FF includes a number of pre-existing game modes that require very little work to implement in your own maps--that is, assuming your map's gameplay is similar enough to one of these templates.  You'll simply need to add the appropriate entities, give them the proper names, and you're all set. More on that can be found by looking at the available [[map templates]].
@@ Line 29: / Line 27: @@
 Any functions and variables we define in baseflag will be inherited by those entities which use it as a base. We can redefine functions and variables in the derived entites, to override the basic functionality.
-==Functions & Events==
+==Events, or callbacks==
-info_ff_scripts have various functions and events that handle specific behavior of the entity, or provide you information that may be useful elsewhere in your scripting.
+info_ff_script has various callbacks that allow your Lua script to detect events that happen in the game.
 Access to events is typically in the following format:
-  function item:'''methodname'''( ''parameters'' )
+  function item:'''eventname'''( ''parameters'' )
     --What to do when this method is called
     --return anything, if necessary
   end
-Obviously, different methods will accept different parameters. Some methods may not take any parameters, or may not return any values.  All of the passed parameters, returned values and examples of usage can be found for all of the info_ff_script methods in the following links.
+Different methods may provide data by passing on a number of parameters.  The types of these parameters, returned values and examples of usage can be found in the following links.
 ==="On" Events===
@@ Line 56: / Line 54: @@
 *[[Info_ff_script:materialize|materialize()]]--Called when an item respawns.
-===Options===
+==Functions==
-*dropatspawn()--Return true to make the object drop to the ground when the map loads. Return false to leave it floating where it was placed in Hammer.
+Whenever you have a reference to a particular entity, you can use its functions to control its behavior.
   -- find the flag and cast it to an info_ff_script
   local flag = GetInfoScriptByName("redflag")
@@ Line 73: / Line 68: @@
             end
        end
 ===Attachment Functions===

@@ Line 112: / Line 112: @@
 *Return() Causes the item to return to its starting point.
 *EmitSound(String) Causes the item to make a sound.
 [[Category:Lua]][[Category:Lua_Commands]][[Category:Lua_Callbacks]]

@@ Line 1: / Line 1: @@
-{{Inobox_mapping}}
+{{Infobox_mapping}}
 ==Introduction==
 An info_ff_script is a point-based scriptable entity.  Unlike most Source entities, which represent one type of object and have predetermined behavior, the scriptability behind this entity makes it extremely flexibile.

@@ Line 40: / Line 40: @@
 Obviously, different methods will accept different parameters. Some methods may not take any parameters, or may not return any values.  All of the passed parameters, returned values and examples of usage can be found for all of the info_ff_script methods in the following links.
-===On Events===
+==="On" Events===
 These callbacks are available to detect when certain events happen to the info_ff_script.
-*[[Info_ff_script:ondrop|ondrop]]--The item is dropped, either by death or intentionally.
+*[[Info_ff_script:spawn|ondrop( owner_entity )]]--The flag is dropped, either intentionally or by death.
-*[[Info_ff_script:onloseitem|onloseitem]]--The item is taken from the player for any reason.
+*[[Info_ff_script:onloseitem|onloseitem( owner_entity )]]--The item is taken from the player for any reason.
-*[[Info_ff_script:onreturn|onreturn]]--The flag returns to its origin.
+*[[Info_ff_script:onreturn|onreturn()]]--The flag returns to its origin.
-*[[Info_ff_script:onownerdie|onownerdie]]--A player dies while holding the item.
+*[[Info_ff_script:onownerdie|onownerdie( owner_entity )]]--A player dies while holding the item.
-*[[Info_ff_script:onownerforcerespawn|onownerforcerespawn]]--The player is forced to respawn while holding the item.
+*[[Info_ff_script:onownerforcerespawn|onownerforcerespawn( owner_entity )]]--The player is forced to respawn while holding the item.
-*[[Info_ff_script:ownercloak|ownercloak]]--A spy activates his cloak while holding the item.
+*[[Info_ff_script:ownercloak|ownercloak( owner_entity )]]--A spy activates his cloak while holding the item. NOTE: This one doesn't start with "on".
 ===Other Events===
 *[[Info_ff_script:dropitemcmd|dropitemcmd(owner_entity)]]--The player holding the item presses the dropitems key.
 *[[Info_ff_script:touch|touch( player_entity )]]--The info_ff_script is touched by a player.
@@ Line 57: / Line 56: @@
 ===Options===
-dropatspawn()--Return true to make the object drop to the ground when the map loads. Return false to leave it floating where it was placed in Hammer.
+*dropatspawn()--Return true to make the object drop to the ground when the map loads. Return false to leave it floating where it was placed in Hammer.
-hasanimation()--Return true if the model used is animated.
+*hasanimation()--Return true if the model used is animated.
-usephysics()--Return true for dropped items to act as physics props. Default behavior is for the item to stop when it hits the ground.
+*usephysics()--Return true for dropped items to act as physics props. Default behavior is for the item to stop when it hits the ground.
 Functions can be sent to an info_ff_script whenever you have a reference to a particular entity.
@@ Line 69: / Line 68: @@
             -- check if the player is carrying the flag
             if player:HasItem(flag:GetName()) then
-		-- return the flag
+ 		-- return the flag
-		flag:Return()
+           	flag:Return()
 ===Attachment Functions===
@@ Line 102: / Line 103: @@
 *[[Info_ff_script:IsReturned|IsReturned]]
-==This shit below here still needs to be categorized like the above==
+===Misc. Functions===
-===addnotouch()===
+*addnotouch() Defined in base_teamplay. Default behavior is to prevent the player from picking up the flag for 2 seconds after dropping it. Disabling this behavior will prevent players from being able to throw the flag at all--or rather, they will throw it, and pick it up an instant later.
-Defined in base_teamplay. Default behavior is to prevent the player from picking up the flag for 2 seconds after dropping it. Disabling this behavior will prevent players from being able to throw the flag at all--or rather, they will throw it, and pick it up an instant later.
+*new({collection}) creates a new type of info_ff_script. See [[Lua:info_ff_script#Example]]
+*Drop(FLAG_RETURN_TIME, FLAG_THROW_SPEED) Causes the player to throw/drop the flag.
-===new({collection})=== creates a new type of info_ff_script. See [[Lua:info_ff_script#Example]]
+*Pickup(player) Causes the specified player to carry this item.
+*Respawn(int) Causes the item to disappear, and reappear after a specified number of seconds.
-===Drop(FLAG_RETURN_TIME, FLAG_THROW_SPEED)=== Causes the player to throw/drop the flag
+*Return() Causes the item to return to its starting point.
-===Pickup(player)=== Causes the specified player to carry this item.
+*EmitSound(String) Causes the item to make a sound.
 [[Category:Lua]]

@@ Line 1: / Line 1: @@
 ==Introduction==
-An info_ff_script is a point-based scriptable entity.  If you are familiar with TFC's entities, this entity is ''somewhat'' similiar to [http://tf.valve-erc.com/kbase.php?id=1 info_tfgoals] and [http://tf.valve-erc.com/kbase.php?id=2 item_tfgoals]; however, the scriptability behind this entity makes it a great deal more flexibile.
+An info_ff_script is a point-based scriptable entity.  Unlike most Source entities, which represent one type of object and have predetermined behavior, the scriptability behind this entity makes it extremely flexibile.
 info_ff_script entities represent items that can affect, and be affected by players. Such items might be the flags in a CTF map, or the armor, health and ammo packs in a respawn room.
-These entities are placed in a map editor, such as Hammer, and must be given a name inorder to function correctly.  This name will be used to tie it into the map's corresponding Lua file.  So, whenever you put a named info_ff_script entity in your map, the game attempts to find a correspondingly named function in mapname.lua.
+These entities are placed in a map editor, such as Hammer, and must be given a name in order to function correctly.  This name will be used to link it into the map's corresponding Lua file.  So, whenever you put a named info_ff_script entity in your map, the game attempts to find a correspondingly named function in '''mapname'''.lua.
-Part of the idea behind the functionality with this entity is the concept of creating a "base" item in Lua, and then setting the different values for different items that you might have. FF includes a number of pre-existing game-modes that require very little work to implement in your own maps; that is, assuming your map's gameplay mirrors the gameplay setup in the particular template you use.  You'll simply need to add the appropriate entities, given them a particular name, and you're all set. More on that can be found by looking at the available [[map templates]].
+FF includes a number of pre-existing game modes that require very little work to implement in your own maps--that is, assuming your map's gameplay is similar enough to one of these templates.  You'll simply need to add the appropriate entities, give them the proper names, and you're all set. More on that can be found by looking at the available [[map templates]].
 ====Example====
 Let's assume you don't want to use one of FF's pre-existing base items, and you just want to make your own. For the sake of the example let's say we're setting up our own flag as a learning experience.  First, put two info_ff_script entities in your map, and give them the names: ''myfirstflag'' and ''mysecondflag''. Now, create a new text file, and save the file as ''yourmapname''.lua.
@@ Line 21: / Line 21: @@
 You're probably noticing that nothing in the above bit of Lua has anything directly related to the two named entities you put in your map. We're creating a new info_ff_script object in Lua, and setting some default parameters. For our example, the model won't be changing, but we have two flags and we're going to easily change it's name and skin.  This ''baseflag'' is our blank that we'll copy and modify to create other team-specific flags that are sitting in our map.
-Ok, fuck this for now, I'm tired.
+ --We're extending our baseflag!
 ==Functions & Events==
 info_ff_scripts have various functions and events that handle specific behavior of the entity, or provide you information that may be useful elsewhere in your scripting.
-Access to these various methods is typically in the following format:
+Access to events is typically in the following format:
   function item:'''methodname'''( ''parameters'' )
@@ Line 34: / Line 39: @@
 Obviously, different methods will accept different parameters. Some methods may not take any parameters, or may not return any values.  All of the passed parameters, returned values and examples of usage can be found for all of the info_ff_script methods in the following links.
 ===On Events===
@@ Line 52: / Line 46: @@
 *[[Info_ff_script:onreturn|onreturn]]--The flag returns to its origin.
 *[[Info_ff_script:onownerdie|onownerdie]]--A player dies while holding the item.
-*[[Info_ff_script:onownerforcerespawn|onownerforcerespawn]]--A lua script makes the player respawn while holding the item.
+*[[Info_ff_script:onownerforcerespawn|onownerforcerespawn]]--The player is forced to respawn while holding the item.
 *[[Info_ff_script:ownercloak|ownercloak]]--A spy activates his cloak while holding the item.
 *[[Info_ff_script:dropitemcmd|dropitemcmd]]--The player holding the item presses the dropitems key.
 ===Set Functions===
@@ Line 66: / Line 94: @@
 ===State Checking Functions===
-Generalized description of State checking functions, and how they relate to an info_ff_script entity goes here.
+These all return true or false. You'll generally use them in a conditional statement.
-*[[LUA:IsActive|IsActive]]
+*[[Info_ff_script:IsActive|IsActive]]
-*[[LUA:IsCarried|IsCarried]]
+*[[Info_ff_script:IsCarried|IsCarried]]
-*[[LUA:IsDropped|IsDropped]]
+*[[Info_ff_script:IsDropped|IsDropped]]
-*[[LUA:IsInactive|IsInactive]]
+*[[Info_ff_script:IsInactive|IsInactive]]
-*[[LUA:IsRemoved|IsRemoved]]
+*[[Info_ff_script:IsRemoved|IsRemoved]]
-*[[LUA:IsReturned|IsReturned]]
+*[[Info_ff_script:IsReturned|IsReturned]]
 ==This shit below here still needs to be categorized like the above==
 ===addnotouch()===
-Defined in base_teamplay. Default behavior is to prevent the player from picking up the flag for 2 seconds after dropping it. Disabling this behavior will prevent players from being able to throw the flag at all.
+Defined in base_teamplay. Default behavior is to prevent the player from picking up the flag for 2 seconds after dropping it. Disabling this behavior will prevent players from being able to throw the flag at all--or rather, they will throw it, and pick it up an instant later.
-===dropatspawn()===
+===new({collection})=== creates a new type of info_ff_script. See [[Lua:info_ff_script#Example]]
-===Drop()===
+===Drop(FLAG_RETURN_TIME, FLAG_THROW_SPEED)=== Causes the player to throw/drop the flag
-===hasanimation()===
+===Pickup(player)=== Causes the specified player to carry this item.
-===new()===
+===Respawn(int)=== Causes the item to disappear, and reappear after a specified number of seconds.
-===Pickup()===
+===Return()=== Causes the item to go back to its starting point.
-===precache()===
+===EmitSound(String)===Causes the item to make a sound.
 [[Category:Lua]]

@@ Line 41: / Line 41: @@
 *[[LUA:attachoffsetup|attachoffsetup]]
 ===Get Functions===
-Generalized description of Get functions, and how they relate to an info_ff_script entity goes here.
+Get functions return some information. Information you can use.
-*[[LUA:GetAngles|GetAngles]]
+*[[Info_ff_script:GetAngles|GetAngles]]--Returns an orientation array. (p,y,r, I believe)
-*[[LUA:GetOrigin|GetOrigin]]
+*[[Info_ff_script:GetOrigin|GetOrigin]]--Returns a location array. (x,y,z)
 ===On Events===