Class: ExtendedClientMsgHdr

Inherits:
Object
  • Object
show all
Includes:
SteamSerializable
Defined in:
lib/steamd/generated/header.rb

Overview

Class for the ExtendedClientMsgHdr in the Steam Language.

Instance Attribute Summary

Attributes included from SteamSerializable

#constants, #variables

Instance Method Summary collapse

Methods included from SteamSerializable

#consts, #deserialize, #encode_to, #flag, #serialize, #vars

Constructor Details

#initialize ⇒ ExtendedClientMsgHdr

Instantiate a ExtendedClientMsgHdr object



67
68
69
70
71
72
73
74
75
 
# File 'lib/steamd/generated/header.rb', line 67

def initialize
  super([{:name=>"msg", :type=>"EMsg", :modifier=>nil, :value=>"EMsg::INVALID", :size=>nil, :modifier_size=>nil}, {:name=>"header_size", :type=>"byte", :modifier=>nil, :value=>36, :size=>nil, :modifier_size=>nil}, {:name=>"header_version", :type=>"ushort", :modifier=>nil, :value=>2, :size=>nil, :modifier_size=>nil}, {:name=>"target_job_id", :type=>"ulong", :modifier=>nil, :value=>18446744073709551615, :size=>nil, :modifier_size=>nil}, {:name=>"source_job_id", :type=>"ulong", :modifier=>nil, :value=>18446744073709551615, :size=>nil, :modifier_size=>nil}, {:name=>"header_canary", :type=>"byte", :modifier=>nil, :value=>239, :size=>nil, :modifier_size=>nil}, {:name=>"steam_id", :type=>"ulong", :modifier=>"steamidmarshal", :value=>nil, :size=>nil, :modifier_size=>nil}, {:name=>"session_id", :type=>"int", :modifier=>nil, :value=>nil, :size=>nil, :modifier_size=>nil}], [])
  self.msg = EMsg::INVALID
  self.header_size = 36
  self.header_version = 2
  self.target_job_id = 18446744073709551615
  self.source_job_id = 18446744073709551615
  self.header_canary = 239
end

Instance Method Details

#header_canary ⇒ byte

Note:

defaults to 239

Gets the header_canary variable.

Returns:

  • (byte) —

    the value of header_canary



156
157
158
 
# File 'lib/steamd/generated/header.rb', line 156

def header_canary
  @variables['header_canary'][:value]
end

#header_canary=(value) ⇒ Object

Sets the header_canary variable.

Parameters:

  • value (byte) —

    the new value



163
164
165
 
# File 'lib/steamd/generated/header.rb', line 163

def header_canary=(value)
  @variables['header_canary'][:value] = value
end

#header_size ⇒ byte

Note:

defaults to 36

Gets the header_size variable.

Returns:

  • (byte) —

    the value of header_size



96
97
98
 
# File 'lib/steamd/generated/header.rb', line 96

def header_size
  @variables['header_size'][:value]
end

#header_size=(value) ⇒ Object

Sets the header_size variable.

Parameters:

  • value (byte) —

    the new value



103
104
105
 
# File 'lib/steamd/generated/header.rb', line 103

def header_size=(value)
  @variables['header_size'][:value] = value
end

#header_version ⇒ ushort

Note:

defaults to 2

Gets the header_version variable.

Returns:

  • (ushort) —

    the value of header_version



111
112
113
 
# File 'lib/steamd/generated/header.rb', line 111

def header_version
  @variables['header_version'][:value]
end

#header_version=(value) ⇒ Object

Sets the header_version variable.

Parameters:

  • value (ushort) —

    the new value



118
119
120
 
# File 'lib/steamd/generated/header.rb', line 118

def header_version=(value)
  @variables['header_version'][:value] = value
end

#msg ⇒ EMsg

Note:

defaults to EMsg::INVALID

Gets the msg variable.

Returns:

  • (EMsg) —

    the value of msg



81
82
83
 
# File 'lib/steamd/generated/header.rb', line 81

def msg
  @variables['msg'][:value]
end

#msg=(value) ⇒ Object

Sets the msg variable.

Parameters:

  • value (EMsg) —

    the new value



88
89
90
 
# File 'lib/steamd/generated/header.rb', line 88

def msg=(value)
  @variables['msg'][:value] = value
end

#session_id ⇒ int

Note:

defaults to

Gets the session_id variable.

Returns:

  • (int) —

    the value of session_id



186
187
188
 
# File 'lib/steamd/generated/header.rb', line 186

def session_id
  @variables['session_id'][:value]
end

#session_id=(value) ⇒ Object

Sets the session_id variable.

Parameters:

  • value (int) —

    the new value



193
194
195
 
# File 'lib/steamd/generated/header.rb', line 193

def session_id=(value)
  @variables['session_id'][:value] = value
end

#source_job_id ⇒ ulong

Note:

defaults to 18446744073709551615

Gets the source_job_id variable.

Returns:

  • (ulong) —

    the value of source_job_id



141
142
143
 
# File 'lib/steamd/generated/header.rb', line 141

def source_job_id
  @variables['source_job_id'][:value]
end

#source_job_id=(value) ⇒ Object

Sets the source_job_id variable.

Parameters:

  • value (ulong) —

    the new value



148
149
150
 
# File 'lib/steamd/generated/header.rb', line 148

def source_job_id=(value)
  @variables['source_job_id'][:value] = value
end

#steam_id ⇒ ulong

Note:

defaults to

Gets the steam_id variable.

Returns:

  • (ulong) —

    the value of steam_id



171
172
173
 
# File 'lib/steamd/generated/header.rb', line 171

def steam_id
  @variables['steam_id'][:value]
end

#steam_id=(value) ⇒ Object

Sets the steam_id variable.

Parameters:

  • value (ulong) —

    the new value



178
179
180
 
# File 'lib/steamd/generated/header.rb', line 178

def steam_id=(value)
  @variables['steam_id'][:value] = value
end

#target_job_id ⇒ ulong

Note:

defaults to 18446744073709551615

Gets the target_job_id variable.

Returns:

  • (ulong) —

    the value of target_job_id



126
127
128
 
# File 'lib/steamd/generated/header.rb', line 126

def target_job_id
  @variables['target_job_id'][:value]
end

#target_job_id=(value) ⇒ Object

Sets the target_job_id variable.

Parameters:

  • value (ulong) —

    the new value



133
134
135
 
# File 'lib/steamd/generated/header.rb', line 133

def target_job_id=(value)
  @variables['target_job_id'][:value] = value
end