@@ -51,8 +51,8 @@ discard block |
||
51 | 51 | /** As defaults can be made for everything else these are the only non-optional |
52 | 52 | * parts of a COB file in my opinion. Even then they could just be '' if you |
53 | 53 | * really felt like it. |
54 | - * @param $agentName The name of the agent (as displayed in the C2 injector) |
|
55 | - * @param $agentDescription The description of the agent (as displayed in the C2 injector) |
|
54 | + * @param string|false $agentName The name of the agent (as displayed in the C2 injector) |
|
55 | + * @param string $agentDescription The description of the agent (as displayed in the C2 injector) |
|
56 | 56 | */ |
57 | 57 | public function COBAgentBlock($agentName, $agentDescription) { |
58 | 58 | parent::COBBlock(COB_BLOCK_AGENT); |
@@ -381,7 +381,7 @@ discard block |
||
381 | 381 | |
382 | 382 | /// @brief Creates a new COBDependency |
383 | 383 | /** @param string $type The type of dependency ('sprite' or 'sound'). |
384 | - * @param $name The name of the dependency (four characters, no file extension) |
|
384 | + * @param string $name The name of the dependency (four characters, no file extension) |
|
385 | 385 | */ |
386 | 386 | public function COBDependency($type, $name) { |
387 | 387 | $this->type = $type; |
@@ -17,8 +17,8 @@ |
||
17 | 17 | /// @brief Constructs a new COBFileBlock |
18 | 18 | /** |
19 | 19 | * @param string $type The file type |
20 | - * @param $name The file name (including extension) |
|
21 | - * @param $contents The contents of the file |
|
20 | + * @param string $name The file name (including extension) |
|
21 | + * @param string|false $contents The contents of the file |
|
22 | 22 | */ |
23 | 23 | public function COBFileBlock($type, $name, $contents) { |
24 | 24 | parent::COBBlock(COB_BLOCK_FILE); |
@@ -6,38 +6,38 @@ |
||
6 | 6 | |
7 | 7 | /// @cond INTERNAL_DOCS |
8 | 8 | // |
9 | - private $fileType; |
|
10 | - private $fileName; |
|
9 | + private $fileType; |
|
10 | + private $fileName; |
|
11 | 11 | |
12 | - private $reserved; |
|
12 | + private $reserved; |
|
13 | 13 | private $contents; |
14 | 14 | |
15 | 15 | /// @endcond |
16 | 16 | |
17 | - /// @brief Constructs a new COBFileBlock |
|
17 | + /// @brief Constructs a new COBFileBlock |
|
18 | 18 | /** |
19 | 19 | * @param string $type The file type |
20 | - * @param $name The file name (including extension) |
|
21 | - * @param $contents The contents of the file |
|
22 | - */ |
|
23 | - public function COBFileBlock($type, $name, $contents) { |
|
24 | - parent::COBBlock(COB_BLOCK_FILE); |
|
25 | - $this->fileType = $type; |
|
26 | - $this->fileName = $name; |
|
27 | - $this->contents = $contents; |
|
20 | + * @param $name The file name (including extension) |
|
21 | + * @param $contents The contents of the file |
|
22 | + */ |
|
23 | + public function COBFileBlock($type, $name, $contents) { |
|
24 | + parent::COBBlock(COB_BLOCK_FILE); |
|
25 | + $this->fileType = $type; |
|
26 | + $this->fileName = $name; |
|
27 | + $this->contents = $contents; |
|
28 | 28 | } |
29 | 29 | |
30 | - /// @brief Add the reserved data associated with this file block |
|
30 | + /// @brief Add the reserved data associated with this file block |
|
31 | 31 | /** |
32 | 32 | * @param $reserved The reserved data |
33 | - */ |
|
34 | - public function AddReserved($reserved) { |
|
35 | - $this->reserved = $reserved; |
|
33 | + */ |
|
34 | + public function AddReserved($reserved) { |
|
35 | + $this->reserved = $reserved; |
|
36 | 36 | } |
37 | 37 | |
38 | 38 | /// @brief Get the name of the file |
39 | - public function GetName() { |
|
40 | - return $this->fileName; |
|
39 | + public function GetName() { |
|
40 | + return $this->fileName; |
|
41 | 41 | } |
42 | 42 | |
43 | 43 | /// @brief Get the file's type |
@@ -70,12 +70,12 @@ |
||
70 | 70 | * @param $reader The reader the data's coming from |
71 | 71 | */ |
72 | 72 | public static function CreateFromReader(IReader $reader) { |
73 | - $type = ($reader->ReadInt(2)==0)?'sprite':'sound'; |
|
73 | + $type = ($reader->ReadInt(2) == 0) ? 'sprite' : 'sound'; |
|
74 | 74 | $reserved = $reader->ReadInt(4); |
75 | 75 | $size = $reader->ReadInt(4); |
76 | 76 | $fileName = $reader->ReadCString(); |
77 | 77 | $contents = $reader->Read($size); |
78 | - $block = new COBFileBlock($type,$fileName,$contents); |
|
78 | + $block = new COBFileBlock($type, $fileName, $contents); |
|
79 | 79 | $block->AddReserved($reserved); |
80 | 80 | return $block; |
81 | 81 | } |
@@ -119,12 +119,12 @@ discard block |
||
119 | 119 | * (number of seconds passed since 1st Jan, 1970) |
120 | 120 | * @param $lifestage The lifestage this creature had achieved at |
121 | 121 | * the time of this event. |
122 | - * @param $moniker1 The first moniker associated with this event. |
|
123 | - * @param $moniker2 The second moniker associated with this event. |
|
124 | - * @param $usertext The user text assosciated with this event. |
|
125 | - * @param $photograph The photograph associated with this event. |
|
126 | - * @param $worldname The name of the world the creature was inhabiting at the time of this event |
|
127 | - * @param $worldUID The UID of the world the creature was inhabiting at the the time of this event |
|
122 | + * @param false|string $moniker1 The first moniker associated with this event. |
|
123 | + * @param false|string $moniker2 The second moniker associated with this event. |
|
124 | + * @param false|string $usertext The user text assosciated with this event. |
|
125 | + * @param false|string $photograph The photograph associated with this event. |
|
126 | + * @param false|string $worldname The name of the world the creature was inhabiting at the time of this event |
|
127 | + * @param false|string $worldUID The UID of the world the creature was inhabiting at the the time of this event |
|
128 | 128 | */ |
129 | 129 | public function CreatureHistoryEvent($eventtype, $worldtime, $creatureage, $timestamp, $lifestage, $moniker1, $moniker2, $usertext, $photograph, $worldname, $worldUID) { |
130 | 130 | $this->eventtype = $eventtype; |
@@ -142,7 +142,7 @@ discard block |
||
142 | 142 | |
143 | 143 | /// @brief Add DS-specific information to the CreatureHistoryEvent |
144 | 144 | /** |
145 | - * @param $DSUserID The UID of the Docking Station user whose world the creature was in at the time of the event |
|
145 | + * @param false|string $DSUserID The UID of the Docking Station user whose world the creature was in at the time of the event |
|
146 | 146 | * @param $unknown1 I don't know! But it comes right after the DSUID in the GLST format. |
147 | 147 | * @param $unknown2 I don't know! But it comes right after unknown1. |
148 | 148 | */ |
@@ -13,7 +13,7 @@ discard block |
||
13 | 13 | * will be read from the PRAYFile. |
14 | 14 | * @param PRAYFile $prayfile The PRAYFile associated with this AGNT block. |
15 | 15 | * It is allowed to be null. |
16 | - * @param $name The name of this block. |
|
16 | + * @param string $name The name of this block. |
|
17 | 17 | * @param $content This block's content. |
18 | 18 | * @param $flags Any flags this block may have. I think this is a |
19 | 19 | * single byte. Check http://www.creatureswiki.net/wiki/PRAY |
@@ -26,7 +26,7 @@ discard block |
||
26 | 26 | /** |
27 | 27 | * Sometimes this ends in .agnt or .dsag, because some people |
28 | 28 | * don't do their PRAYING properly. |
29 | - * @return The agent name |
|
29 | + * @return string agent name |
|
30 | 30 | */ |
31 | 31 | public function GetAgentName() { |
32 | 32 | return $this->GetName(); |
@@ -12,7 +12,7 @@ |
||
12 | 12 | * will be read from the PRAYFile. |
13 | 13 | * @param PRAYFile $prayfile The PRAYFile associated with this CREA block. |
14 | 14 | * It is allowed to be null. |
15 | - * @param $name The name of this block. |
|
15 | + * @param string $name The name of this block. |
|
16 | 16 | * @param $content This block's content. |
17 | 17 | * @param $flags Any flags this block may have |
18 | 18 | */ |
@@ -11,7 +11,7 @@ |
||
11 | 11 | |
12 | 12 | /// @brief Instantiates a new CreaturesArchiveBlock |
13 | 13 | /** |
14 | - * @param $prayfile The PRAYFile this CreaturesArchive belongs to. May be null. |
|
14 | + * @param PRAYFile $prayfile The PRAYFile this CreaturesArchive belongs to. May be null. |
|
15 | 15 | * @param $name The name of this block |
16 | 16 | * @param $content This block's binary data. |
17 | 17 | * @param $flags the flags of this block |
@@ -14,7 +14,7 @@ |
||
14 | 14 | * If $prayfile is not null, all the data for this block |
15 | 15 | * will be read from the PRAYFile. |
16 | 16 | * @param PRAYFile $prayfile The PRAYFile that this DFAM block belongs to. |
17 | - * @param $name The block's name. |
|
17 | + * @param string $name The block's name. |
|
18 | 18 | * @param $content The binary data of this block. May be null. |
19 | 19 | * @param $flags The block's flags |
20 | 20 | */ |
@@ -13,14 +13,14 @@ |
||
13 | 13 | /** |
14 | 14 | * If $prayfile is not null, all the data for this block |
15 | 15 | * will be read from the PRAYFile. |
16 | - * @param PRAYFile $prayfile The PRAYFile that this DFAM block belongs to. |
|
17 | - * @param $name The block's name. |
|
18 | - * @param $content The binary data of this block. May be null. |
|
19 | - * @param $flags The block's flags |
|
20 | - */ |
|
21 | - public function DFAMBlock($prayfile, $name, $content, $flags) { |
|
22 | - parent::TagBlock($prayfile, $name, $content, $flags, PRAY_BLOCK_DFAM); |
|
16 | + * @param PRAYFile $prayfile The PRAYFile that this DFAM block belongs to. |
|
17 | + * @param $name The block's name. |
|
18 | + * @param $content The binary data of this block. May be null. |
|
19 | + * @param $flags The block's flags |
|
20 | + */ |
|
21 | + public function DFAMBlock($prayfile, $name, $content, $flags) { |
|
22 | + parent::TagBlock($prayfile, $name, $content, $flags, PRAY_BLOCK_DFAM); |
|
23 | 23 | |
24 | - } |
|
24 | + } |
|
25 | 25 | } |
26 | 26 | ?> |
@@ -12,7 +12,7 @@ |
||
12 | 12 | * If $prayfile is not null, all the data for this block |
13 | 13 | * will be read from the PRAYFile. |
14 | 14 | * @param PRAYFile $prayfile The PRAYFile that this DSAG block belongs to. |
15 | - * @param $name The block's name. |
|
15 | + * @param string $name The block's name. |
|
16 | 16 | * @param $content The binary data of this block. May be null. |
17 | 17 | * @param $flags The block's flags |
18 | 18 | */ |
@@ -13,7 +13,7 @@ |
||
13 | 13 | * If $prayfile is not null, all the data for this block |
14 | 14 | * will be read from the PRAYFile. |
15 | 15 | * @param PRAYFile $prayfile The PRAYFile that this DFAM block belongs to. |
16 | - * @param $name The block's name. |
|
16 | + * @param string $name The block's name. |
|
17 | 17 | * @param $content The binary data of this block. May be null. |
18 | 18 | * @param $flags The block's flags |
19 | 19 | */ |