Flash CS3 Documentation

Flash Lite 2.x ActionScript Language Reference > ActionScript language elements > Statements > get statement

get statement

function get property () { // your statements here }

Note: To use this keyword, you must specify ActionScript 2.0 and Flash Player 6 or later in the Flash tab of your FLA file's Publish Settings dialog box. This keyword is supported only when used in external script files, not in scripts written in the Actions panel.

Permits implicit getting of properties associated with objects based on classes you have defined in external class files. Using implicit get methods lets you access properties of objects without accessing the property directly. Implicit get/set methods are syntactic shorthand for the Object.addProperty() method in ActionScript 1.

Parameters

property:String - The word you use to refer to the property that get accesses; this value must be the same as the value used in the corresponding set command.

Example

In the following example, you define a Team class. The Team class includes get/set methods that let you retrieve and set properties within the class:

class Team { 
 var teamName:String; 
 var teamCode:String; 
 var teamPlayers:Array = new Array(); 
 function Team(param_name:String, param_code:String) { 
 this.teamName = param_name; 
 this.teamCode = param_code; 
 } 
 function get name():String { 
 return this.teamName; 
 } 
 function set name(param_name:String):Void { 
 this.teamName = param_name; 
 } 
}

Enter the following ActionScript in a frame on the Timeline:

var giants:Team = new Team("San Fran", "SFO"); 
trace(giants.name); 
giants.name = "San Francisco"; 
trace(giants.name); 
/* output: 
San Fran San Francisco */

When you trace giants.name, you use the get method to return the value of the property.

See also

addProperty (Object.addProperty method)

Flash CS3